Installation

Pelagica is distributed as a Docker image and provides a production-ready setup with an nginx web server out of the box. Docker Compose is the recommended way to run it, but a plain docker run command works just as well.

Quick start

1. Create a directory for Pelagica:

   mkdir -p pelagica && cd pelagica

2. Run the container:

   docker run -d \
       --name pelagica \
       -p 8080:80 \
       -v "$(pwd)/config:/config" \
       --restart unless-stopped \
       kartoffelchipss/pelagica:latest

   TIP

   Replace $(pwd)/config with the actual path where your config files should be stored, e.g. /mnt/user/appdata/pelagica.

3. Open your browser to http://localhost:8080 to finish setup.

Docker Compose

If you prefer docker compose, create a docker-compose.yml file:

services:
    pelagica:
        image: kartoffelchipss/pelagica:latest
        container_name: pelagica
        ports:
            - '8080:80'
        volumes:
            - ./config:/config
        restart: unless-stopped

Replace ./config with a persistent path on the host to store your settings, then start it:

docker compose up -d

Container management

# View logs
docker logs -f pelagica

# Stop the container
docker stop pelagica

# Start the container
docker start pelagica

Updating

docker pull kartoffelchipss/pelagica:latest
docker stop pelagica
docker rm pelagica
# Then run the docker run command again from Quick start

With Docker Compose, updating is simpler:

docker compose pull
docker compose up -d

Your configuration in /config is preserved across updates either way.

Building from source

If you want to build the Docker image from source instead of using the prebuilt image:

git clone https://github.com/PelagicaApp/pelagica.git
cd pelagica

docker compose up -d --build