Rename work 🏗

docs/API.md

@@ -9,7 +9,7 @@ The endpoints are updated when objects in the API endpoints are changed.
 
 ### Location of the endpoints
 
-In the container, these files are located under the `/home/pi/pialert/front/api/` folder and thus on the `<netalertx_url>/api/<File name>` url.
+In the container, these files are located under the `/app/front/api/` folder and thus on the `<netalertx_url>/api/<File name>` url.
 
 ### Available endpoints
 

docs/BACKUPS.md

@@ -7,8 +7,8 @@ There are 3 artifacts that can be used to backup the application:
 
 | File                  | Description                   | Limitations                   |
 |-----------------------|-------------------------------|-------------------------------|
-| `/db/pialert.db`       | Database file(s)  | The database file might be in an uncommitted state or corrupted |
-| `/config/pialert.conf` | Configuration file |   Doesn't contain settings from the Maintenance section        |
+| `/db/app.db`       | Database file(s)  | The database file might be in an uncommitted state or corrupted |
+| `/config/app.conf` | Configuration file |   Doesn't contain settings from the Maintenance section        |
 | `/config/devices.csv`  | CSV file containing device information |     Doesn't contain historical data        |
 
 ## Data and cackup storage
@@ -17,7 +17,7 @@ To decide on a backup strategy, check where the data is stored:
 
 ### Core Configuration
 
