From 51ef7f3b864ba4edcaf6d8310fb522a345887df6 Mon Sep 17 00:00:00 2001 From: Jamie Curnow Date: Thu, 19 Feb 2026 08:36:41 +1000 Subject: [PATCH] Docs update, use package version instead of latest, refer to better mariadb image --- docs/package.json | 3 ++- docs/scripts/set-version.sh | 17 +++++++++++++++++ docs/src/advanced-config/index.md | 16 +++++++--------- docs/src/guide/index.md | 2 +- docs/src/setup/index.md | 27 ++++++++++----------------- 5 files changed, 37 insertions(+), 28 deletions(-) create mode 100755 docs/scripts/set-version.sh diff --git a/docs/package.json b/docs/package.json index d4523250..2155a557 100644 --- a/docs/package.json +++ b/docs/package.json @@ -2,7 +2,8 @@ "scripts": { "dev": "vitepress dev --host", "build": "vitepress build", - "preview": "vitepress preview" + "preview": "vitepress preview", + "set-version": "./scripts/set-version.sh" }, "devDependencies": { "vitepress": "^1.6.4" diff --git a/docs/scripts/set-version.sh b/docs/scripts/set-version.sh new file mode 100755 index 00000000..b7cd3d75 --- /dev/null +++ b/docs/scripts/set-version.sh @@ -0,0 +1,17 @@ +#!/bin/bash +set -euf + +# this script accepts a version number as an argument +# and replaces {{VERSION}} in src/*.md with the provided version number. + +if [ "$#" -ne 1 ]; then + echo "Usage: $0 " + exit 1 +fi + +DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +cd "$DIR/.." || exit 1 + +VERSION="$1" +# find all .md files in src/ and replace {{VERSION}} with the provided version number +find src/ -type f -name "*.md" -exec sed -i "s/{{VERSION}}/$VERSION/g" {} \; diff --git a/docs/src/advanced-config/index.md b/docs/src/advanced-config/index.md index e4a9594e..d987e0b0 100644 --- a/docs/src/advanced-config/index.md +++ b/docs/src/advanced-config/index.md @@ -14,7 +14,7 @@ on the `data` and `letsencrypt` folders at startup. ```yml services: app: - image: 'jc21/nginx-proxy-manager:latest' + image: 'jc21/nginx-proxy-manager:{{VERSION}}' environment: PUID: 1000 PGID: 1000 @@ -101,7 +101,7 @@ secrets: services: app: - image: 'jc21/nginx-proxy-manager:latest' + image: 'jc21/nginx-proxy-manager:{{VERSION}}' restart: unless-stopped ports: # Public HTTP Port: @@ -130,18 +130,16 @@ services: - db db: - image: jc21/mariadb-aria + image: 'linuxserver/mariadb' restart: unless-stopped environment: - # MYSQL_ROOT_PASSWORD: "npm" # use secret instead MYSQL_ROOT_PASSWORD__FILE: /run/secrets/DB_ROOT_PWD - MYSQL_DATABASE: "npm" - MYSQL_USER: "npm" - # MYSQL_PASSWORD: "npm" # use secret instead + MYSQL_DATABASE: 'npm' + MYSQL_USER: 'npm' MYSQL_PASSWORD__FILE: /run/secrets/MYSQL_PWD - MARIADB_AUTO_UPGRADE: '1' + TZ: 'Australia/Brisbane' volumes: - - ./mysql:/var/lib/mysql + - ./mariadb:/config secrets: - DB_ROOT_PWD - MYSQL_PWD diff --git a/docs/src/guide/index.md b/docs/src/guide/index.md index a9de63a9..6e2d1feb 100644 --- a/docs/src/guide/index.md +++ b/docs/src/guide/index.md @@ -64,7 +64,7 @@ I won't go in to too much detail here but here are the basics for someone new to ```yml services: app: - image: 'jc21/nginx-proxy-manager:latest' + image: 'jc21/nginx-proxy-manager:{{VERSION}}' restart: unless-stopped environment: TZ: "Australia/Brisbane" diff --git a/docs/src/setup/index.md b/docs/src/setup/index.md index 49b9e618..286a2e35 100644 --- a/docs/src/setup/index.md +++ b/docs/src/setup/index.md @@ -11,7 +11,7 @@ Create a `docker-compose.yml` file: ```yml services: app: - image: 'jc21/nginx-proxy-manager:latest' + image: 'jc21/nginx-proxy-manager:{{VERSION}}' restart: unless-stopped ports: @@ -45,10 +45,7 @@ docker compose up -d ## Using MySQL / MariaDB Database -If you opt for the MySQL configuration you will have to provide the database server yourself. You can also use MariaDB. Here are the minimum supported versions: - -- MySQL v5.7.8+ -- MariaDB v10.2.7+ +If you opt for the MySQL configuration you will have to provide the database server yourself. It's easy to use another docker container for your database also and link it as part of the docker stack, so that's what the following examples are going to use. @@ -58,7 +55,7 @@ Here is an example of what your `docker-compose.yml` will look like when using a ```yml services: app: - image: 'jc21/nginx-proxy-manager:latest' + image: 'jc21/nginx-proxy-manager:{{VERSION}}' restart: unless-stopped ports: # These ports are in format : @@ -88,31 +85,29 @@ services: - db db: - image: 'jc21/mariadb-aria:latest' + image: 'linuxserver/mariadb' restart: unless-stopped environment: MYSQL_ROOT_PASSWORD: 'npm' MYSQL_DATABASE: 'npm' MYSQL_USER: 'npm' MYSQL_PASSWORD: 'npm' - MARIADB_AUTO_UPGRADE: '1' + TZ: 'Australia/Brisbane' volumes: - - ./mysql:/var/lib/mysql + - ./mariadb:/config ``` ::: warning - Please note, that `DB_MYSQL_*` environment variables will take precedent over `DB_SQLITE_*` variables. So if you keep the MySQL variables, you will not be able to use SQLite. - ::: ### Optional: MySQL / MariaDB SSL You can enable TLS for the MySQL/MariaDB connection with these environment variables: -- DB_MYSQL_SSL: Enable SSL when set to true. If unset or false, SSL disabled (previous default behaviour). -- DB_MYSQL_SSL_REJECT_UNAUTHORIZED: (default: true) Validate the server certificate chain. Set to false to allow self‑signed/unknown CA. -- DB_MYSQL_SSL_VERIFY_IDENTITY: (default: true) Performs host name / identity verification. +- `DB_MYSQL_SSL`: Enable SSL when set to true. If unset or false, SSL disabled (previous default behaviour). +- `DB_MYSQL_SSL_REJECT_UNAUTHORIZED`: (default: true) Validate the server certificate chain. Set to false to allow self‑signed/unknown CA. +- `DB_MYSQL_SSL_VERIFY_IDENTITY`: (default: true) Performs host name / identity verification. Enabling SSL using a self-signed cert (not recommended for production). @@ -123,7 +118,7 @@ Similar to the MySQL server setup: ```yml services: app: - image: 'jc21/nginx-proxy-manager:latest' + image: 'jc21/nginx-proxy-manager:{{VERSION}}' restart: unless-stopped ports: # These ports are in format : @@ -185,8 +180,6 @@ for a list of supported architectures and if you want one that doesn't exist, Also, if you don't know how to already, follow [this guide to install docker and docker-compose](https://manre-universe.net/how-to-run-docker-and-docker-compose-on-raspbian/) on Raspbian. -Please note that the `jc21/mariadb-aria:latest` image might have some problems on some ARM devices, if you want a separate database container, use the `yobasystems/alpine-mariadb:latest` image. - ## Initial Run After the app is running for the first time, the following will happen: