Go to file
Andreas Zweili 9800126def
limit test runs to master and pull requests
2020-07-07 22:21:32 +02:00
.vscode use 4 cpu core when running tests with vscode 2020-04-20 15:55:50 +02:00
backups extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
computers add create and delete views for RAIDs 2020-06-29 22:43:39 +02:00
core extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
customers extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
devices extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
docs update the todos 2020-07-05 14:07:46 +02:00
licenses extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
nets extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
network_inventory correct the static files setup 2020-04-20 15:22:48 +02:00
nginx add a nginx container as a reverse proxy 2020-02-15 17:58:16 +01:00
requirements update django to 2.2.13 2020-06-15 22:55:17 +02:00
softwares extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
users extend the models with 'ordering' 2020-07-07 22:12:57 +02:00
.coveragerc ignore the admin views in te coverage report 2020-03-01 12:42:59 +01:00
.dir-locals.el add the pytest options to the dir-locals 2020-05-01 12:49:05 +02:00
.env-example disable debugging mode in the example .env file 2020-02-15 15:25:36 +01:00
.flake8 reformat the flake8 config 2020-03-01 12:42:43 +01:00
.gitignore correct the static files setup 2020-04-20 15:22:48 +02:00
.travis.yml limit test runs to master and pull requests 2020-07-07 22:21:32 +02:00
Dockerfile add CMD to Dockerfile 2020-07-04 11:54:55 +02:00
LICENSE Initial commit 2017-12-21 23:11:33 +01:00
Makefile correct the order of the clean commands 2020-07-04 13:00:34 +02:00
README.md update the todos 2020-07-05 14:07:46 +02:00
conftest.py remove the names of some overly large capitalists 2020-03-15 19:54:43 +01:00
docker-compose-development.yml remove the port mapping from the web app 2020-07-04 13:49:52 +02:00
docker-compose.yml remove the port mapping from the web app 2020-07-04 13:49:52 +02:00
manage.py restructure the project 2020-01-07 18:10:57 +01:00
network_inventory.yaml clean out the test data fixture 2020-06-15 19:51:34 +02:00
pytest.ini set junit_family to the new xunit2 2020-04-21 18:51:50 +02:00
run.sh create the second_run file inside the container 2020-07-04 12:12:42 +02:00

README.md

network_inventory

Build Status

I started this project in order to have solution for keeping an inventory over my various servers and other network equipment.

Production Setup

  1. Clone the repository
  2. Copy the .env-example file to .env and change the POSTGRES_PASSWORD and DJANGO_SECRET_KEY variables to something secure.
  3. Run docker-compose up and connect to http://localhost

Local Development Setup

The local setup is mainly intended to run the tests quickly. I recommend that you use the Docker setup if you want to interact with the website.

  1. Run make local to create the virtual environment for development. You're now all set to start developing.

Docker Development Setup

This is very similar to the production setup with the difference that the image for the web application gets built locally instead of getting pulled from Dockerhub.

  1. Run make to start the server. You can access it at http://localhost . You're now all set to start working.
  2. If you want to have some example data to work with run the command make init after you successfully run make.

Environment Variables

To customise the application in the Docker container you can use environment variables in the docker-compose.yml file. Currently the following variables are supported.

  • DJANGO_SECRET_KEY the secret key is mandatory, otherwise the application doesn't run. Make sure that it is some long random string.
  • DJANGO_DEBUG settings this variable to any value enables the Django debug mode. Make sure that you don't set it on a production server.
  • DJANGO_SETTINGS_MODULE the path to the settings file to use in the container. This requires a dotet syntax. The default is network_inventory.settings.docker.

Documentation

Currently there isn't a lot of documentation present. I try to document my thoughts and other related information in the Notes file.