diff --git a/.dockerignore b/.dockerignore index 497f243..340c59a 100644 --- a/.dockerignore +++ b/.dockerignore @@ -5,5 +5,7 @@ data .env .env.* !.env.example +compose.override.yaml +compose.override.yml coverage *.log diff --git a/.env.example b/.env.example index 47c2977..f641ba3 100644 --- a/.env.example +++ b/.env.example @@ -1,6 +1,7 @@ PORT=3000 DB_PATH=./data/events.sqlite ADMIN_TOKEN= +PROXY_NETWORK=reverse-proxy # Apprise API service apprise_host=apprise diff --git a/.gitignore b/.gitignore index 480d6b7..5b4f1bf 100644 --- a/.gitignore +++ b/.gitignore @@ -6,5 +6,7 @@ data/*.sqlite-wal .env .env.* !.env.example +compose.override.yaml +compose.override.yml coverage/ *.log diff --git a/README.md b/README.md index 5432a60..591cc3d 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,14 @@ Copy-Item .env.example .env docker compose up -d --build ``` +To attach the calendar app to an existing reverse-proxy Docker network, copy `compose.override.yaml.example` to `compose.override.yaml` on the server and set `PROXY_NETWORK` in `.env` to that network’s name. Compose automatically merges the local override file. The network must already exist; Apprise stays on the private Compose network while the calendar app joins both networks. + +```powershell +Copy-Item compose.override.yaml.example compose.override.yaml +# Set PROXY_NETWORK in .env to your existing network's name. +docker compose up -d --build +``` + The calendar service listens on port `3000`; set `HOST_PORT` in the shell or Compose `.env` file to change the host port. Apprise listens on the private Compose network at `apprise:8000` and is not published directly to the internet. SQLite data is stored in the persistent `event-data` Docker volume. Follow both services with `docker compose logs -f`, stop them with `docker compose down`, and remove the database volume only when you intend to delete the stored events and notification history (`docker compose down -v`). To build and run without Compose: diff --git a/compose.override.yaml.example b/compose.override.yaml.example new file mode 100644 index 0000000..6f062ec --- /dev/null +++ b/compose.override.yaml.example @@ -0,0 +1,10 @@ +services: + 77thevcalntfysrv: + networks: + - default + - reverse-proxy + +networks: + reverse-proxy: + external: true + name: ${PROXY_NETWORK:-reverse-proxy} diff --git a/compose.yaml b/compose.yaml index a75004f..7db5561 100644 --- a/compose.yaml +++ b/compose.yaml @@ -29,7 +29,8 @@ services: apprise_port: 8000 apprise_https: "false" depends_on: - - apprise + apprise: + condition: service_healthy links: - apprise # ports: