From 6804e40897ac114f147336907e132f675e9ee3cf Mon Sep 17 00:00:00 2001
From: deajan <ozy@netpower.fr>
Date: Tue, 17 Sep 2024 16:42:49 +0200
Subject: [PATCH] Initial upgrade server documentation

---
 UPGRADE_SERVER.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 UPGRADE_SERVER.md

diff --git a/UPGRADE_SERVER.md b/UPGRADE_SERVER.md
new file mode 100644
index 0000000..5a5c930
--- /dev/null
+++ b/UPGRADE_SERVER.md
@@ -0,0 +1,76 @@
+## Setup upgrade server
+
+Clone git repository into a directory and create a venv environment
+
+```
+cd /opt
+git clone https://github.com/netinvnet/npbackup
+cd npbackup
+python -m venv venv
+```
+
+Install requirements
+```
+venv/bin/python -m pip install -r upgrade_server/requirements.txt
+```
+
+## Configuration file
+
+Create a configuration file ie `/etc/npbackup_upgrade_server.conf` with the following content
+
+```
+# NPBackup v3 upgrade server
+http_server:
+  # These are the passwords that need to be set in the upgrade settings of NPBackup client
+  username: npbackup_upgrader
+  password: SomeSuperSecurePassword
+  listen: 0.0.0.0
+  port: 8080
+upgrades:
+  data_root: /opt/upgrade_server_root
+  statistics_file: /opt/upgrade_server_root/stats.csv
+```
+
+You should also create the upgrade server root path
+```
+mkdir /opt/upgrade_server_root
+```
+
+## Provisioning files
+
+Basically, upgrade_server servers zipped versions of NPBackup, than can directly be downloaded from git releases
+
+When uploading new versions, you need to create a file in the data root called `VERSION` which should contain current NPBackup version, example `3.0.1`  
+This way, every NPBackup client will download this file and compare with it's current version in order to verify if an upgrade is needed.
+
+If an upgrade is needed, NPBackup will try to download it from `/{platform}/{arch}/npbackup.zip`  
+
+Current platforms are: `windows`, `linux`
+Current arches are `x64`, `x64-legacy`, `x86-legacy`, `arm-legacy` and `arm64-legacy`.
+
+Basically, if you want to update the current windows NPBackup client, you should have copy your new npbackup zip file to 
+`/opt/upgrade_server_root/windows/x64/npbackup.zip`
+
+
+## Run server
+
+You can run server with
+```
+venv/bin/python upgrade_server/upgrade_server.py -c /etc/npbackup_upgrade_server.conf
+```
+
+## Create a service
+
+You can create a systemd service for the upgrade server as `/etc/systemd/system/npbackup_upgrade_server.service`, see the systemd file in the example directoy.
+
+## Statistics
+
+You can find the CSV file containing statistics, which contain:
+
+- Operation: check_version|get_file_info|download_upgrade
+- IP Address
+- Machine ID as defined in client
+- NPBackup version
+- Machine Group as defined in client
+- Platform
+- Arch