#212: Introduced BASE_PATH configuration setting

docs/configuration/optional-settings.md

@@ -26,6 +26,18 @@ BANNER_BOTTOM = BANNER_TOP
 
 ---
 
+## BASE_PATH
+
+Default: None
+
+The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at http://example.com/netbox/, set:
+
+```
+BASE_PATH = 'netbox/'
+```
+
+---
+
 ## DEBUG
 
 Default: False

netbox/netbox/configuration.docker.py

@@ -52,6 +52,10 @@ EMAIL = {
 # are permitted to access most data in NetBox (excluding secrets) but not make any changes.
 LOGIN_REQUIRED = os.environ.get('LOGIN_REQUIRED', False)
 
+# Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
+# BASE_PATH = 'netbox/'
+BASE_PATH = os.environ.get('BASE_PATH', '')
+
 # Setting this to True will display a "maintenance mode" banner at the top of every page.
 MAINTENANCE_MODE = os.environ.get('MAINTENANCE_MODE', False)
 

netbox/netbox/configuration.example.py

@@ -52,6 +52,10 @@ EMAIL = {
 # are permitted to access most data in NetBox (excluding secrets) but not make any changes.
 LOGIN_REQUIRED = False
 
+# Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
+# BASE_PATH = 'netbox/'
+BASE_PATH = ''
+
 # Setting this to True will display a "maintenance mode" banner at the top of every page.
 MAINTENANCE_MODE = False
 

netbox/netbox/settings.py

@@ -27,6 +27,9 @@ ADMINS = getattr(configuration, 'ADMINS', [])
 DEBUG = getattr(configuration, 'DEBUG', False)
 EMAIL = getattr(configuration, 'EMAIL', {})
 LOGIN_REQUIRED = getattr(configuration, 'LOGIN_REQUIRED', False)
+BASE_PATH = getattr(configuration, 'BASE_PATH', '')
+if BASE_PATH:
+    BASE_PATH = BASE_PATH.strip('/') + '/'  # Enforce trailing slash only
 MAINTENANCE_MODE = getattr(configuration, 'MAINTENANCE_MODE', False)
 PAGINATE_COUNT = getattr(configuration, 'PAGINATE_COUNT', 50)
 NETBOX_USERNAME = getattr(configuration, 'NETBOX_USERNAME', '')

netbox/netbox/urls.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.conf.urls import include, url
 from django.contrib import admin
 from django.views.defaults import page_not_found
@@ -10,6 +11,8 @@ handler500 = handle_500
 
 urlpatterns = [
 
+    url(r'^{}'.format(settings.BASE_PATH), include([
+
         # Default page
         url(r'^$', home, name='home'),
 
@@ -41,4 +44,6 @@ urlpatterns = [
         # Admin
         url(r'^admin/', include(admin.site.urls)),
 
+    ]))
+
 ]

netbox/templates/500.html

@@ -26,7 +26,7 @@
                     <pre><strong>{{ exception }}</strong><br />
 {{ error }}</pre>
                     <div class="text-right">
-                        <a href="/" class="btn btn-primary">Home Page</a>
+                        <a href="{% url 'home' %}" class="btn btn-primary">Home Page</a>
                     </div>
                 </div>
             </div>

netbox/templates/_base.html

@@ -21,7 +21,7 @@
                     <span class="icon-bar"></span>
                     <span class="icon-bar"></span>
                 </button>
-                <a class="navbar-brand" href="/">
+                <a class="navbar-brand" href="{% url 'home' %}">
                     <img src="{% static 'img/netbox_logo.png' %}" />
                 </a>
             </div>
@@ -289,7 +289,7 @@
                 <div class="col-xs-4 text-right">
                     <p class="text-muted">
                         <i class="fa fa-fw fa-book text-primary"></i> <a href="http://netbox.readthedocs.io/" target="_blank">Docs</a> &middot;
-                        <i class="fa fa-fw fa-cloud text-primary"></i> <a href="/api/docs/">API</a> &middot;
+                        <i class="fa fa-fw fa-cloud text-primary"></i> <a href="{% url 'django.swagger.base.view' %}">API</a> &middot;
                         <i class="fa fa-fw fa-code text-primary"></i> <a href="https://github.com/digitalocean/netbox">Code</a>
                     </p>
                 </div>

netbox/templates/dcim/device.html

@@ -545,13 +545,13 @@ function toggleConnection(elem, api_url) {
     return false;
 }
 $(".consoleport-toggle").click(function() {
-    return toggleConnection($(this), "/api/dcim/console-ports/");
+    return toggleConnection($(this), "/{{ settings.BASE_PATH }}api/dcim/console-ports/");
 });
 $(".powerport-toggle").click(function() {
-    return toggleConnection($(this), "/api/dcim/power-ports/");
+    return toggleConnection($(this), "/{{ settings.BASE_PATH }}api/dcim/power-ports/");
 });
 $(".interface-toggle").click(function() {
-    return toggleConnection($(this), "/api/dcim/interface-connections/");
+    return toggleConnection($(this), "/{{ settings.BASE_PATH }}api/dcim/interface-connections/");
 });
 </script>
 <script src="{% static 'js/graphs.js' %}"></script>