Installation_

This guide will walk you through installing Appwrite on your server using Docker. Appwrite is designed to run on any operating system that supports Docker.

System requirements

Before installing Appwrite, ensure your system meets these minimum requirements:

• 2 CPU cores
• 4GB of RAM
• 2GB of swap memory
• Operating system that supports Docker
• Docker Compose Version 2

Install with Docker

The easiest way to install Appwrite is using our Docker installer. The installer launches a web-based setup wizard that guides you through the entire process.

Before running the installation command, ensure you have Docker CLI installed on your host machine.

Installation commands

Once the command is running, open your browser and navigate to http://localhost:20080 to access the setup wizard.

Setup wizard

The setup wizard walks you through four steps to configure your Appwrite instance.

Step 1: Setup your app

Configure your Appwrite instance's basic settings.

• Hostname - The domain or IP address where your Appwrite instance will be accessible.
• Database - Choose between MongoDB or MariaDB as your database backend. MongoDB is selected by default.
• Advanced settings - Optionally configure HTTP and HTTPS ports, SSL certificate email, and an OpenAI API key for the Appwrite Assistant.

Step 2: Secure your app

A secret API key is automatically generated for your instance. This key is used to encrypt sensitive data.

You can use the Copy button to copy the key or Regenerate to create a new one.

Step 3: Create your account

Set up the email and password for your Appwrite account. You'll use these credentials to sign in to the Appwrite Console after installation.

Step 4: Review your setup

Review all your configuration settings. If anything looks wrong, use the Back button to make changes. When you're ready, click Install to begin the installation.

Manual installation

For advanced users who prefer manual setup, you can install Appwrite using Docker Compose directly.

Generate configuration files

Install Appwrite

1. Create a directory named appwrite and place both docker-compose.yml and .env inside
2. Edit the .env file to customize your installation. At minimum, update _APP_OPENSSL_KEY_V1 and _APP_EXECUTOR_SECRET with unique secret values
3. Start the Appwrite stack:

docker compose up -d --remove-orphans

Post-installation

After installation completes:

1. Access the Console - Navigate to your machine's hostname or IP address in your browser
2. Create your first project - Set up your development environment

SDK version compatibility

The tables below map each released self-hosted Appwrite version to the SDK versions that were current at the time of that release. Use this to pin your SDK to a version known to work with your server. The latest stable self-hosted Appwrite release is 1.9.0.

Client SDKs

Server SDKs

Managing your installation

Stop Appwrite

To stop your Appwrite containers:

docker compose stop

Restart Appwrite

To restart your Appwrite containers:

docker compose start

Uninstall Appwrite

To completely remove Appwrite and all its data:

docker compose down -v

Next steps

After successfully installing Appwrite, you can:

Deploy on cloud platforms - Learn how to deploy on AWS, DigitalOcean, and other cloud providers

Configure services - Set up email, SMS, storage, and other services

Configure databases - Learn more about MongoDB and MariaDB configuration

Production setup - Prepare your installation for production use

Update Appwrite - Keep your installation up to date