Nebucatnetzer
/
network_inventory
mirror of https://github.com/Nebucatnetzer/network_inventory.git
1
0
Fork 0
Code Issues Releases Wiki Activity
840 Commits 10 Branches 4 Tags 9.4 MiB
CSS 51.7%
Python 34.4%
HTML 8.7%
JavaScript 3.2%
Nix 1.1%
Other 0.9%
Go to file
Andreas Zweili e3689f6d16 add a Manufacturer detail view 2020-06-08 21:09:05 +02:00
.vscode use 4 cpu core when running tests with vscode 2020-04-20 15:55:50 +02:00
backups show all models in the admin interface 2020-06-08 17:02:15 +02:00
computers Merge branch 'master' into clean-out-computer-forms 2020-06-08 17:03:46 +02:00
core move the description field to the base Company model 2020-06-08 21:07:40 +02:00
customers move the description field to the base Company model 2020-06-08 21:07:40 +02:00
devices add a Manufacturer detail view 2020-06-08 21:09:05 +02:00
docs extend notes 2020-06-08 17:05:57 +02:00
licenses show all models in the admin interface 2020-06-08 17:02:15 +02:00
nets show all models in the admin interface 2020-06-08 17:02:15 +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 remove django-bootstrap4 2020-02-28 17:32:25 +01:00
softwares show all models in the admin interface 2020-06-08 17:02:15 +02:00
users show all models in the admin interface 2020-06-08 17:02:15 +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 copy the .env file before building the container 2020-02-15 15:21:39 +01:00
Dockerfile split the requirements and settings 2019-07-13 12:37:58 +02:00
LICENSE Initial commit 2017-12-21 23:11:33 +01:00
Makefile Merge branch 'master' into clean-out-computer-forms 2020-06-08 17:03:46 +02:00
README.md add a link to the notes file 2020-04-27 22:45:40 +02:00
conftest.py remove the names of some overly large capitalists 2020-03-15 19:54:43 +01:00
development.sh collect static files at the first run 2020-03-20 12:00:37 +01:00
docker-compose.yml clean out the docker-compose file 2020-05-26 23:23:50 +02:00
manage.py restructure the project 2020-01-07 18:10:57 +01:00
pytest.ini set junit_family to the new xunit2 2020-04-21 18:51:50 +02:00
run.sh collect static files at the first run 2020-03-20 12:00:37 +01: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.

Setup

  1. Clone the repository
  2. Now decide if you want to develop fully locally or inside the docker container. Locally you'll use SQlite for the database and inside the Docker container you'll use Postgres for the database. For the moment there aren't any features implemented which require Postgres. However this might change in the future and SQlite is not supported for production.
  3. Copy the .env-example file to .env and change the POSTGRES_PASSWORD and DJANGO_SECRET_KEY variables to something secure.

Local 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 Setup

  1. Run make to start the production server. You can access it at http://localhost . You're now all set to start working.
  2. If you want to develop with the Docker setup change the run command in the docker-compose.yml from run.sh to development.sh

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, tasks and other related information in the Notes file.