Home

Awesome

<br/> <h3 align="center"> <img src="https://github.com/simonwep/openvpn-pihole/assets/30767528/a965ecf1-696e-46ea-85ad-87ce4bdb8791" alt="Logo" width="350"> </h3> <br/> <div align="center"> <h3>Ocular on Docker</h3> <h4>A ready-to-deploy docker compose setup for <a href="https://github.com/simonwep/ocular">ocular</a></h4> </div> <br/>

Quick start

To download the latest release and start it via docker-compose, run:

bash <(curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/simonwep/ocular-docker/refs/heads/main/setup.sh)

[!NOTE] This will perform the same steps as described in the manual setup section and ask you questions if needed. You can always take a look at the script before running it, or perform these steps manually.

Manual setup and migration

First time setup

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.

Admin controls

You can use genesis's CLI to manage users. For example, to change a user's password:

docker run --rm -v "$(pwd)/data:/app/.data" --env-file .env ghcr.io/simonwep/genesis:latest users update --password {new password} {username}

For help run:

docker run --rm -v "$(pwd)/data:/app/.data" --env-file .env ghcr.io/simonwep/genesis:latest help

FAQ

Head over to the FAQs for more information.