Quick Start

This guide walks you trough setting up Invio on your machine, this guide uses docker compose. You might want to check the list of other deployment guides if you are looking for other means of deploying. This guide will use the combined invio image, if you for some reason want frontend and backend separate refer to Deployment

1) Create a folder and add these two files

Create a folder with the compose file and a .env file.

docker-compose.yml

name: invio

services:
  invio:
    image: ghcr.io/kittendevv/invio:latest
    env_file:
      - .env
    volumes:
      - invio_data:/app/data
    ports:
      - "8000:8000"
    restart: unless-stopped

volumes:
  invio_data:
    driver: local

.env (you can copy/paste and adjust) (there are more options you can configure see full .env.examle for all options)

# ─── Required ─────────────────────────────────────────────
ADMIN_USER=admin
ADMIN_PASS=supersecret
JWT_SECRET=change-me-in-production

# SvelteKit CSRF protection: the external origin where your frontend is served.
# For local Docker: http://localhost:8000
# For production:    https://yourdomain.com (can also be an ip + port)
ORIGIN=https://yourdomain.com

# ─── Database ─────────────────────────────────────────────
# Docker (default):     /app/data/invio.db
# Local development:    ./invio.db
DATABASE_PATH=/app/data/invio.db

# ─── Networking ───────────────────────────────────────────
BACKEND_PORT=3000
FRONTEND_PORT=8000

BACKEND_URL=http://localhost:3000

2) Start Invio

After completing step one you can just start the container.

docker compose up -d

Once started, visit your-ip:frontend-port and logging in with your username and password, since you already set up your account in your enviroment file you don't need to sign up.

Updating to the latest version

docker compose pull
docker compose up -d

Troubleshooting

• Have a look at open issues, if your issue is not listed there please open an issue.