Installation & Setup¶

Get FilaOps running on your computer in about 15 minutes.

What You'll Learn¶

• How to install the required software
• How to set up the database
• How to configure and start FilaOps
• How to verify everything is working

Prerequisites¶

You need the following software installed before you begin:

Download links:

• Python: python.org/downloads
• Node.js: nodejs.org
• PostgreSQL: postgresql.org/download
• Git: git-scm.com/downloads

Step 1: Download FilaOps¶

Open a terminal and clone the repository:

git clone https://github.com/Blb3D/filaops.git
cd filaops

Step 2: Create the Database¶

Connect to PostgreSQL and create a new database:

psql -U postgres

CREATE DATABASE filaops;
\q

Step 3: Configure the Backend¶

Create your environment file:

cd backend

Create a file named .env in the backend/ directory with the following contents:

# Database — change the password to match your PostgreSQL setup
DATABASE_URL=postgresql+psycopg://postgres:your_password@localhost:5432/filaops

# Security — generate a unique key for your installation
SECRET_KEY=change-this-to-a-random-string
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=43200

# Environment
ENVIRONMENT=development

# Frontend URL (for CORS)
CORS_ORIGINS=http://localhost:5173,http://localhost:3000

openssl rand -hex 32

python -c "import secrets; print(secrets.token_hex(32))"

Important: Replace your_password with your actual PostgreSQL password.

Step 4: Install Backend Dependencies¶

# Make sure you're in the backend/ directory
cd backend

# Create a Python virtual environment
python -m venv venv

# Activate it
# On Windows:
.\venv\Scripts\Activate
# On Linux/Mac:
source venv/bin/activate

# Install Python packages
pip install -r requirements.txt

# Set up the database tables
alembic upgrade head

You should see a series of migration messages. The last line will look like:

INFO  [alembic.runtime.migration] Running upgrade ... -> ..., [migration name]

Step 5: Install Frontend Dependencies¶

Open a second terminal window (keep the backend terminal open):

cd frontend
npm install

Step 6: Start FilaOps¶

You need two terminal windows running at the same time.

Terminal 1 — Backend:

cd backend
.\venv\Scripts\Activate    # Windows
# source venv/bin/activate  # Linux/Mac
uvicorn app.main:app --reload

You should see:

INFO:     Uvicorn running on http://127.0.0.1:8000
INFO:     Application startup complete.

Terminal 2 — Frontend:

cd frontend
npm run dev

You should see:

VITE v5.x.x  ready in xxx ms

  ➜  Local:   http://localhost:5173/

Step 7: Verify It Works¶

Open your browser and go to http://localhost:5173. You should see the FilaOps setup screen.

Verification checklist:

• [ ] Backend responds at http://127.0.0.1:8000 (shows "FilaOps API is running")
• [ ] Frontend loads at http://localhost:5173
• [ ] No database connection errors in the backend terminal
• [ ] The setup wizard appears (if this is a fresh installation)

If all four checks pass, FilaOps is installed and ready to use.

Docker Alternative¶

If you prefer Docker, you can run FilaOps with Docker Compose:

git clone https://github.com/Blb3D/filaops.git
cd filaops
cp backend/.env.example .env    # Edit with your settings
docker compose up -d

Open http://localhost to access FilaOps.

For full Docker deployment details, see the Deployment Guide.

Development vs. Production¶

This guide covers development setup — running FilaOps locally for testing or small-scale use. For a production deployment with HTTPS, proper backups, and reverse proxy, see the Deployment Guide.

What's Next?¶

Now that FilaOps is running, head to Your First Day to create your admin account, load sample data, and take a tour of the system.

Quick Reference¶