Ocular on Docker

A ready-to-deploy docker compose setup for ocular

Note

For release notes, check out the latest release in the ocular repository. This repo is just for production releases :)

First time setup

Caution

It is currently not possible to reset the password in case you forget yours! Follow simonwep/genesis#5 to get notified when this is added. (simonwep/ocular#51)

This is the docker-compose setup for ocular. To deploy it, follow these steps:

1. Download the latest release and extract it. Do not clone this repository!
2. Copy the .env.example to .env, if your app is only used locally make sure to set GENESIS_JWT_COOKIE_ALLOW_HTTP to true if you want to use it without https.
3. Run ./gen-passwords.sh to generate secrets and an initial admin user.
4. Run docker compose up -d.
5. Ocular should be accessible under http://localhost:3030 in your browser :)

Migrating to a new version

To migrate to a newer version, follow these steps:

1. Backup the ./data folder. The folder contains all the user-data.
2. Download the latest release and extract it.
3. Copy the .env.example to .env, adjust the values if needed. You don't need to run ./gen-passwords.sh again.
4. Copy your old ./data folder to the new location.
5. Run docker compose up -d.

FAQ

Help! I can't log in to the app over the network!

If you don't use https, make sure to set GENESIS_JWT_COOKIE_ALLOW_HTTP to true in your .env file. Otherwise, run it behind a reverse proxy like nginx and get a free certificate from letsencrypt.