System Requirements
Minimum
- Python 3.10+
- 2 CPU cores
- 4GB RAM
- 10GB disk space
Recommended
- Python 3.11+
- 4 CPU cores
- 8GB RAM
- 20GB disk space
Installation Methods
Choose the installation method that best fits your use case:- Local Development
- Docker
- Kubernetes
- uv Install
Best for: Development, testing, learningOr use the Makefile:
Step-by-Step Installation
1
Install Python
Ensure Python 3.11 or higher is installed:If not installed:
- macOS:
brew install python@3.11 - Ubuntu:
sudo apt install python3.11 - Windows: Download from python.org
2
Install Docker
Required for OpenFGA, Jaeger, and other infrastructure:
- macOS: Docker Desktop
- Ubuntu: Docker Engine
- Windows: Docker Desktop
3
Clone Repository
4
Install uv Package Manager
Install uv (recommended for fast dependency management):
5
Install Dependencies
No manual venv creation needed!
uv sync automatically:- Creates
.venvif it doesn’t exist - Installs all dependencies from
pyproject.toml - Uses
uv.lockfor reproducible builds
Post-Installation Setup
1. Start Infrastructure Services
Verify services are running:All services should show “Up” status.
2. Setup OpenFGA
Initialize the authorization system:OPENFGA_STORE_IDOPENFGA_MODEL_ID
3. Configure Environment
Create.env from the example:
.env with your values:
4. Add OpenFGA IDs
Add to.env:
5. Test Installation
Verification
Run the full test suite to verify everything is working:Optional: Development Tools
Install additional tools for development:Platform-Specific Notes
macOS
macOS
Ubuntu/Debian
Ubuntu/Debian
Ubuntu Installation
Windows
Windows
Windows Installation
-
Install Python:
- Download from python.org
- Check “Add Python to PATH” during installation
-
Install Docker Desktop:
- Download from docker.com
- Enable WSL 2 backend
-
Install Git:
- Download from git-scm.com
- Use Git Bash for commands
- Use PowerShell or Git Bash for terminal commands
ARM64 (Apple Silicon, Graviton)
ARM64 (Apple Silicon, Graviton)
Troubleshooting
Dependency installation fails
Dependency installation fails
Problem: Dependencies fail to installSolution:
Docker not found
Docker not found
Problem:
docker: command not foundSolution:- Ensure Docker Desktop is running (macOS/Windows)
- Add Docker to PATH (Linux:
sudo usermod -aG docker $USER) - Restart terminal
Permission denied
Permission denied
Problem: Permission errors when running DockerSolution:
Port already in use
Port already in use
Problem: Address already in useSolution: