Deployment Overview of Appwrite on Server¶

Prerequisites and Basic Requirements¶

To deploy the application, the following system requirements must be met:

• Operating System: Linux (Debian/Ubuntu based preferred for apt package management).

• Privileges: Root or sudo access is required to install packages and manage Docker.

• Docker Components:

  • docker-compose-plugin must be installed.

• Network Ports:

  • Port 80: HTTP traffic (Internal/External).

  • Port 443: HTTPS traffic (External).

  • Port 8080: Traefik management interface (Localhost only).

FQDN of the final panel on the hostkey.in domain if avalible in format 'Server ID'.hostkey.in:¶

The application uses a dynamic subdomain based on the configured prefix and server ID:

• Format: appwrite<ServerID>.hostkey.in

File and Directory Structure¶

The following directories are used for configuration, data persistence, and certificates:

Application installation process¶

The application is deployed using a docker-compose based deployment method. The core application version used in the primary configuration is appwrite/appwrite:1.9.0.

Deployment involves:

1. Creating the /opt/appwrite directory with permissions set to 0755.

2. Deploying the docker-compose.yml and .env files to the application root.

3. Executing docker compose up -d --remove-orphans within the /opt/appwrite directory.

Access Rights and Security¶

• File Permissions:

  • Configuration files in /opt/appwrite/.env are restricted with mode 0600.

  • The main application directory is set to 0755.

• Network Isolation: Containers communicate via dedicated Docker networks: gateway, appwrite, and runtimes.

• Traefik Security: Traefik is configured to listen on the host loopback interface for management (127.0.0.1:8080) and standard ports for public traffic.

Databases¶

The application utilizes two primary database systems:

The MongoDB instance is initialized as a replica set (rs0) with authentication enabled via a generated keyfile for secure inter-container communication.

Docker Containers and Their Deployment¶

The deployment consists of several functional containers managed via docker compose.

Proxy Servers¶

The system utilizes Traefik as the primary reverse proxy and load balancer.

• SSL/TLS: Traefik handles HTTPS termination using certificates stored in the appwrite-certificates volume.

• Routing Rules:

  • The console is accessible via the /console path prefix.

  • Realtime services are accessible via the /v1/realtime path prefix.

  • All other traffic is routed to the core Appwrite API.

Location of configuration files and data¶

Configuration and persistent data are managed through Docker volumes:

Available ports for connection¶

Starting, Stopping, and Updating¶

Service management is performed using the following commands from within the /opt/appwrite directory:

• Start Services: docker compose up -d

• Stop Services: docker compose down

• Update Configuration: After modifying .env or docker-compose.yml, run docker compose up -d --remove-orphans.