Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.safaridesk.io/llms.txt

Use this file to discover all available pages before exploring further.

​
SafariDesk Open Source Guide

Choose the path that matches where you are right now. Start with Installation if you’re setting up SafariDesk for the first time, or jump to Configuration and Operations when you are already running a stack.

Quick start

Follow the shortest path to a working deployment, then come back here for configuration, architecture, and maintenance.

What you'll need

Docker, Docker Compose, a host with at least 4 GB RAM, and access to your .env file.

What you'll learn

How the stack is assembled, how licensing works, and how to keep the deployment healthy over time.

Installation

Set up Docker Compose, prepare your environment file, and start the full stack.

Configuration

Review the required environment variables, URLs, email settings, and optional AI values.

Architecture

Understand the deployment model, storage layout, and licensing flow.

Troubleshooting

Work through the most common startup and runtime issues.

​
What this deploys

The self-hosted stack includes:
  • Frontend served by Nginx
  • Django API
  • Celery worker and scheduler
  • PostgreSQL with pgvector
  • Redis for cache and broker traffic

​
Before you start

  • Install Docker and Docker Compose on the target host
  • Give the host at least 4 GB RAM for a small deployment
  • Use a domain or local DNS record if you plan to expose the service publicly
  • Run commands from the Core/ folder