Skip to main content

From source

Most people run the published images, as Installation shows. If you're developing OtoDock, clone the repository and use the source flow.

Containerised, built from source​

It needs only Git and Docker, because everything builds inside the containers:

git clone https://github.com/OtoDock/oto-dock.git
cd oto-dock
printf 'POSTGRES_PASSWORD=%s\n' "$(openssl rand -hex 24)" > config.env
scripts/compose.sh up -d --build

It builds exactly what your working tree contains, so updating is just git pull and re-running the same command. The source flow keeps its settings in config.env at the repository root, with the same contents as .env on a Docker install.

Native (bare-metal development)​

The server can also run directly on the host. One bootstrap script stands up the whole environment:

git clone https://github.com/OtoDock/oto-dock.git
cd oto-dock
scripts/dev-setup.sh

Then run it in the foreground while you work on the code:

cd proxy && venv/bin/python app.py # the server (serves the built dashboard too)
cd dashboard && npm run dev # optional second terminal: hot-reload dashboard

If the box doubles as a long-running instance, register it as a systemd service instead:

scripts/dev-setup.sh --service

Next steps​