{"id":15413360,"url":"https://github.com/simonwep/ocular-docker","last_synced_at":"2025-04-19T04:15:08.409Z","repository":{"id":205653803,"uuid":"673418507","full_name":"simonwep/ocular-docker","owner":"simonwep","description":"Ready-to-use docker compose setup for ocular ✨","archived":false,"fork":false,"pushed_at":"2025-03-28T16:58:26.000Z","size":20,"stargazers_count":16,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-16T03:55:39.605Z","etag":null,"topics":["budget","budgeting","docker-compose","self-hosted"],"latest_commit_sha":null,"homepage":"https://github.com/simonwep/ocular","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simonwep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-08-01T15:20:12.000Z","updated_at":"2025-04-07T13:19:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"3af0c8ca-082b-415b-9562-a1538c2a4312","html_url":"https://github.com/simonwep/ocular-docker","commit_stats":{"total_commits":20,"total_committers":1,"mean_commits":20.0,"dds":0.0,"last_synced_commit":"9b02aad119acb408bb06eee2349a31a0f949ad1c"},"previous_names":["simonwep/ocular-docker"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonwep%2Focular-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonwep%2Focular-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonwep%2Focular-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simonwep%2Focular-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simonwep","download_url":"https://codeload.github.com/simonwep/ocular-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249604094,"owners_count":21298420,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["budget","budgeting","docker-compose","self-hosted"],"created_at":"2024-10-01T16:56:45.255Z","updated_at":"2025-04-19T04:15:08.392Z","avatar_url":"https://github.com/simonwep.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cbr/\u003e\n\n\u003ch3 align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/simonwep/openvpn-pihole/assets/30767528/a965ecf1-696e-46ea-85ad-87ce4bdb8791\" alt=\"Logo\" width=\"350\"\u003e\n\u003c/h3\u003e\n\n\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch3\u003eOcular on Docker\u003c/h3\u003e\n  \u003ch4\u003eA ready-to-deploy docker compose setup for \u003ca href=\"https://github.com/simonwep/ocular\"\u003eocular\u003c/a\u003e\u003c/h4\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\n## Quick start\n\nTo download the latest release and start it via docker-compose, run:\n\n```sh\nbash \u003c(curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/simonwep/ocular-docker/refs/heads/main/setup.sh)\n```\n\n\u003e [!NOTE]\n\u003e This will perform the same steps as described in the [manual setup](#manual-setup) section and ask you questions if needed.\n\u003e You can always [take a look at the script](setup.sh) before running it, or perform [these steps manually](#manual-setup).\n\n## Manual setup\n\nThis is the docker-compose setup for [ocular](https://github.com/simonwep/ocular).\nTo deploy it, follow these steps:\n\n1. Download the [latest release](https://github.com/simonwep/ocular-docker/releases/latest) and extract it. Do not clone this repository!\n2. 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, for example in an isolated network.\n3. Run `./gen-passwords.sh` to generate secrets and an initial admin user.\n4. Run `docker compose up -d`.\n5. Ocular should be accessible under `http://localhost:3030` in your browser :)\n\n## Migrating to a new version\n\n\u003e [!NOTE]\n\u003e Usually it's sufficient to just bump the version inside the `docker-compose.yml` file.\n\u003e However, sometimes new versions require new `.env`-variables or changes in the [config](config) folder.\n\u003e This guide is to be 100%-sure that everything works as expected - but it's not always necessary.\n\nTo migrate to a newer version, follow these steps:\n\n1. Stop all containers with `docker compose down`.\n2. Backup the `./data` folder and your `.env` file.\n3. Download the [latest release](https://github.com/simonwep/ocular-docker/releases/latest) and extract it.\n4. Copy your old `./data` folder and `.env` to the new directory, compare the `.env.example` with your `.env` and copy default values if needed.\n5. Run `docker compose up -d`.\n\n## Admin controls\n\nYou can use [genesis's CLI](https://github.com/simonwep/genesis?tab=readme-ov-file#cli) to manage users.\nFor example, to change a user's password:\n\n```sh\ndocker run --rm -v \"$(pwd)/data:/app/.data\" --env-file .env ghcr.io/simonwep/genesis:latest users update --password {new password} {username}\n```\n\nFor help run:\n```sh\ndocker run --rm -v \"$(pwd)/data:/app/.data\" --env-file .env ghcr.io/simonwep/genesis:latest help\n```\n\n## FAQ\n\nHead over to the [FAQs](FAQs.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonwep%2Focular-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimonwep%2Focular-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimonwep%2Focular-docker/lists"}