francescoalbano/tripweb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update synology.md

Browse Source 
- Use trip:1 instead of trip:latest
- Step 4, env var info
This commit is contained in:
Kovacs 2025-08-08 14:39:59 +00:00 committed by GitHub
parent 0c843fac3d
commit 69fd02547f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/synology.md
View File

@ -1,8 +1,7 @@
# 🗺️ Installing TRIP on Synology NAS Using Docker and Portainer # 🗺️ 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 ## 🧰 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 - [Portainer](https://www.portainer.io/) (Community Edition) installed and running
- Basic familiarity with Synology DSM, Portainer, and local network setup - Basic familiarity with Synology DSM, Portainer, and local network setup
---
## 📁 Step 1: Create a Storage Directory ## 📁 Step 1: Create a Storage Directory
@ -27,7 +25,6 @@ You can also do this via File Station by creating:
/volume1/docker/trip-storage /volume1/docker/trip-storage
``` ```
---
## 🚀 Step 2: Deploy TRIP in Portainer ## 🚀 Step 2: Deploy TRIP in Portainer
@ -43,7 +40,7 @@ version: '3.9'
services: services:
trip: trip:
container_name: 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 user: 1000:1000 #change these values to match those of your synology setup PUID:PGID
security_opt: security_opt:
- no-new-privileges:true - no-new-privileges:true
@ -56,7 +53,6 @@ services:
5. Click **Deploy the stack**. 5. Click **Deploy the stack**.
---
### ⚙️ Option B: Manual Container (Docker Run Equivalent) ### ⚙️ Option B: Manual Container (Docker Run Equivalent)
@ -64,7 +60,7 @@ services:
2. Fill out the following fields: 2. Fill out the following fields:
- **Name**: `trip` - **Name**: `trip`
- **Image**: `ghcr.io/itskovacs/trip:latest` - **Image**: `ghcr.io/itskovacs/trip:1`
- **Port mapping**: `8080` → `8000` - **Port mapping**: `8080` → `8000`
- **Volume mapping**: - **Volume mapping**:
- Host: `/volume1/docker/trip-storage` - Host: `/volume1/docker/trip-storage`
@ -72,7 +68,6 @@ services:
3. Click **Deploy the container**. 3. Click **Deploy the container**.
---
## 🌐 Step 3: Access the App ## 🌐 Step 3: Access the App
@ -84,44 +79,15 @@ http://<YOUR_NAS_IP>:8080
You should see the TRIP web interface. You should see the TRIP web interface.
---
## ⚙️ Step 4: Add Optional Configuration (e.g., Authentication) ## ⚙️ 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: > For authentication, theming, and more, refer to:
> [TRIP Configuration Docs](https://github.com/itskovacs/trip#configuration) > [TRIP Configuration Docs](https://github.com/itskovacs/trip#configuration)
--- TRIP supports advanced configuration via a `config.yml` file or using `environment variables`.
## 🧯 Troubleshooting 1. Modify configuration, two options:
* Modify (or create) your `config.yml` inside `/volume1/docker/trip-storage`,
- **Can’t access the app?** * Modify the environment variables of your container
- Ensure the NAS IP is correct and port 8080 is not blocked. 2. Restart container
- **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://<NAS-IP>: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`.