diff --git a/nx-webmail/README.md b/nx-webmail/README.md index bec2c80..c54248c 100644 --- a/nx-webmail/README.md +++ b/nx-webmail/README.md @@ -1,4 +1,4 @@ -# Standalone Webmail (Docker-ready) +# Standalone Webmail (Docker-ready) ## Local setup @@ -22,17 +22,26 @@ This repository is prepared for Umbrel app-store usage. -1. Put this project into your app folder (folder name must match `id` in `umbrel-app.yml`, currently `nx-webmail`). +1. Keep this app in a folder named exactly like the app ID: `nx-webmail`. 2. Keep these files in that folder: - `docker-compose.yml` - `umbrel-app.yml` - `Dockerfile` -3. Add the app folder to your Umbrel community app store repo and push. + - `exports.sh` +3. Ensure your store root contains `umbrel-app-store.yml`. +4. Push the app-store repo to a git host reachable from Umbrel. + +## Install from Umbrel UI + +1. Open App Store in Umbrel. +2. Use the menu to add a Community App Store. +3. Paste your repository URL. +4. Open your store and install `Webmail`. Notes: - Umbrel uses the `app_proxy` service in `docker-compose.yml`. - Internal app port is `3001`. -- If your store prefix is not `nx`, change `id` in `umbrel-app.yml` and update `APP_HOST` accordingly. +- If your store prefix changes, update `id` in `umbrel-app.yml` and `APP_HOST` in `docker-compose.yml`. ## Notes diff --git a/nx-webmail/docker-compose.yml b/nx-webmail/docker-compose.yml index e6c917a..7fcf3a0 100644 --- a/nx-webmail/docker-compose.yml +++ b/nx-webmail/docker-compose.yml @@ -1,4 +1,4 @@ -version: "3.7" +version: "3.7" services: app_proxy: @@ -7,10 +7,13 @@ services: APP_PORT: 3001 server: - build: . + build: + context: . + dockerfile: Dockerfile image: nx-webmail:1.0.0 init: true restart: on-failure + stop_grace_period: 1m environment: NODE_ENV: production PORT: 3001 diff --git a/nx-webmail/exports.sh b/nx-webmail/exports.sh new file mode 100644 index 0000000..74e2aca --- /dev/null +++ b/nx-webmail/exports.sh @@ -0,0 +1,2 @@ +#!/usr/bin/env bash +# No dynamic env exports are required for this app.