Updated based on pull request review

bvdberg01 · bvdberg01 · commit 37eeadb0a60c · 2024-11-17T21:12:16.000+01:00
diff --git a/ct/netbox.sh b/ct/netbox.sh
@@ -54,18 +54,26 @@ function default_settings() {
 
 function update_script() {
 header_info
+check_container_storage
+check_container_resources
 if [[ ! -f /opt/netbox/netbox/netbox/configuration.py ]]; then msg_error "No ${APP} Installation Found!"; exit; fi
 RELEASE=$(curl -s https://api.github.com/repos/netbox-community/netbox/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
 if [ ! -d "/opt/netbox-${RELEASE}" ]; then
+
+  msg_info "Stopping ${APP}"
+  systemctl stop netbox netbox-rq
+  msg_ok "Stopped ${APP}"
+
   msg_info "Updating $APP LXC"
   apt-get update &>/dev/null
   apt-get -y upgrade &>/dev/null
   
   OLD_VERSION_PATH=$(ls -d /opt/netbox-*/)
-  wget -q "https://github.com/netbox-community/netbox/archive/refs/tags/v${RELEASE}.tar.gz"
-  tar -xzf "v${RELEASE}.tar.gz" -C /opt
+  cd /opt
+  wget -q "https://github.com/netbox-community/netbox/archive/refs/tags/v${RELEASE}.zip"
+  unzip -q "v${RELEASE}.zip"
   ln -sfn "/opt/netbox-${RELEASE}/" /opt/netbox
-  rm "v${RELEASE}.tar.gz"
+  
   
   cp "${OLD_VERSION_PATH}netbox/netbox/configuration.py" /opt/netbox/netbox/netbox/
   cp -pr "${OLD_VERSION_PATH}netbox/media/" /opt/netbox/netbox/
@@ -81,10 +89,18 @@ if [ ! -d "/opt/netbox-${RELEASE}" ]; then
     cp "${OLD_VERSION_PATH}netbox/netbox/ldap_config.py" /opt/netbox/netbox/netbox/
   fi
 
-  rm -r "${OLD_VERSION_PATH}"
+  
   /opt/netbox/upgrade.sh &>/dev/null
-  systemctl restart --now netbox netbox-rq
-  msg_ok "Updated $APP LXC"
+  msg_ok "Updated $APP successfully"
+
+  msg_info "Starting ${APP}"
+  systemctl start netbox netbox-rq
+  msg_ok "Started ${APP}"
+
+  msg_info "Cleaning up"
+  rm "v${RELEASE}.zip"
+  rm -rf "${OLD_VERSION_PATH}"
+  msg_ok "Cleaned"
 else
   msg_ok "No update required. ${APP} is already at ${RELEASE}"
 fi
diff --git a/install/netbox-install.sh b/install/netbox-install.sh
@@ -15,23 +15,24 @@ update_os
 
 msg_info "Installing Dependencies"
 $STD apt-get update
-$STD apt-get install -y curl
-$STD apt-get install -y sudo
-$STD apt-get install -y mc
-$STD apt-get install -y apache2
-$STD apt-get install -y redis-server
-$STD apt-get install -y postgresql
-$STD apt-get install -y python3
-$STD apt-get install -y python3-pip
-$STD apt-get install -y python3-venv
-$STD apt-get install -y python3-dev
-$STD apt-get install -y build-essential
-$STD apt-get install -y libxml2-dev
-$STD apt-get install -y libxslt1-dev
-$STD apt-get install -y libffi-dev
-$STD apt-get install -y libpq-dev
-$STD apt-get install -y libssl-dev
-$STD apt-get install -y zlib1g-dev
+$STD apt-get install -y \
+  curl \
+  sudo \
+  mc \
+  apache2 \
+  redis-server \
+  postgresql \
+  python3 \
+  python3-pip \
+  python3-venv \
+  python3-dev \
+  build-essential \
+  libxml2-dev \
+  libxslt1-dev \
+  libffi-dev \
+  libpq-dev \
+  libssl-dev \
+  zlib1g-dev
 msg_ok "Installed Dependencies"
 
 msg_info "Setting up PostgreSQL"
@@ -42,32 +43,32 @@ $STD sudo -u postgres psql -c "CREATE ROLE $DB_USER WITH LOGIN PASSWORD '$DB_PAS
 $STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME WITH OWNER $DB_USER TEMPLATE template0;"
 msg_ok "Set up PostgreSQL"
 
-msg_info "Installing NetBox"        
+msg_info "Installing NetBox"
+cd /opt
 RELEASE=$(curl -s https://api.github.com/repos/netbox-community/netbox/releases/latest | grep "tag_name" | awk '{print substr($2, 3, length($2)-4) }')
-wget -q "https://github.com/netbox-community/netbox/archive/refs/tags/v${RELEASE}.tar.gz"
-tar -xzf "v${RELEASE}.tar.gz" -C /opt
+wget -q "https://github.com/netbox-community/netbox/archive/refs/tags/v${RELEASE}.zip"
+unzip -q "v${RELEASE}.zip"
 ln -s "/opt/netbox-${RELEASE}/" /opt/netbox
-rm "v${RELEASE}.tar.gz"
 
 $STD adduser --system --group netbox
 chown --recursive netbox /opt/netbox/netbox/media/
 chown --recursive netbox /opt/netbox/netbox/reports/
 chown --recursive netbox /opt/netbox/netbox/scripts/
 
-cp /opt/netbox/netbox/netbox/configuration_example.py /opt/netbox/netbox/netbox/configuration.py
+mv /opt/netbox/netbox/netbox/configuration_example.py /opt/netbox/netbox/netbox/configuration.py
 
-secret=$(python3 /opt/netbox/netbox/generate_secret_key.py)
-escaped_secret=$(printf '%s\n' "$secret" | sed 's/[&/\]/\\&/g')
+SECRET_KEY=$(python3 /opt/netbox/netbox/generate_secret_key.py)
+ESCAPED_SECRET_KEY=$(printf '%s\n' "$SECRET_KEY" | sed 's/[&/\]/\\&/g')
 
 sed -i 's/ALLOWED_HOSTS = \[\]/ALLOWED_HOSTS = ["*"]/' /opt/netbox/netbox/netbox/configuration.py
-sed -i "s|SECRET_KEY = ''|SECRET_KEY = '${escaped_secret}'|" /opt/netbox/netbox/netbox/configuration.py
+sed -i "s|SECRET_KEY = ''|SECRET_KEY = '${ESCAPED_SECRET_KEY}'|" /opt/netbox/netbox/netbox/configuration.py
 sed -i "/DATABASE = {/,/}/s/'USER': '[^']*'/'USER': '$DB_USER'/" /opt/netbox/netbox/netbox/configuration.py
 sed -i "/DATABASE = {/,/}/s/'PASSWORD': '[^']*'/'PASSWORD': '$DB_PASS'/" /opt/netbox/netbox/netbox/configuration.py
 
 $STD /opt/netbox/upgrade.sh &>/dev/null
-sudo ln -s /opt/netbox/contrib/netbox-housekeeping.sh /etc/cron.daily/netbox-housekeeping
+ln -s /opt/netbox/contrib/netbox-housekeeping.sh /etc/cron.daily/netbox-housekeeping
 
-sudo cp /opt/netbox/contrib/apache.conf /etc/apache2/sites-available/netbox.conf
+mv /opt/netbox/contrib/apache.conf /etc/apache2/sites-available/netbox.conf
 openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/ssl/private/netbox.key -out /etc/ssl/certs/netbox.crt -subj "/C=US/O=NetBox/OU=Certificate/CN=localhost" &>/dev/null
 $STD a2enmod ssl proxy proxy_http headers rewrite
 $STD a2ensite netbox
@@ -81,29 +82,37 @@ systemctl enable -q --now netbox netbox-rq
 msg_ok "Installed NetBox"
 
 msg_info "Setting up Django Admin"
-NetBox_USER=Admin
-NetBox_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13)
+DJANGO_USER=Admin
+DJANGO_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13)
 
 source /opt/netbox/venv/bin/activate
 $STD python3 /opt/netbox/netbox/manage.py shell << EOF
 from django.contrib.auth import get_user_model
 UserModel = get_user_model()
-user = UserModel.objects.create_user('$NetBox_USER', password='$NetBox_PASS')
+user = UserModel.objects.create_user('$DJANGO_USER', password='$DJANGO_PASS')
 user.is_superuser = True
 user.is_staff = True
 user.save()
 EOF
 msg_ok "Setup Django Admin"
 
 msg_info "Save credential file"
-echo "" >~/NetBox.creds
-echo "NetBox Database Credentials" >>~/NetBox.creds
-echo "" >>~/NetBox.creds
-echo -e "NetBox Database User: \e[32m$DB_USER\e[0m" >>~/NetBox.creds
-echo -e "NetBox Database Password: \e[32m$DB_PASS\e[0m" >>~/NetBox.creds
-echo -e "NetBox Database Name: \e[32m$DB_NAME\e[0m" >>~/NetBox.creds
-echo -e "NetBox Admin user: \e[32m$NetBox_USER\e[0m" >>~/NetBox.creds
-echo -e "NetBox Admin Password: \e[32m$NetBox_PASS\e[0m" >>~/NetBox.creds
+# PSQL:
+{
+echo "Netbox-Credentials"
+echo -e "Netbox Database User: \e[32m$DB_USER\e[0m"
+echo -e "Netbox Database Password: \e[32m$DB_PASS\e[0m"
+echo -e "Netbox Database Name: \e[32m$DB_NAME\e[0m"
+echo -e "Netbox Secret: \e[32m$SECRET_KEY\e[0m"
+} >> ~/netbox.creds
+
+# DJANGO:
+{
+echo ""
+echo "Netbox-Django-Credentials"
+echo -e "Django User: \e[32m$DJANGO_USER\e[0m"
+echo -e "Django Password: \e[32m$DJANGO_PASS\e[0m"
+} >> ~/netbox.creds
 msg_ok "Save cred file"
 
 motd_ssh
@@ -112,4 +121,5 @@ customize
 msg_info "Cleaning up"
 $STD apt-get -y autoremove
 $STD apt-get -y autoclean
+rm "/opt/v${RELEASE}.zip"
 msg_ok "Cleaned"
diff --git a/json/netbox.json b/json/netbox.json
@@ -11,7 +11,7 @@
     "interface_port": "443",
     "documentation": "https://netboxlabs.com/docs/netbox/en/stable/",
     "website": "https://github.com/netbox-community/netbox",
-    "logo": "https://netboxlabs.com/wp-content/uploads/2023/10/logo_netboxlabs_bright_teal.svg",
+    "logo": "https://github.com/netbox-community/netbox/wiki/images/logos/netbox_icon.svg",
     "description": "NetBox is the source of truth for everything on your network, from physical components like power systems and cabling to virtual assets like IP addresses and VLANs. Network automation and observability tools depend on NetBox’s authoritative data to roll out configurations, monitor changes, and accelerate operations across the enterprise",
     "install_methods": [
         {
@@ -28,11 +28,11 @@
     ],
     "default_credentials": {
         "username": "Admin",
-        "password": "See output: cat NetBox.creds"
+        "password": "See output: cat netbox.creds"
     },
     "notes": [
         {
-            "text": "Generated database & admin credentials see output: `cat NetBox.creds`",
+            "text": "Generated database & admin credentials see output: `cat netbox.creds`",
             "type": "warning"
         }
     ]

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`"interface_port": "443",`
`12`	`12`	`"documentation": "https://netboxlabs.com/docs/netbox/en/stable/",`
`13`	`13`	`"website": "https://github.com/netbox-community/netbox",`
`14`		`- "logo": "https://netboxlabs.com/wp-content/uploads/2023/10/logo_netboxlabs_bright_teal.svg",`
	`14`	`+ "logo": "https://github.com/netbox-community/netbox/wiki/images/logos/netbox_icon.svg",`
`15`	`15`	`"description": "NetBox is the source of truth for everything on your network, from physical components like power systems and cabling to virtual assets like IP addresses and VLANs. Network automation and observability tools depend on NetBox’s authoritative data to roll out configurations, monitor changes, and accelerate operations across the enterprise",`
`16`	`16`	`"install_methods": [`
`17`	`17`	`{`
`@@ -28,11 +28,11 @@`
`28`	`28`	`],`
`29`	`29`	`"default_credentials": {`
`30`	`30`	`"username": "Admin",`
`31`		`- "password": "See output: cat NetBox.creds"`
	`31`	`+ "password": "See output: cat netbox.creds"`
`32`	`32`	`},`
`33`	`33`	`"notes": [`
`34`	`34`	`{`
`35`		- "text": "Generated database & admin credentials see output: `cat NetBox.creds`",
	`35`	+ "text": "Generated database & admin credentials see output: `cat netbox.creds`",
`36`	`36`	`"type": "warning"`
`37`	`37`	`}`
`38`	`38`	`]`