From dad06088348c1a061331eedd000489d3496f2f4f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20M=C3=A4der?= <mail@cimnine.ch>
Date: Tue, 20 Oct 2020 20:11:10 +0200
Subject: [PATCH] Rename example.py to extra.py

And add some comments to the the file that hopefully guide the user.
---
 .gitignore                     |  2 +-
 configuration/configuration.py |  6 ++++
 configuration/example.py       | 49 ------------------------------
 configuration/extra.py         | 55 ++++++++++++++++++++++++++++++++++
 4 files changed, 62 insertions(+), 50 deletions(-)
 delete mode 100644 configuration/example.py
 create mode 100644 configuration/extra.py

diff --git a/.gitignore b/.gitignore
index 22b3cee..8e90907 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,6 @@ docker-compose.override.yml
 *.pem
 configuration/*
 !configuration/configuration.py
-!configuration/example.py
+!configuration/extra.py
 configuration/ldap/*
 !configuration/ldap/ldap_config.py
diff --git a/configuration/configuration.py b/configuration/configuration.py
index 5a9da1e..4d1a146 100644
--- a/configuration/configuration.py
+++ b/configuration/configuration.py
@@ -1,3 +1,9 @@
+####
+## We recommend to not edit this file.
+## Create separate files to overwrite the settings.
+## See `extra.py` as an example.
+####
+
 import re
 
 from os.path import dirname, abspath, join
diff --git a/configuration/example.py b/configuration/example.py
deleted file mode 100644
index df74559..0000000
--- a/configuration/example.py
+++ /dev/null
@@ -1,49 +0,0 @@
-# Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of
-# application errors (assuming correct email settings are provided).
-# ADMINS = [
-#     # ['John Doe', 'jdoe@example.com'],
-# ]
-
-
-# URL schemes that are allowed within links in NetBox
-# ALLOWED_URL_SCHEMES = (
-#     'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
-# )
-
-
-# NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
-# be provided as a dictionary.
-# NAPALM_ARGS = {}
-
-
-# Enable installed plugins. Add the name of each plugin to the list.
-# from netbox.configuration.configuration import PLUGINS
-# PLUGINS.append('my_plugin')
-
-# Plugins configuration settings. These settings are used by various plugins that the user may have installed.
-# Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
-# from netbox.configuration.configuration import PLUGINS_CONFIG
-# PLUGINS_CONFIG['my_plugin'] = {
-#   'foo': 'bar',
-#   'buzz': 'bazz'
-# }
-
-
-# Remote authentication support
-# REMOTE_AUTH_ENABLED = False
-# REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend'
-# REMOTE_AUTH_HEADER = 'HTTP_REMOTE_USER'
-# REMOTE_AUTH_AUTO_CREATE_USER = True
-# REMOTE_AUTH_DEFAULT_GROUPS = []
-# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
-
-
-# By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the
-# class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example:
-# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage'
-# STORAGE_CONFIG = {
-#     'AWS_ACCESS_KEY_ID': 'Key ID',
-#     'AWS_SECRET_ACCESS_KEY': 'Secret',
-#     'AWS_STORAGE_BUCKET_NAME': 'netbox',
-#     'AWS_S3_REGION_NAME': 'eu-west-1',
-# }
diff --git a/configuration/extra.py b/configuration/extra.py
new file mode 100644
index 0000000..46f1877
--- /dev/null
+++ b/configuration/extra.py
@@ -0,0 +1,55 @@
+####
+## This file contains extra configuration options that can't be configured
+## directly through environment variables.
+####
+
+## Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of
+## application errors (assuming correct email settings are provided).
+# ADMINS = [
+#     # ['John Doe', 'jdoe@example.com'],
+# ]
+
+
+## URL schemes that are allowed within links in NetBox
+# ALLOWED_URL_SCHEMES = (
+#     'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp',
+# )
+
+
+## NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must
+## be provided as a dictionary.
+# NAPALM_ARGS = {}
+
+
+## Enable installed plugins. Add the name of each plugin to the list.
+# from netbox.configuration.configuration import PLUGINS
+# PLUGINS.append('my_plugin')
+
+## Plugins configuration settings. These settings are used by various plugins that the user may have installed.
+## Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
+# from netbox.configuration.configuration import PLUGINS_CONFIG
+# PLUGINS_CONFIG['my_plugin'] = {
+#   'foo': 'bar',
+#   'buzz': 'bazz'
+# }
+
+
+## Remote authentication support
+# REMOTE_AUTH_DEFAULT_PERMISSIONS = {}
+
+
+## By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the
+## class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example:
+# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage'
+# STORAGE_CONFIG = {
+#     'AWS_ACCESS_KEY_ID': 'Key ID',
+#     'AWS_SECRET_ACCESS_KEY': 'Secret',
+#     'AWS_STORAGE_BUCKET_NAME': 'netbox',
+#     'AWS_S3_REGION_NAME': 'eu-west-1',
+# }
+
+
+## This file can contain arbitrary Python code, e.g.:
+# from datetime import datetime
+# now = datetime.now().strftime("%d/%m/%Y %H:%M:%S")
+# BANNER_TOP = f'<marquee width="200px">This instance started on {now}.</marquee>'