Install with Docker Compose

You can run Mossy with Docker Compose using a single container. This guide covers starting your instance and keeping it up to date.

The example uses server mode, which includes the web interface, API, and MCP endpoint. You can also use a static image for the web interface only. Read Deployment modes to choose a mode before you begin.

Before you begin

You need Docker and the Docker Compose plugin installed on your machine. Docker Desktop includes both. Check that they’re available by running:

docker --version
docker compose version

Start Mossy

Follow these steps in a terminal on the machine where you want to run Mossy.

Create a folder for your installation and open it:
```
mkdir mossy
cd mossy
```
Create a file named compose.yaml with this content:
```
services:
  mossy:
    image: ghcr.io/get-mossy/mossy:latest
    ports:
      - '8080:8080'
    restart: unless-stopped
```
The latest tag follows the newest release. Use a version tag such as 0.1.0 to pin a specific release.

For static mode, set image to ghcr.io/get-mossy/mossy:latest-static, or use a version tag such as 0.1.0-static.
Start Mossy in the background:
```
docker compose up -d
```

Open http://localhost:8080 in a browser on the same machine. If you installed Mossy on a server, replace localhost with the server’s IP address or hostname.

If port 8080 is already in use, change the first number in the port mapping, for example to "3615:8080", and open port http://localhost:3615 instead.

Update Mossy

To update your instance, run these commands from your installation folder. If you’ve pinned a version, update the image tag in compose.yaml first:

docker compose pull
docker compose up -d

Stop Mossy

To stop and remove the container, run this command from your installation folder. Your compose.yaml file stays in place so you can start Mossy again later.

docker compose down