diff --git a/docs/configuration.md b/docs/configuration.md index a5c6ae411..3ab1cd9ce 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -8,7 +8,7 @@ NetBox's local configuration is held in `netbox/netbox/configuration.py`. An exa #### ALLOWED_HOSTS -This is a list of valid host names by which NetBox may be reached. This list is used to defend against cross-site scripting (XSS) attacks. You must specify at least one host name. +This is a list of valid fully-qualified domain names (FQDNs) for the NetBox server. NetBox will not permit write access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name. Example: diff --git a/netbox/netbox/configuration.example.py b/netbox/netbox/configuration.example.py index 4f11420ce..8907cd972 100644 --- a/netbox/netbox/configuration.example.py +++ b/netbox/netbox/configuration.example.py @@ -4,8 +4,10 @@ # # ######################### -# Set this to your server's FQDN. This is required when DEBUG = False. -# E.g. ALLOWED_HOSTS = ['netbox.yourdomain.com'] +# This is a list of valid fully-qualified domain names (FQDNs) for the NetBox server. NetBox will not permit write +# access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name. +# +# Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local'] ALLOWED_HOSTS = [] # PostgreSQL database configuration. @@ -30,8 +32,8 @@ SECRET_KEY = '' # # ######################### -# Specify one or more name and email email address tuples representing NetBox administrators. These people will be -# notified of application errors (assuming correct email settings are provided). +# 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'], ]