From 2148a7ffc5489646a55d049dd195c666868caacf Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Wed, 29 Oct 2025 20:33:32 +1100 Subject: [PATCH] DOCS: Docker guides Signed-off-by: jokob-sk --- docs/BACKUPS.md | 4 ++-- docs/LOGGING.md | 6 +++--- docs/SECURITY_FEATURES.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/BACKUPS.md b/docs/BACKUPS.md index 965f7f15..9e2fd679 100755 --- a/docs/BACKUPS.md +++ b/docs/BACKUPS.md @@ -122,7 +122,7 @@ For users running NetAlertX via Docker, you can back up or restore directly from 2. **Create a compressed archive** of your configuration and database volumes: ```bash - docker run --rm -v netalertx_config:/config -v netalertx_db:/db alpine tar -cz /config /db > netalertx-backup.tar.gz + docker run --rm -v local_path/config:/config -v local_path/db:/db alpine tar -cz /config /db > netalertx-backup.tar.gz ``` 3. **Restart the container:** @@ -142,7 +142,7 @@ For users running NetAlertX via Docker, you can back up or restore directly from 2. **Restore from your backup file:** ```bash - docker run --rm -i -v netalertx_config:/config -v netalertx_db:/db alpine tar -C / -xz < netalertx-backup.tar.gz + docker run --rm -i -v local_path/config:/config -v local_path/db:/db alpine tar -C / -xz < netalertx-backup.tar.gz ``` 3. **Restart the container:** diff --git a/docs/LOGGING.md b/docs/LOGGING.md index 8fcc1449..b26eac38 100755 --- a/docs/LOGGING.md +++ b/docs/LOGGING.md @@ -1,6 +1,6 @@ # Logging -NetAlertX comes with several logs that help to identify application issues. These include ngnix logs, app, or plugin logs. For plugin-specific log debugging, please read the [Debug Plugins](./DEBUG_PLUGINS.md) guide. +NetAlertX comes with several logs that help to identify application issues. These include nginx logs, app, or plugin logs. For plugin-specific log debugging, please read the [Debug Plugins](./DEBUG_PLUGINS.md) guide. > [!NOTE] > When debugging any issue, increase the `LOG_LEVEL` Setting as per the [Debug tips](./DEBUG_TIPS.md) documentation. @@ -42,7 +42,7 @@ You cannot find any log files on the filesystem. The container is `read-only` an The default logs are erased every time the container restarts because they are stored in temporary in-memory storage (`tmpfs`). If you need to keep a persistent, file-based log history, follow the steps below. > [!NOTE] -> This might lead to performance degradation so this approach is only suggested when activelly debuging issues. See the [Performance optimization](./PERFORMANCE.md) documentation for details. +> This might lead to performance degradation so this approach is only suggested when actively debugging issues. See the [Performance optimization](./PERFORMANCE.md) documentation for details. 1. Stop the container: @@ -72,4 +72,4 @@ The default logs are erased every time the container restarts because they are s docker-compose up -d ``` -This change stops Docker from mounting a temporary in-memory volume at `/app/log`. Instead, it "bind mounts" a persistent folder from your host computer (e.g., `/data/netalertx_logs`) to that *exact same location* inside the container. +This change stops Docker from mounting a temporary in-memory volume at `/app/log`. Instead, it "bind mounts" a persistent folder from your host computer (e.g., `/data/netalertx_logs`) to that *same location* inside the container. diff --git a/docs/SECURITY_FEATURES.md b/docs/SECURITY_FEATURES.md index 9832639e..c505a990 100644 --- a/docs/SECURITY_FEATURES.md +++ b/docs/SECURITY_FEATURES.md @@ -68,7 +68,7 @@ Here’s a breakdown of the defensive layers you get, right out of the box using ## Feature 6: The "Pre-Flight" Self-Check -**Methodology:** Before any services start, NetAlertX runs a comprehensive "pre-flight" check to ensure its own security and configuration are sound. It's like a built-in auditor that verifies its own defenses. +**Methodology:** Before any services start, NetAlertX runs a comprehensive "pre-flight" check to ensure its own security and configuration are sound. It's like a built-in auditor who verifies its own defenses. * **Active Self-Diagnosis:** On every single boot, NetAlertX runs a series of startup pre-checks—and it's fast. The entire self-check process typically completes in less than a second, letting you get to the web UI in about three seconds from startup.