Quick Start

Prerequisites

Python 3.11+
uv (fast Python package manager)

Optional:

Redis (for background tasks with Celery)
PostgreSQL (SQLite works by default)

Local Setup

# Install uv
pip install uv  # or: curl -sSf https://astral.sh/uv/install.sh | bash

# Clone and setup
git clone git@github.com:level09/enferno.git
cd enferno
./setup.sh                # Installs deps + generates secure .env
uv run flask create-db    # Setup database
uv run flask install      # Create admin user
uv run flask run          # Start server

Visit http://localhost:5000 to see your application. Setup requires Python 3.11 or newer. Local setup uses SQLite for data and sessions, with Redis and Celery disabled. Run uv run pytest to check routes, auth, the admin API and migrations.

Adding Background Tasks

For a new installation, ./setup.sh --full installs and configures Redis sessions and Celery at localhost:6379. For an existing installation, preserve .env:

uv sync --extra full      # Adds Redis + Celery
# Set REDIS_URL, CELERY_BROKER_URL in .env

Docker Setup

Configure a new installation, then start the full production stack:

./setup.sh --docker
docker compose up --build

Includes Redis, PostgreSQL, Nginx, and Celery. Docker setup installs the full extras, generates required DB_PASSWORD and REDIS_PASSWORD values, and enables secure cookies for HTTPS. For an existing installation, keep the passwords used by its services. PostgreSQL and Redis do not publish host ports. The Celery health check targets the worker in its own container through Redis.

Environment Configuration

Key variables in .env:

SECRET_KEY=your_secret_key
FLASK_DEBUG=1                    # 0 in production

# PostgreSQL (optional - SQLite works by default)
# SQLALCHEMY_DATABASE_URI=postgresql://user:pass@localhost/dbname

# Background tasks (optional)
# REDIS_URL=redis://localhost:6379/1
# CELERY_BROKER_URL=redis://localhost:6379/2

Next Steps

Authentication - User management and OAuth setup
Deployment - Production deployment guide
Development - Development guidelines and best practices

Getting Started

Core Features

Development

Prerequisites

Local Setup

Adding Background Tasks

Docker Setup

Environment Configuration

Next Steps

​Prerequisites

​Local Setup

​Adding Background Tasks

​Docker Setup

​Environment Configuration

​Next Steps

Prerequisites

Local Setup

Adding Background Tasks

Docker Setup

Environment Configuration

Next Steps