The NetDash project's goal is to create an interface to allow delegation of specific IT infrastructure management tasks to IT teams outside of a central IT team.

By default NetDash is configured to use the netdash.settings module. This module corresponds to the file: "src/netdash/netdash/settings.py" which is ignored in .gitignore, so isn't provided with the source. To configure the settings, copy one of the *_example_* files in the "src/netdash/netdash/" directory to the settings.py file. Or set the DJANGO_SETTINGS_MODULE environment variable to use one of the provided examples or a custom settings module.

For example:

• cp src/netdash/netdash/settings_example.py src/netdash/netdash/settings.py will copy the example settings to the default location. You can modify after copying.
• export DJANGO_SETTINGS_MODULE=netdash.settings_example_compose will configure NetDash to use settings suitable for the Docker Compose setup.
• export DJANGO_SETTINGS_MODULE=netdash.settings_env will configure NetDash to use settings that will pull values from the environment. This is suitable for a Kuberbetes or OpenShift deployment.

1. Clone this repository.
2. Change to the new directory: cd netdash
3. export DJANGO_SETTINGS_MODULE=netdash.settings_env (or see the Configuration section above).
4. Start the services: docker-compose up

This will spin up a few services:

• NetDash instance (served at 127.0.0.1:8888)
• NetBox instance (served at 127.0.0.1:8000)
• Databases for both

The netdash.settings_example_compose module configures the NetDash instance is configured by default to use the NetBox instance as its backend.

1. Clone this repository.
2. Change to the new directory: cd netdash
3. Create an environment with the development dependencies: pipenv install -d
4. Configure sample settings (see the Configuration section above).
5. Run the development server: pipenv run python3 src/netdash/manage.py runserver
6. Connect to the development server interface: http://127.0.0.1:8000/

1. Clone this repository.
2. Change to the new directory: cd netdash
3. Create a virtualenv: python3 -m venv venv
4. Activate the environment: source ./venv/bin/activate
5. Install the package in editable mode: pip install -e .
6. Configure sample settings (see the Configuration section above).
7. Change to the project directory: cd src/netdash
8. Run the migrations: python3 manage.py migrate
9. Create an admin user: python3 manage.py createsuperuser
10. Run the development server: python3 manage.py runserver
11. Connect to the development server interface: http://127.0.0.1:8000/

• A module with urls.py should declare an app_name.
• A module with urls.py will have its URLs placed under /<app_name>/*.
• A module with a url named index in its urls.py will have a link to index generated in the NetDash navbar.
• A module that generates a permission named can_view_module will only generate an index link in the NetDash navbar for users who have that permission.
• A module with api/urls.py should declare an app_name. If the module also has a urls.py, it should reuse the previous app_name like so: <app_name>-api
• A module with api/urls.py will have its API URLs placed under /api/<app_name>/*.

Check under apps_dev for examples of the afforementioned conventions.