Skip to content

Commit 1c179ef

Browse files
committed
docs: improve docs for advanced install
1 parent 5dc4847 commit 1c179ef

File tree

2 files changed

+24
-10
lines changed

2 files changed

+24
-10
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,16 @@ Project N.O.M.A.D. can be installed on any Debian-based operating system (we rec
2121

2222
*Note: sudo/root privileges are required to run the install script*
2323

24-
#### Quick Install
24+
#### Quick Install (Debian-based OS Only)
2525
```bash
2626
sudo apt-get update && sudo apt-get install -y curl && curl -fsSL https://raw.githubusercontent.com/Crosstalk-Solutions/project-nomad/refs/heads/main/install/install_nomad.sh -o install_nomad.sh && sudo bash install_nomad.sh
2727
```
2828

2929
Project N.O.M.A.D. is now installed on your device! Open a browser and navigate to `http://localhost:8080` (or `http://DEVICE_IP:8080`) to start exploring!
3030

31+
### Advanced Installation
32+
For more control over the installation process, copy and paste the [Docker Compose template](https://raw.githubusercontent.com/Crosstalk-Solutions/project-nomad/refs/heads/main/install/management_compose.yml) into a `docker-compose.yml` file and customize it to your liking (be sure to replace any placeholders with your actual values). Then, run `docker compose up -d` to start the Command Center and its dependencies. Note: this method is recommended for advanced users only, as it requires familiarity with Docker and manual configuration before starting.
33+
3134
## How It Works
3235
N.O.M.A.D. is a management UI ("Command Center") and API that orchestrates a collection of containerized tools and resources via [Docker](https://www.docker.com/). It handles installation, configuration, and updates for everything — so you don't have to.
3336

install/management_compose.yaml

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,24 @@ services:
2525
- NODE_ENV=production
2626
- PORT=8080
2727
- LOG_LEVEL=info
28-
- APP_KEY=replaceme # Needs to be at least 16 chars or will fail validation and container won't start!
29-
- HOST=0.0.0.0 # Leave this as is so the admin server listens all interfaces within the container - this doesn't affect how you access it from the host, it's just for internal container networking
30-
- URL=replaceme # Should be set to the URL you will access the admin interface at (e.g. http://localhost:8080 or http://192.168.1.x:8080)
28+
# APP_KEY needs to be at least 16 chars or will fail validation and container won't start!
29+
- APP_KEY=replaceme
30+
# # Leave HOST as is so the admin server listens all interfaces within the container - this doesn't affect how you access it from the host, it's just for internal container networking
31+
- HOST=0.0.0.0
32+
# URL should be set to the URL you will access the admin interface at (e.g. http://localhost:8080 or http://192.168.1.x:8080)
33+
- URL=replaceme
3134
- DB_HOST=mysql
32-
- DB_PORT=3306 # If you change the MySQL port, make sure to update this accordingly
35+
# If you change the MySQL port, make sure to update this accordingly
36+
- DB_PORT=3306
3337
- DB_DATABASE=nomad
3438
- DB_USER=nomad_user
35-
- DB_PASSWORD=replaceme # Needs to match the MYSQL_PASSWORD in the mysql service!
39+
# Needs to match the MYSQL_PASSWORD in the mysql service!
40+
- DB_PASSWORD=replaceme
3641
- DB_NAME=nomad
3742
- DB_SSL=false
3843
- REDIS_HOST=redis
39-
- REDIS_PORT=6379 # If you change the Redis port, make sure to update this accordingly
44+
# If you change the Redis port, make sure to update this accordingly
45+
- REDIS_PORT=6379
4046
depends_on:
4147
mysql:
4248
condition: service_healthy
@@ -48,7 +54,8 @@ services:
4854
timeout: 10s
4955
retries: 3
5056
dozzle:
51-
image: amir20/dozzle:v10.0 # Dozzle is optional, but note that the "Service Logs & Metrics" link in Settings points to it. We recommend including it unless you have a specific reason not to
57+
# Dozzle is optional, but it's lightweight and allows for easily viewing container logs. We recommend including it unless you have a specific reason not to
58+
image: amir20/dozzle:v10.0
5259
container_name: nomad_dozzle
5360
restart: unless-stopped
5461
ports:
@@ -66,7 +73,8 @@ services:
6673
- MYSQL_ROOT_PASSWORD=replaceme
6774
- MYSQL_DATABASE=nomad
6875
- MYSQL_USER=nomad_user
69-
- MYSQL_PASSWORD=replaceme # Needs to match DB_PASSWORD in the admin service!
76+
# Needs to match DB_PASSWORD in the admin service!
77+
- MYSQL_PASSWORD=replaceme
7078
volumes:
7179
- /opt/project-nomad/mysql:/var/lib/mysql
7280
healthcheck:
@@ -85,7 +93,8 @@ services:
8593
interval: 30s
8694
timeout: 10s
8795
retries: 3
88-
updater: # Updater & disk-collector are lightweight sidecar containers that run alongside the admin container to handle updates and host disk usage collection, respectively.
96+
updater:
97+
# Updater is a lightweight sidecar container that allows the admin container to be updated from within it's own UI
8998
image: ghcr.io/crosstalk-solutions/project-nomad-sidecar-updater:latest
9099
pull_policy: always
91100
container_name: nomad_updater
@@ -95,6 +104,8 @@ services:
95104
- /opt/project-nomad:/opt/project-nomad # Writable access required so the updater can set the correct image tag in compose.yml
96105
- nomad-update-shared:/shared # Shared volume for communication with admin container
97106
disk-collector:
107+
# Disk Collector is a lightweight privileged container that collects disk usage information from the host system and shares it with the admin container so it can be displayed in the UI.
108+
# It requires read-only access to the host filesystem and is designed to be as secure and limited in scope as possible while still providing the necessary functionality.
98109
image: ghcr.io/crosstalk-solutions/project-nomad-disk-collector:latest
99110
pull_policy: always
100111
container_name: nomad_disk_collector

0 commit comments

Comments
 (0)