-The core application configuration is in the `pialert.conf` file (See [Settings System](https://github.com/jokob-sk/NetAlertX/blob/main/docs/SETTINGS_SYSTEM.md) for details), such as:
+The core application configuration is in the `app.conf` file (See [Settings System](https://github.com/jokob-sk/NetAlertX/blob/main/docs/SETTINGS_SYSTEM.md) for details), such as:
 
 - Notification settings
 - Scanner settings
@@ -35,7 +35,7 @@ The core device data is backed up to the `devices_<timestamp>.csv` file via the
 
 ### Historical data
 
-Historical data is stored in the `pialert.db` database (See [Database overview](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DATABASE.md) for details). This data includes:
+Historical data is stored in the `app.db` database (See [Database overview](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DATABASE.md) for details). This data includes:
 
 - Plugin objects
 - Plugin historical entries
@@ -46,7 +46,7 @@ Historical data is stored in the `pialert.db` database (See [Database overview](
 
 The safest approach to backups is to backup all of the above, by taking regular file system backups (I use [Kopia](https://github.com/kopia/kopia)). 
 
-Arguably, the most time is spent setting up the device list, so if only one file is kept I'd recommend to have a latest backup of the `devices_<timestamp>.csv` file, followed by the `pialert.conf` file. 
+Arguably, the most time is spent setting up the device list, so if only one file is kept I'd recommend to have a latest backup of the `devices_<timestamp>.csv` file, followed by the `app.conf` file. 
 
 ### Scenario 1: Full backup
 
@@ -54,8 +54,8 @@ End-result: Full restore
 
 #### Source artifacts:
 
-- `/db/pialert.db` (uncorrupted)
-- `/config/pialert.conf`
+- `/db/app.db` (uncorrupted)
+- `/config/app.conf`
 
 #### Recovery:
 
@@ -68,14 +68,14 @@ End-result: Partial restore (historical data & configurations from the Maintenan
 
 #### Source artifacts:
 
-- `/config/pialert.conf`
+- `/config/app.conf`
 - `/config/devices_<timestamp>.csv` or `/config/devices.csv`
 
 #### Recovery:
 
 Even with a corrupted database you can recover what I would argue is 99% of the configuration (except of a couple of settings under Maintenance). 
 
-- map the `/config/pialert.conf` file as described in the [Setup documentation](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#docker-paths).
+- map the `/config/app.conf` file as described in the [Setup documentation](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#docker-paths).
 - rename the `devices_<timestamp>.csv` to `devices.csv` and place it in the `/config` folder
 - Restore the `devices.csv` backup via the [Maintenance section](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md)
 

docs/DATABASE.md

@@ -1,5 +1,5 @@
   
-  # A high-level description of the datbase structure
+  # A high-level description of the database structure
 
   ⚠ Disclaimer: As I'm not the original author, some of the information might be inaccurate. Feel free to submit a PR to correct anything within this page or documentation in general. 
 
@@ -20,7 +20,7 @@
   | Plugins_Language_Strings  | Language strings colelcted from the plugin `config.json` files used for string resolution in the frontend. | ![Screen12][screen12]  | 
   | Plugins_Objects  | Unique objects detected by individual plugins. | ![Screen13][screen13]  | 
   | Sessions  | Used to display sessions in the charts | ![Screen15][screen15]  | 
-  | Settings  | Database representation of the sum of all settings from `pialert.conf` and plugins coming from `config.json` files. | ![Screen16][screen16]  | 
+  | Settings  | Database representation of the sum of all settings from `app.conf` and plugins coming from `config.json` files. | ![Screen16][screen16]  | 
 
 
 

docs/DEBUG_PLUGINS.md

@@ -19,7 +19,7 @@ For a more in-depth overview on how plugins work check the [Plugins development
 
 #### Incorrect input data
 
-Input data from the plugin might cause mapping issues in specific edge cases. Look for a corresponding section in the `pialert.log` file, for example notice the first line of the execution run of the `PIHOLE` plugin below:
+Input data from the plugin might cause mapping issues in specific edge cases. Look for a corresponding section in the `app.log` file, for example notice the first line of the execution run of the `PIHOLE` plugin below:
 
 ```
 17:31:05 [Scheduler] - Scheduler run for PIHOLE: YES

docs/DEBUG_TIPS.md

@@ -15,8 +15,8 @@ Start the container via the **terminal** with a command similar to this one:
 
 ```bash
 docker run --rm --network=host \
-  -v local/path/pialert/config:/home/pi/pialert/config \
-  -v local/path/pialert/db:/home/pi/pialert/db \
+  -v local/path/netalertx/config:/app/config \
+  -v local/path/netalertx/db:/app/db \
   -e TZ=Europe/Berlin \
   -e PORT=20211 \
   jokobsk/netalertx:latest
@@ -53,9 +53,9 @@ services:
 
 ### Permissions
 
-* If facing issues (AJAX errors, can't write to DB, empty screen, etc,) make sure permissions are set correctly, and check the logs under `/home/pi/pialert/front/log`. 
-* To solve permission issues you can try setting the owner and group of the `pialert.db` by executing the following on the host system: `docker exec netalertx chown -R www-data:www-data /home/pi/pialert/db/pialert.db`. 
-* If still facing issues, try to map the pialert.db file (⚠ not folder) to `:/home/pi/pialert/db/pialert.db` (see [docker-compose Examples](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#-docker-composeyml-examples) for details)
+* If facing issues (AJAX errors, can't write to DB, empty screen, etc,) make sure permissions are set correctly, and check the logs under `/app/front/log`. 
+* To solve permission issues you can try setting the owner and group of the `app.db` by executing the following on the host system: `docker exec netalertx chown -R www-data:www-data /app/db/app.db`. 
+* If still facing issues, try to map the app.db file (⚠ not folder) to `:/app/db/app.db` (see [docker-compose Examples](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#-docker-composeyml-examples) for details)
 
 ### Container restarts / crashes
 

docs/HOME_ASSISTANT.md

@@ -36,9 +36,9 @@ NetAlertX comes with MQTT support, allowing you to show all detected devices as
   | ![Screen 3][list] | ![Screen 4][overview] | 
   
 
-  [configuration]:   /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Configuration.png           "configuration"
-  [sensors]:         /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-as-Sensors.png       "sensors"
-  [history]:         /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-Presence-History.png "history"
-  [list]:            /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Devices-List.png            "list"  
-  [overview]:        /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Overview-Card.png           "overview"
+  [configuration]:   /docs/img/HOME_ASISSTANT/HomeAssistant-Configuration.png           "configuration"
+  [sensors]:         /docs/img/HOME_ASISSTANT/HomeAssistant-Device-as-Sensors.png       "sensors"
+  [history]:         /docs/img/HOME_ASISSTANT/HomeAssistant-Device-Presence-History.png "history"
+  [list]:            /docs/img/HOME_ASISSTANT/HomeAssistant-Devices-List.png            "list"  
+  [overview]:        /docs/img/HOME_ASISSTANT/HomeAssistant-Overview-Card.png           "overview"
 

docs/HW_INSTALL.md

@@ -14,20 +14,20 @@ be dangerous, as you cannot see the code that's about to be executed on your sys
 Alternatively you can download the installation script `install/install.debian.sh` from the repository and check the code yourself (beware other scripts are
 downloaded too - only from this repo).
 
-NetAlertX will be installed in `home/pi/pialert/` and run on port number `20211`.
+NetAlertX will be installed in `/app` and run on port number `20211`.
 
 Some facts about what and where something will be changed/installed by the HW install setup (may not contain everything!):
 
-- `/home/pi/pialert` directory will be deleted and newly created
-- `/home/pi/pialert` will contain the whole repository (downloaded by `install/install.debian.sh`)
+- `/app` directory will be deleted and newly created
+- `/app` will contain the whole repository (downloaded by `install/install.debian.sh`)
 - The default NGINX site `/etc/nginx/sites-enabled/default` will be disabled (sym-link deleted or backed up to `sites-available`)
-- `/var/www/html/pialert` directory will be deleted and newly created
-- `/etc/nginx/conf.d/pialert.conf` will be sym-linked to `/home/pi/pialert/install/netalertx.debian.conf`
+- `/var/www/html/netalertx` directory will be deleted and newly created
+- `/etc/nginx/conf.d/netalertx.conf` will be sym-linked to `/app/install/netalertx.debian.conf`
 - Some files (IEEE device vendors info, ...) will be created in the directory where the installation script is executed
 
 ## Limitations
 
-- No system service is provided. NetAlertX must be started using `/home/pi/pialert/install/start.debian.sh`.
+- No system service is provided. NetAlertX must be started using `/app/install/start.debian.sh`.
 - No checks for other running software is done.
 - Only tested to work on Debian Bookworm (Debian 12).
 - **EXPERIMENTAL** and not recommended way to install NetAlertX.

docs/ICONS.md

@@ -45,7 +45,7 @@ Copying the HTML code from [Font Awesome](https://fontawesome.com/search?o=r&m=f
 If you own the premium package of Font Awesome icons you can mount it in your Docker container the following way:
 
 ```yaml
-/font-awesome:/home/pi/pialert/front/lib/AdminLTE/bower_components/font-awesome:ro
+/font-awesome:/app/front/lib/AdminLTE/bower_components/font-awesome:ro
 ```
 
 You can use the full range of Font Awesome icons afterwards. 

docs/MIGRATION.md

@@ -0,0 +1,119 @@
+# Migration form PiAlert to NetAlertX
+
+The migration should be pretty straightforward. The application installation folder in the docker container has changed from `/home/pi/pialert` to `/app`. That means the new mount points are:
+
+ | Old mount point | New mount point | 
+ |----------------------|---------------| 
+ | `/home/pi/pialert/config` | `/app/config` |
+ | `/home/pi/pialert/db` | `/app/db` |
+
+
+ If you were mounting files directly, please note the file names have changed:
+
+ | Old file name | New file name | 
+ |----------------------|---------------| 
+ | `pialert.conf` | `app.conf` |
+ | `pialert.db` | `app.db` |
+
+
+> [!NOTE] 
+> The application uses symlinks linking the old locations to the new ones, so data loss should not occur. [Backup strategies](https://github.com/jokob-sk/NetAlertX/blob/main/docs/BACKUPS.md) are still recommended to backup your setup.
+
+In summary, docker file mount locations in your `docker-compose.yml` or docker run command have changed. Examples follow.
+
+
+## Example 1: Mapping folders
+
+### Old docker-compose.yml
+
+```yaml
+version: "3"
+services:
+  pialert:
+    container_name: pialert
+    # use the below line if you want to test the latest dev image
+    # image: "jokobsk/netalertx-dev:latest" 
+    image: "jokobsk/pialert:latest"      
+    network_mode: "host"        
+    restart: unless-stopped
+    volumes:
+      - local/path/config:/home/pi/pialert/config  
+      - local/path/db:/home/pi/pialert/db         
+      # (optional) useful for debugging if you have issues setting up the container
+      - local/path/logs:/home/pi/pialert/front/log
+    environment:
+      - TZ=Europe/Berlin      
+      - PORT=20211
+```
+
+### New docker-compose.yml
+
+```yaml
+version: "3"
+services:
+  netalertx:                                  # ⚠🟡  This has changed (optional) 🟡⚠
+    container_name: netalertx                 # ⚠🟡  This has changed (optional) 🟡⚠
+    # use the below line if you want to test the latest dev image
+    # image: "jokobsk/netalertx-dev:latest" 
+    image: "jokobsk/netalertx:latest"         # ⚠🔺🟡  This has changed (optional/required in future) 🟡🔺⚠
+    network_mode: "host"        
+    restart: unless-stopped
+    volumes:
+      - local/path/config:/app/config         # ⚠🔺  This has changed (required) 🔺⚠
+      - local/path/db:/app/db                 # ⚠🔺  This has changed (required) 🔺⚠
+      # (optional) useful for debugging if you have issues setting up the container
+      - local/path/logs:/app/front/log        # ⚠🟡  This has changed (optional) 🟡⚠
+    environment:
+      - TZ=Europe/Berlin      
+      - PORT=20211
+```
+
+
+## Example 2: Mapping files
+
+> [!NOTE] 
+> The recommendation is to map folders as in Example 1, map files directly only when needed. 
+
+### Old docker-compose.yml
+
+```yaml
+version: "3"
+services:
+  pialert:
+    container_name: pialert
+    # use the below line if you want to test the latest dev image
+    # image: "jokobsk/netalertx-dev:latest" 
+    image: "jokobsk/pialert:latest"      
+    network_mode: "host"        
+    restart: unless-stopped
+    volumes:
+      - local/path/config/pialert.conf:/home/pi/pialert/config/pialert.conf  
+      - local/path/db/pialert.db:/home/pi/pialert/db/pialert.db         
+      # (optional) useful for debugging if you have issues setting up the container
+      - local/path/logs:/home/pi/pialert/front/log
+    environment:
+      - TZ=Europe/Berlin      
+      - PORT=20211
+```
+
+### New docker-compose.yml
+
+```yaml
+version: "3"
+services:
+  netalertx:                                  # ⚠🟡  This has changed (optional) 🟡⚠
+    container_name: netalertx                 # ⚠🟡  This has changed (optional) 🟡⚠
+    # use the below line if you want to test the latest dev image
+    # image: "jokobsk/netalertx-dev:latest" 
+    image: "jokobsk/netalertx:latest"         # ⚠🔺🟡  This has changed (optional/required in future) 🟡🔺⚠
+    network_mode: "host"        
+    restart: unless-stopped
+    volumes:
+      - local/path/config/app.conf:/app/config/app.conf # ⚠🔺  This has changed (required) 🔺⚠
+      - local/path/db/app.db:/app/db/app.db             # ⚠🔺  This has changed (required) 🔺⚠
+      # (optional) useful for debugging if you have issues setting up the container
+      - local/path/logs:/app/front/log                  # ⚠🟡  This has changed (optional) 🟡⚠
+    environment:
+      - TZ=Europe/Berlin      
+      - PORT=20211
+```

docs/README.md

@@ -63,7 +63,7 @@ There is also an in-app Help / FAQ section that should be answering frequently a
 
 #### 👩‍💻For Developers👨‍💻
 
-- [APP code structure](/netalertx/README.md)
+- [Server APP code structure](/server/README.md)
 - [Database structure](/docs/DATABASE.md)
 - [API endpoints details](/docs/API.md)
 - [Plugin system details and how to develop your own](/front/plugins/README.md)
@@ -122,7 +122,7 @@ Suggested test cases:
 
 Some additional context:
 
-* Permanent settings/config is stored in the `pialert.conf` file
+* Permanent settings/config is stored in the `app.conf` file
 * Currently temporary (session?) settings are stored in the `Parameters` DB table as key-value pairs. This table is wiped during a container rebuild/restart and its values are re-initialized from cookies/session data from the browser. 
 
 ## 🐛 Submitting an issue or bug

docs/REVERSE_DNS.md

@@ -41,9 +41,9 @@ services:
     image: "jokobsk/netalertx:latest"
     restart: unless-stopped
     volumes:
-      - ./config/pialert.conf:/home/pi/pialert/config/pialert.conf
-      - ./pialert_db:/home/pi/pialert/db
-      - ./log:/home/pi/pialert/front/log
+      - ./config/app.conf:/app/config/app.conf
+      - ./db:/app/db
+      - ./log:/app/front/log
       - ./config/resolv.conf:/etc/resolv.conf                          # Mapping the /resolv.conf file for better name resolution
     environment:
       - TZ=Europe/Berlin

docs/REVERSE_PROXY.md

@@ -472,9 +472,9 @@ Mapping the updated file (on the local filesystem at `/appl/docker/netalertx/def
 ```bash
 docker run -d --rm --network=host \
   --name=netalertx \
-  -v /appl/docker/pialert/config:/home/pi/pialert/config \
-  -v /appl/docker/pialert/db:/home/pi/pialert/db \
-  -v /appl/docker/pialert/default:/etc/nginx/sites-available/default \
+  -v /appl/docker/netalertx/config:/app/config \
+  -v /appl/docker/netalertx/db:/app/db \
+  -v /appl/docker/netalertx/default:/etc/nginx/sites-available/default \
   -e TZ=Europe/Amsterdam \
   -e PORT=20211 \
   jokobsk/netalertx:latest

docs/SETTINGS_SYSTEM.md

@@ -6,11 +6,11 @@ If you are a user of the app, settings have a detailed description in the _Setti
 
 ### 🛢 Data storage
 
-The source of truth for user-defined values is the `pialert.conf` file. Editing the file makes the App overwrite values in the `Settings` database table and in the `table_settings.json` file. 
+The source of truth for user-defined values is the `app.conf` file. Editing the file makes the App overwrite values in the `Settings` database table and in the `table_settings.json` file. 
 
 #### Settings database table
 
-The `Settings` database table contains settings for App run purposes. The table is recreated every time the App restarts. The settings are loaded from the source-of-truth, that is the `pialert.conf` file. A high-level overview on the database structure can be found in the [database documentation](/docs/DATABASE.md). 
+The `Settings` database table contains settings for App run purposes. The table is recreated every time the App restarts. The settings are loaded from the source-of-truth, that is the `app.conf` file. A high-level overview on the database structure can be found in the [database documentation](/docs/DATABASE.md). 
 
 #### table_settings.json
 
@@ -20,27 +20,27 @@ This is the [API endpoint](/docs/API.md) that reflects the state of the `Setting
 
 The json file is also cached on the client-side local storage of the browser.
 
-#### pialert.conf
+#### app.conf
 
 > [!NOTE] 
 > This is the source of truth for settings. User-defined values in this files always override default values specified in the Plugin definition.
 
-The App generates two `pialert.conf` entries for every setting (Since version 23.8+). One entry is the setting value, the second is the `__metadata` associated with the setting. This `__metadata` entry contains the full setting definition in JSON format. Currently unused, but intended to be used in future to extend the Settings system.
+The App generates two `app.conf` entries for every setting (Since version 23.8+). One entry is the setting value, the second is the `__metadata` associated with the setting. This `__metadata` entry contains the full setting definition in JSON format. Currently unused, but intended to be used in future to extend the Settings system.
 
 #### Plugin settings
 
 > [!NOTE] 
 > This is the preferred way adding settings going forward. I'll be likely migrating all app settings into plugin-based settings.
 
-Plugin settings are loaded dynamically from the `config.json` of individual plugins. If a setting isn't defined in the `pialert.conf` file, it is initialized via the `default_value` property of a setting from the `config.json` file. Check the [Plugins documentation](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md#-setting-object-structure), section `⚙ Setting object structure` for details on the structure of the setting.
+Plugin settings are loaded dynamically from the `config.json` of individual plugins. If a setting isn't defined in the `app.conf` file, it is initialized via the `default_value` property of a setting from the `config.json` file. Check the [Plugins documentation](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md#-setting-object-structure), section `⚙ Setting object structure` for details on the structure of the setting.
 
 ![Screen 1][screen1]
 
 ### Settings Process flow
 
-The process flow is mostly managed by the [initialise.py](/pialert/initialise.py) file. 
+The process flow is mostly managed by the [initialise.py](/server/initialise.py) file. 
 
-The script is responsible for reading user-defined values from a configuration file (`pialert.conf`), initializing settings, and importing them into a database. It also handles plugins and their configurations.
+The script is responsible for reading user-defined values from a configuration file (`app.conf`), initializing settings, and importing them into a database. It also handles plugins and their configurations.
 
 Here's a high-level description of the code:
 
@@ -49,7 +49,7 @@ Here's a high-level description of the code:
 
    - `importConfigs`: This function is the main entry point of the script. It imports user settings from a configuration file, processes them, and saves them to the database.
 
-   - `read_config_file`: This function reads the configuration file (`pialert.conf`) and returns a dictionary containing the key-value pairs from the file.
+   - `read_config_file`: This function reads the configuration file (`app.conf`) and returns a dictionary containing the key-value pairs from the file.
 
 2. Importing Configuration and Initializing Settings:
    - The `importConfigs` function starts by checking the modification time of the configuration file to determine if it needs to be re-imported. If the file has not been modified since the last import, the function skips the import process.

docs/SUBNETS.md

@@ -8,7 +8,7 @@ You need to specify the network interface and the network mask. You can also con
 ## Examples
 
 > [!NOTE] 
-> Please use the UI to configure settings as that ensures that the config file is in the correct format. Edit `pialert.conf` directly only when really necessary.
+> Please use the UI to configure settings as that ensures that the config file is in the correct format. Edit `app.conf` directly only when really necessary.
 > ![settings](/front/plugins/arp_scan/arp-scan-settings.png)
 
 * Examples for one and two subnets  (❗ Note the `['...', '...']` format):

docs/VERSIONS.md

@@ -22,4 +22,4 @@ For a comparison, this is how the UI looks like if you are on the latest stable
 
 ## Implementation details
 
-During build a [/home/pi/pialert/front/buildtimestamp.txt](https://github.com/jokob-sk/NetAlertX/blob/092797e75ccfa8359444ad149e727358ac4da05f/Dockerfile#L44) file is created. The app then periodically checks if a new release is available with a newer timestamp in GitHub's rest-based JSON endpoint (check the `def isNewVersion():` method in `pialert.py` for details).   
+During build a [/app/front/buildtimestamp.txt](https://github.com/jokob-sk/NetAlertX/blob/092797e75ccfa8359444ad149e727358ac4da05f/Dockerfile#L44) file is created. The app then periodically checks if a new release is available with a newer timestamp in GitHub's rest-based JSON endpoint (check the `def isNewVersion():` method for details).