From 0c843fac3d4ccec075f8f74c143b012277d65377 Mon Sep 17 00:00:00 2001 From: doctorjz Date: Thu, 7 Aug 2025 22:19:34 -0700 Subject: [PATCH 1/2] Add files via upload --- docs/synology.md | 127 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 docs/synology.md diff --git a/docs/synology.md b/docs/synology.md new file mode 100644 index 0000000..35a6ed3 --- /dev/null +++ b/docs/synology.md @@ -0,0 +1,127 @@ +# πŸ—ΊοΈ Installing TRIP on Synology NAS Using Docker and Portainer + +This guide explains how to deploy [TRIP](https://github.com/itskovacs/trip) on a Synology NAS using Docker and Portainer. TRIP is a minimalist, privacy-first map and POI tracking app that is fully self-hostable. + +--- + +## 🧰 Prerequisites + +- A Synology NAS with Docker support +- [Docker](https://www.synology.com/en-us/dsm/packages/Docker) installed via Synology Package Center +- [Portainer](https://www.portainer.io/) (Community Edition) installed and running +- Basic familiarity with Synology DSM, Portainer, and local network setup + +--- + +## πŸ“ Step 1: Create a Storage Directory + +Create a folder on your NAS to persist TRIP’s storage: + +```bash +mkdir -p /volume1/docker/trip-storage +``` + +You can also do this via File Station by creating: + +``` +/volume1/docker/trip-storage +``` + +--- + +## πŸš€ Step 2: Deploy TRIP in Portainer + +### βœ… Option A: Docker Compose (Recommended) + +1. Open **Portainer**. +2. Go to **Stacks** β†’ **Add Stack**. +3. Name your stack (e.g., `trip`). +4. Paste the following: + +```yaml +version: '3.9' +services: + trip: + container_name: trip + image: ghcr.io/itskovacs/trip:latest + user: 1000:1000 #change these values to match those of your synology setup PUID:PGID + security_opt: + - no-new-privileges:true + volumes: + - /volume1/docker/trip-storage:/app/storage + restart: on-failure:5 + ports: + - "8080:8000" +``` + +5. Click **Deploy the stack**. + +--- + +### βš™οΈ Option B: Manual Container (Docker Run Equivalent) + +1. In **Portainer**, go to **Containers** β†’ **Add Container**. +2. Fill out the following fields: + +- **Name**: `trip` +- **Image**: `ghcr.io/itskovacs/trip:latest` +- **Port mapping**: `8080` β†’ `8000` +- **Volume mapping**: + - Host: `/volume1/docker/trip-storage` + - Container: `/app/storage` + +3. Click **Deploy the container**. + +--- + +## 🌐 Step 3: Access the App + +Open a browser and go to: + +``` +http://:8080 +``` + +You should see the TRIP web interface. + +--- + +## βš™οΈ Step 4: Add Optional Configuration (e.g., Authentication) + +TRIP supports advanced configuration via a `config.yml` file. To enable it: + +1. Place your `config.yml` inside `/volume1/docker/trip-storage`. +2. The app will detect it automatically on container restart. + +> For authentication, theming, and more, refer to: +> [TRIP Configuration Docs](https://github.com/itskovacs/trip#configuration) + +--- + +## 🧯 Troubleshooting + +- **Can’t access the app?** + - Ensure the NAS IP is correct and port 8080 is not blocked. +- **Data not saving?** + - Confirm that the `/app/storage` volume is mapped properly. +- **Need to upgrade?** + - Edit the image tag in your Docker Compose or Container to the new version and redeploy. + +--- + +## πŸ“Œ Example Quick Reference + +| Item | Value | +|----------------|---------------------------------------| +| App URL | `http://:8080` | +| Docker Image | `ghcr.io/itskovacs/trip:latest` | +| Storage Path | `/volume1/docker/trip-storage` | +| Port Mapping | `8080:8000` | + +--- + +## βœ… Final Notes + +- [TRIP GitHub Repo](https://github.com/itskovacs/trip) +- [Latest Release](https://github.com/itskovacs/trip/releases) +- If using a reverse proxy (e.g., Synology Application Portal or NGINX), map `/` to port `8080`. From 69fd02547f8eb11bdf03477125058370975a5a3b Mon Sep 17 00:00:00 2001 From: Kovacs <36224223+itskovacs@users.noreply.github.com> Date: Fri, 8 Aug 2025 14:39:59 +0000 Subject: [PATCH 2/2] Update synology.md - Use trip:1 instead of trip:latest - Step 4, env var info --- docs/synology.md | 52 +++++++++--------------------------------------- 1 file changed, 9 insertions(+), 43 deletions(-) diff --git a/docs/synology.md b/docs/synology.md index 35a6ed3..f56c5ea 100644 --- a/docs/synology.md +++ b/docs/synology.md @@ -1,8 +1,7 @@ # πŸ—ΊοΈ Installing TRIP on Synology NAS Using Docker and Portainer -This guide explains how to deploy [TRIP](https://github.com/itskovacs/trip) on a Synology NAS using Docker and Portainer. TRIP is a minimalist, privacy-first map and POI tracking app that is fully self-hostable. - ---- +This guide explains how to deploy [TRIP](https://github.com/itskovacs/trip) on a Synology NAS using Docker and Portainer. +TRIP is a minimalist, privacy-first map and POI tracking app that is fully self-hostable. ## 🧰 Prerequisites @@ -11,7 +10,6 @@ This guide explains how to deploy [TRIP](https://github.com/itskovacs/trip) on a - [Portainer](https://www.portainer.io/) (Community Edition) installed and running - Basic familiarity with Synology DSM, Portainer, and local network setup ---- ## πŸ“ Step 1: Create a Storage Directory @@ -27,7 +25,6 @@ You can also do this via File Station by creating: /volume1/docker/trip-storage ``` ---- ## πŸš€ Step 2: Deploy TRIP in Portainer @@ -43,7 +40,7 @@ version: '3.9' services: trip: container_name: trip - image: ghcr.io/itskovacs/trip:latest + image: ghcr.io/itskovacs/trip:1 user: 1000:1000 #change these values to match those of your synology setup PUID:PGID security_opt: - no-new-privileges:true @@ -56,7 +53,6 @@ services: 5. Click **Deploy the stack**. ---- ### βš™οΈ Option B: Manual Container (Docker Run Equivalent) @@ -64,7 +60,7 @@ services: 2. Fill out the following fields: - **Name**: `trip` -- **Image**: `ghcr.io/itskovacs/trip:latest` +- **Image**: `ghcr.io/itskovacs/trip:1` - **Port mapping**: `8080` β†’ `8000` - **Volume mapping**: - Host: `/volume1/docker/trip-storage` @@ -72,7 +68,6 @@ services: 3. Click **Deploy the container**. ---- ## 🌐 Step 3: Access the App @@ -84,44 +79,15 @@ http://:8080 You should see the TRIP web interface. ---- ## βš™οΈ Step 4: Add Optional Configuration (e.g., Authentication) -TRIP supports advanced configuration via a `config.yml` file. To enable it: - -1. Place your `config.yml` inside `/volume1/docker/trip-storage`. -2. The app will detect it automatically on container restart. - > For authentication, theming, and more, refer to: > [TRIP Configuration Docs](https://github.com/itskovacs/trip#configuration) ---- +TRIP supports advanced configuration via a `config.yml` file or using `environment variables`. -## 🧯 Troubleshooting - -- **Can’t access the app?** - - Ensure the NAS IP is correct and port 8080 is not blocked. -- **Data not saving?** - - Confirm that the `/app/storage` volume is mapped properly. -- **Need to upgrade?** - - Edit the image tag in your Docker Compose or Container to the new version and redeploy. - ---- - -## πŸ“Œ Example Quick Reference - -| Item | Value | -|----------------|---------------------------------------| -| App URL | `http://:8080` | -| Docker Image | `ghcr.io/itskovacs/trip:latest` | -| Storage Path | `/volume1/docker/trip-storage` | -| Port Mapping | `8080:8000` | - ---- - -## βœ… Final Notes - -- [TRIP GitHub Repo](https://github.com/itskovacs/trip) -- [Latest Release](https://github.com/itskovacs/trip/releases) -- If using a reverse proxy (e.g., Synology Application Portal or NGINX), map `/` to port `8080`. +1. Modify configuration, two options: + * Modify (or create) your `config.yml` inside `/volume1/docker/trip-storage`, + * Modify the environment variables of your container +2. Restart container