From ba3481759b4e24e6247b7dd685366f5989699b10 Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Sat, 29 Nov 2025 16:50:06 +1100 Subject: [PATCH] DOCS: Migration callouts Signed-off-by: jokob-sk --- README.md | 4 +--- docs/DOCKER_COMPOSE.md | 4 +--- docs/DOCKER_MAINTENANCE.md | 14 ++++++-------- docs/FILE_PERMISSIONS.md | 2 +- docs/MIGRATION.md | 9 +-------- docs/SYNOLOGY_GUIDE.md | 2 +- 6 files changed, 11 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 3dfc064e..e8798548 100755 --- a/README.md +++ b/README.md @@ -34,9 +34,7 @@ Get visibility of what's going on on your WIFI/LAN network and enable presence d ## 🚀 Quick Start > [!WARNING] -> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed. -> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container. -> These docs reflect the latest development version and may differ from the production image. +> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. Start NetAlertX in seconds with Docker: diff --git a/docs/DOCKER_COMPOSE.md b/docs/DOCKER_COMPOSE.md index b0ad6678..f6fcea43 100755 --- a/docs/DOCKER_COMPOSE.md +++ b/docs/DOCKER_COMPOSE.md @@ -1,9 +1,7 @@ # NetAlertX and Docker Compose > [!WARNING] -> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed. -> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container. -> These docs reflect the latest development version and may differ from the production image. +> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. Great care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system.Good care is taken to ensure NetAlertX meets the needs of everyone while being flexible enough for anyone. This document outlines how you can configure your docker-compose. There are many settings, so we recommend using the Baseline Docker Compose as-is, or modifying it for your system. diff --git a/docs/DOCKER_MAINTENANCE.md b/docs/DOCKER_MAINTENANCE.md index e428a9a1..89e35afd 100644 --- a/docs/DOCKER_MAINTENANCE.md +++ b/docs/DOCKER_MAINTENANCE.md @@ -1,20 +1,18 @@ # The NetAlertX Container Operator's Guide > [!WARNING] -> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed. -> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container. -> These docs reflect the latest development version and may differ from the production image. +> ⚠️ **Important:** The docker-compose has recently changed. Carefully read the [Migration guide](https://jokob-sk.github.io/NetAlertX/MIGRATION/?h=migrat#12-migration-from-netalertx-v25524) for detailed instructions. This guide assumes you are starting with the official `docker-compose.yml` file provided with the project. We strongly recommend you start with or migrate to this file as your baseline and modify it to suit your specific needs (e.g., changing file paths). While there are many ways to configure NetAlertX, the default file is designed to meet the mandatory security baseline with layer-2 networking capabilities while operating securely and without startup warnings. This guide provides direct, concise solutions for common NetAlertX administrative tasks. It is structured to help you identify a problem, implement the solution, and understand the details. ## Guide Contents - -- Using a Local Folder for Configuration -- Migrating from a Local Folder to a Docker Volume -- Applying a Custom Nginx Configuration -- Mounting Additional Files for Plugins + +- Using a Local Folder for Configuration +- Migrating from a Local Folder to a Docker Volume +- Applying a Custom Nginx Configuration +- Mounting Additional Files for Plugins > [!NOTE] diff --git a/docs/FILE_PERMISSIONS.md b/docs/FILE_PERMISSIONS.md index a7d11a60..d6221333 100755 --- a/docs/FILE_PERMISSIONS.md +++ b/docs/FILE_PERMISSIONS.md @@ -62,7 +62,7 @@ docker run -it --rm --name netalertx --user "0" \ > > `sudo chown -R 20211:20211 /local_data_dir` > -> `sudo chmod -R a+rwx /local_data_dir1` +> `sudo chmod -R a+rwx /local_data_dir` > --- diff --git a/docs/MIGRATION.md b/docs/MIGRATION.md index 8848ee9b..ac5b0041 100755 --- a/docs/MIGRATION.md +++ b/docs/MIGRATION.md @@ -1,11 +1,5 @@ # Migration -> [!WARNING] -> ⚠️ **Important:** The documentation has been recently updated and some instructions may have changed. -> If you are using the currently live production image, please follow the instructions on [Docker Hub](https://hub.docker.com/r/jokobsk/netalertx) for building and running the container. -> These docs reflect the latest development version and may differ from the production image. - - When upgrading from older versions of NetAlertX (or PiAlert by jokob-sk), follow the migration steps below to ensure your data and configuration are properly transferred. > [!TIP] @@ -262,8 +256,7 @@ docker run -it --rm --name netalertx --user "0" \ ..or alternatively execute: ```bash -sudo chown -R 20211:20211 /local_data_dir/config -sudo chown -R 20211:20211 /local_data_dir/db +sudo chown -R 20211:20211 /local_data_dir sudo chmod -R a+rwx /local_data_dir/ ``` diff --git a/docs/SYNOLOGY_GUIDE.md b/docs/SYNOLOGY_GUIDE.md index 7707d50e..f2d6e62a 100755 --- a/docs/SYNOLOGY_GUIDE.md +++ b/docs/SYNOLOGY_GUIDE.md @@ -84,5 +84,5 @@ services: > > `sudo chown -R 20211:20211 /local_data_dir` > -> `sudo chmod -R a+rwx /local_data_dir1` +> `sudo chmod -R a+rwx /local_data_dir` >