docs: rebrand README, SECURITY.md, docker-compose.yml to TREK

This commit is contained in:
Maurice
2026-03-28 16:41:06 +01:00
parent e78c2a97bd
commit ee54d89144
3 changed files with 19 additions and 19 deletions
+16 -16
View File
@@ -2,10 +2,10 @@
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="client/public/logo-light.svg" /> <source media="(prefers-color-scheme: dark)" srcset="client/public/logo-light.svg" />
<source media="(prefers-color-scheme: light)" srcset="client/public/logo-dark.svg" /> <source media="(prefers-color-scheme: light)" srcset="client/public/logo-dark.svg" />
<img src="client/public/logo-light.svg" alt="NOMAD" height="60" /> <img src="client/public/logo-light.svg" alt="TREK" height="60" />
</picture> </picture>
<br /> <br />
<em>Navigation Organizer for Maps, Activities & Destinations</em> <em>Your Trips. Your Plan.</em>
</p> </p>
<p align="center"> <p align="center">
@@ -18,10 +18,10 @@
<p align="center"> <p align="center">
A self-hosted, real-time collaborative travel planner with interactive maps, budgets, packing lists, and more. A self-hosted, real-time collaborative travel planner with interactive maps, budgets, packing lists, and more.
<br /> <br />
<strong><a href="https://demo-nomad.pakulat.org">Live Demo</a></strong> — Try NOMAD without installing. Resets hourly. <strong><a href="https://demo-nomad.pakulat.org">Live Demo</a></strong> — Try TREK without installing. Resets hourly.
</p> </p>
![NOMAD Screenshot](docs/screenshot.png) ![TREK Screenshot](docs/screenshot.png)
![NOMAD Screenshot 2](docs/screenshot-2.png) ![NOMAD Screenshot 2](docs/screenshot-2.png)
<details> <details>
@@ -50,7 +50,7 @@
- **Budget Tracking** — Category-based expenses with pie chart, per-person/per-day splitting, and multi-currency support - **Budget Tracking** — Category-based expenses with pie chart, per-person/per-day splitting, and multi-currency support
- **Packing Lists** — Categorized checklists with progress tracking, color coding, and smart suggestions - **Packing Lists** — Categorized checklists with progress tracking, color coding, and smart suggestions
- **Document Manager** — Attach documents, tickets, and PDFs to trips, places, or reservations (up to 50 MB per file) - **Document Manager** — Attach documents, tickets, and PDFs to trips, places, or reservations (up to 50 MB per file)
- **PDF Export** — Export complete trip plans as PDF with cover page, images, notes, and NOMAD branding - **PDF Export** — Export complete trip plans as PDF with cover page, images, notes, and TREK branding
### Mobile & PWA ### Mobile & PWA
- **Progressive Web App** — Install on iOS and Android directly from the browser, no App Store needed - **Progressive Web App** — Install on iOS and Android directly from the browser, no App Store needed
@@ -99,12 +99,12 @@ The app runs on port `3000`. The first user to register becomes the admin.
### Install as App (PWA) ### Install as App (PWA)
NOMAD works as a Progressive Web App — no App Store needed: TREK works as a Progressive Web App — no App Store needed:
1. Open your NOMAD instance in the browser (HTTPS required) 1. Open your TREK instance in the browser (HTTPS required)
2. **iOS**: Share button → "Add to Home Screen" 2. **iOS**: Share button → "Add to Home Screen"
3. **Android**: Menu → "Install app" or "Add to Home Screen" 3. **Android**: Menu → "Install app" or "Add to Home Screen"
4. NOMAD launches fullscreen with its own icon, just like a native app 4. TREK launches fullscreen with its own icon, just like a native app
<details> <details>
<summary>Docker Compose (recommended for production)</summary> <summary>Docker Compose (recommended for production)</summary>
@@ -113,7 +113,7 @@ NOMAD works as a Progressive Web App — no App Store needed:
services: services:
app: app:
image: mauriceboe/nomad:latest image: mauriceboe/nomad:latest
container_name: nomad container_name: trek
ports: ports:
- "3000:3000" - "3000:3000"
environment: environment:
@@ -143,19 +143,19 @@ docker compose pull && docker compose up -d
```bash ```bash
docker pull mauriceboe/nomad docker pull mauriceboe/nomad
docker rm -f nomad docker rm -f trek
docker run -d --name nomad -p 3000:3000 -v ./data:/app/data -v ./uploads:/app/uploads --restart unless-stopped mauriceboe/nomad docker run -d --name trek -p 3000:3000 -v ./data:/app/data -v ./uploads:/app/uploads --restart unless-stopped mauriceboe/nomad
``` ```
> **Tip:** Not sure which paths you used? Run `docker inspect nomad --format '{{json .Mounts}}'` before removing the container. > **Tip:** Not sure which paths you used? Run `docker inspect trek --format '{{json .Mounts}}'` before removing the container.
Your data is persisted in the mounted `data` and `uploads` volumes — updates never touch your existing data. Your data is persisted in the mounted `data` and `uploads` volumes — updates never touch your existing data.
### Reverse Proxy (recommended) ### Reverse Proxy (recommended)
For production, put NOMAD behind a reverse proxy with HTTPS (e.g. Nginx, Caddy, Traefik). For production, put TREK behind a reverse proxy with HTTPS (e.g. Nginx, Caddy, Traefik).
> **Important:** NOMAD uses WebSockets for real-time sync. Your reverse proxy must support WebSocket upgrades on the `/ws` path. > **Important:** TREK uses WebSockets for real-time sync. Your reverse proxy must support WebSocket upgrades on the `/ws` path.
<details> <details>
<summary>Nginx</summary> <summary>Nginx</summary>
@@ -220,14 +220,14 @@ API keys are configured in the **Admin Panel** after login. Keys set by the admi
1. Go to [Google Cloud Console](https://console.cloud.google.com/) 1. Go to [Google Cloud Console](https://console.cloud.google.com/)
2. Create a project and enable the **Places API (New)** 2. Create a project and enable the **Places API (New)**
3. Create an API key under Credentials 3. Create an API key under Credentials
4. In NOMAD: Admin Panel → Settings → Google Maps 4. In TREK: Admin Panel → Settings → Google Maps
## Building from Source ## Building from Source
```bash ```bash
git clone https://github.com/mauriceboe/NOMAD.git git clone https://github.com/mauriceboe/NOMAD.git
cd NOMAD cd NOMAD
docker build -t nomad . docker build -t trek .
``` ```
## Data & Backups ## Data & Backups
+1 -1
View File
@@ -21,6 +21,6 @@ You will receive a response within 48 hours. Once confirmed, a fix will be relea
## Scope ## Scope
This policy covers the NOMAD application and its Docker image (`mauriceboe/nomad`). This policy covers the TREK application and its Docker image (`mauriceboe/nomad`).
Third-party dependencies are monitored via GitHub Dependabot. Third-party dependencies are monitored via GitHub Dependabot.
+2 -2
View File
@@ -1,7 +1,7 @@
services: services:
app: app:
image: mauriceboe/nomad:2.5.5 image: mauriceboe/nomad:latest
container_name: nomad container_name: trek
ports: ports:
- "3000:3000" - "3000:3000"
environment: environment: