Nebucatnetzer
/
network_inventory
mirror of https://github.com/Nebucatnetzer/network_inventory.git
1
0
Fork 0
Code Issues Releases Wiki Activity
996 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 5374df4231 backend: add a missing comma 2021-02-08 10:55:20 +01:00
.vscode update the vscode settings for the new django path 2020-11-28 16:18:37 +01:00
backend backend: add a missing comma 2021-02-08 10:55:20 +01:00
docs update the todos 2020-07-05 14:07:46 +02:00
frontend add some CSS to the customers table 2021-01-26 22:34:39 +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
.gitignore move django into the backend folder 2020-11-28 16:12:06 +01:00
.gitlab-ci.yml try a hack 2020-07-17 17:12:29 +02:00
.travis.yml limit test runs to master and pull requests 2020-07-07 22:21:32 +02:00
LICENSE Initial commit 2017-12-21 23:11:33 +01:00
Makefile update the config for pytest-cov 2020-11-30 19:16:06 +01:00
README.md update the todos 2020-07-05 14:07:46 +02:00
docker-compose-development.yml change the frontend port 2021-01-26 22:16:49 +01:00
docker-compose.yml add a Docker development setup for Vue 2020-12-07 19:58:09 +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.

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.