From ee54d891442c17a1364282ceb0bd1c9b39017d64 Mon Sep 17 00:00:00 2001 From: Maurice Date: Sat, 28 Mar 2026 16:41:06 +0100 Subject: [PATCH] docs: rebrand README, SECURITY.md, docker-compose.yml to TREK --- README.md | 32 ++++++++++++++++---------------- SECURITY.md | 2 +- docker-compose.yml | 4 ++-- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 056804f..4d0d3a9 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ - NOMAD + TREK
- Navigation Organizer for Maps, Activities & Destinations + Your Trips. Your Plan.

@@ -18,10 +18,10 @@

A self-hosted, real-time collaborative travel planner with interactive maps, budgets, packing lists, and more.
- Live Demo — Try NOMAD without installing. Resets hourly. + Live Demo — Try TREK without installing. Resets hourly.

-![NOMAD Screenshot](docs/screenshot.png) +![TREK Screenshot](docs/screenshot.png) ![NOMAD Screenshot 2](docs/screenshot-2.png)
@@ -50,7 +50,7 @@ - **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 - **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 - **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) -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" 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
Docker Compose (recommended for production) @@ -113,7 +113,7 @@ NOMAD works as a Progressive Web App — no App Store needed: services: app: image: mauriceboe/nomad:latest - container_name: nomad + container_name: trek ports: - "3000:3000" environment: @@ -143,19 +143,19 @@ docker compose pull && docker compose up -d ```bash docker pull mauriceboe/nomad -docker rm -f nomad -docker run -d --name nomad -p 3000:3000 -v ./data:/app/data -v ./uploads:/app/uploads --restart unless-stopped mauriceboe/nomad +docker rm -f trek +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. ### 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.
Nginx @@ -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/) 2. Create a project and enable the **Places API (New)** 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 ```bash git clone https://github.com/mauriceboe/NOMAD.git cd NOMAD -docker build -t nomad . +docker build -t trek . ``` ## Data & Backups diff --git a/SECURITY.md b/SECURITY.md index 7e5862b..5d0d2e0 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -21,6 +21,6 @@ You will receive a response within 48 hours. Once confirmed, a fix will be relea ## 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. diff --git a/docker-compose.yml b/docker-compose.yml index 1374f29..3a52f48 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ services: app: - image: mauriceboe/nomad:2.5.5 - container_name: nomad + image: mauriceboe/nomad:latest + container_name: trek ports: - "3000:3000" environment: