Skip to content

Installation Overview

The application is containerized using Docker. Deployment follows a layered approach: the Core Application (Step 1) is required for everyone, while the Server Layer (Step 2) is an optional add-on for public hosting.

Architecture & Installation Path

You generally only need to decide if you are testing locally or deploying to a server.

graph TD
    %% Core Nodes
    Start([Start]) --> Core["<b>Step 1: Core Application</b><br>Docker Compose Stack"]
    Core --> Local{Deployment Target?}

    %% Path 1: Local
    Local -->|Local / Dev| FinishLocal(["<b>Ready!</b><br>localhost:3000<br>No Auth"])

    %% Path 2: Server
    Local -->|Public Server| Server[<b>Step 2: Server Layer</b><br>Nginx Proxy]
    Server --> FinishServer(["<b>Ready!</b><br>https://your-domain.com<br>SSL + Auth"])

    %% Styling
    classDef core fill:#e3f2fd,stroke:#1565c0,stroke-width:2px
    classDef server fill:#fff3e0,stroke:#e65100,stroke-width:2px
    classDef finish fill:#c8e6c9,stroke:#2e7d32,stroke-width:2px

    class Core core
    class Server server
    class FinishLocal,FinishServer finish

1. Core Application (Required)

For: Development, Testing, Local Use.

This sets up the full application stack (Frontend, Backend, Database, Search, S3).

  • Access: http://localhost:3000
  • Auth: None (Open access)
  • Time: ~15 minutes

Start Core Installation

2. Server Layer (Optional)

For: Public hosting, Sharing with users.

Adds a security layer on top of the Core Application. You must complete Step 1 first.

  • Adds: Nginx, SSL/TLS (HTTPS), Basic Authentication.
  • Access: https://your-domain.com
  • Time: +20 minutes

Configure Server Layer

Technical Comparison

Feature Local (Step 1 only) Server (Step 1 + 2)
URL localhost:3000 https://your-domain.com
Security None (HTTP) SSL/TLS (HTTPS)
Auth Open Access Role-based (Editor/Reader)
Use Case Development Production / Sharing

Prerequisites

Ensure you have these installed before starting:

For Server Deployment

You will also need a domain name (DNS configured) and SSL certificates ready.

Stack Components

The application is composed of the following services:

Service Technology Role
Frontend SvelteKit User Interface
Backend FastAPI REST API
Job Queue Redis Managing Async Workers
Data MongoDB Document Storage
Search Apache Solr Full-text indexing
Storage Garage (S3) Media & File storage
Proxy Nginx Security & Routing (Server only)

```