From 14f7cf88396f8a2870b4edfdb12f9b8448ac48b8 Mon Sep 17 00:00:00 2001
From: Matthias Stecher <matthiasstecher@gmx.de>
Date: Sun, 4 Oct 2020 17:40:01 +0200
Subject: [PATCH] __netbox: set --data-root default value

The default value is set to preserve all data saved by netbox. As
explained in the manpage, it sets the directory for all data directories
to `~netbox/data/` (would resolve to `/opt/netbox/data/`), so upgrades
will not remove this data.
---
 type/__netbox/man.rst                     | 17 ++++++++++-------
 type/__netbox/manifest                    | 11 +++++------
 type/__netbox/parameter/default/data-root |  1 +
 3 files changed, 16 insertions(+), 13 deletions(-)
 create mode 100644 type/__netbox/parameter/default/data-root

diff --git a/type/__netbox/man.rst b/type/__netbox/man.rst
index 3330b1b..6d50268 100644
--- a/type/__netbox/man.rst
+++ b/type/__netbox/man.rst
@@ -131,7 +131,7 @@ data-root
     This parameter set's the media, reports and scripts root to subdirectories
     of the given directory. Values can be overwritten by special parameters like
     `--media-root` for example. Use this option if you want to store persistant
-    data of netbox on an other partition. A trailing shlash is not needed.
+    data of netbox on an other partition. A trailing slash is not needed.
 
     The data directories have following predefined sub-directory names:
 
@@ -142,23 +142,26 @@ data-root
     scripts root:
         ``$data_root/scripts``
 
+    To preserve all data from installation upgrades - which just replace the
+    installation directory - the data will be kept in the netbox home directory
+    rather than the installation directory by default (``/opt/netbox/data/``).
+    This way, no data will be deleted after the installation directory
+    replacement because it remains outside of the installation directory.
+
 media-root
     The file path to where media files (like image attachments) are stored.
     Change this path if you require to store data on an other partiotion.
-    A trailing slash is not needed. By default, it will be stored into the
-    installation directory (``/opt/netbox/netbox/netbox/media``).
+    A trailing slash is not needed. Defaults to ``$data_root/media``.
 
 reports-root
     The file path of where custom reports are kept. Change this path if you
     require to store data on an other partition. A trailing slash is not
-    needed. By default, it will be stored into the installation directory
-    (``/opt/netbox/netbox/netbox/reports``).
+    needed. Defaults to ``$data_root/reports``.
 
 scripts-root
     The file path of where custom scripts are kept. Change this path if you
     require to store data on an other partition. A trailing slash is not
-    needed. By default, it will be stored into the installation directory
-    (``/opt/netbox/netbox/netbox/scripts``).
+    needed. Defaults to ``$data_root/scripts``.
 
 
 BOOLEAN PARAMETERS
diff --git a/type/__netbox/manifest b/type/__netbox/manifest
index 89b89ac..fbcf253 100755
--- a/type/__netbox/manifest
+++ b/type/__netbox/manifest
@@ -161,12 +161,11 @@ else
 fi
 export LOGIN_REQUIRED
 
-if [ -f "$__object/parameter/data-root" ]; then
-    data_root="$(cat "$__object/parameter/data-root")"
-    MEDIA_ROOT="$data_root/media"
-    REPORTS_ROOT="$data_root/reports"
-    SCRIPTS_ROOT="$data_root/scripts"
-fi
+data_root="$(cat "$__object/parameter/data-root")"
+MEDIA_ROOT="$data_root/media"
+REPORTS_ROOT="$data_root/reports"
+SCRIPTS_ROOT="$data_root/scripts"
+
 if [ -f "$__object/parameter/media-root" ]; then
     MEDIA_ROOT="$(cat "$__object/parameter/media-root")"
 fi
diff --git a/type/__netbox/parameter/default/data-root b/type/__netbox/parameter/default/data-root
new file mode 100644
index 0000000..45faab0
--- /dev/null
+++ b/type/__netbox/parameter/default/data-root
@@ -0,0 +1 @@
+/opt/netbox/data