2019-06-10 20:59:46 +02:00
|
|
|
# network_inventory
|
|
|
|
|
|
2020-01-07 18:16:29 +01:00
|
|
|
[](https://travis-ci.com/Nebucatnetzer/network_inventory)
|
|
|
|
|
|
2019-06-10 20:59:46 +02:00
|
|
|
I started this project in order to have solution for keeping an
|
|
|
|
|
inventory over my various servers and other network equipment.
|
|
|
|
|
|
2020-07-04 11:59:51 +02:00
|
|
|
## Production Setup
|
2019-06-10 20:59:46 +02:00
|
|
|
|
|
|
|
|
1. Clone the repository
|
2020-07-04 11:59:51 +02:00
|
|
|
2. Copy the `.env-example` file to `.env` and change the `POSTGRES_PASSWORD`
|
2020-02-15 15:25:54 +01:00
|
|
|
and `DJANGO_SECRET_KEY` variables to something secure.
|
2020-07-04 11:59:51 +02:00
|
|
|
3. Run `docker-compose up` and connect to http://localhost
|
2019-07-13 15:25:32 +02:00
|
|
|
|
2020-07-04 11:59:51 +02:00
|
|
|
### Local Development Setup
|
2020-04-27 22:43:14 +02:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2020-07-04 11:59:51 +02:00
|
|
|
1. Run `make local` to create the virtual environment for development.
|
2019-08-28 21:32:16 +02:00
|
|
|
You're now all set to start developing.
|
2019-06-10 20:59:46 +02:00
|
|
|
|
2020-07-04 11:59:51 +02:00
|
|
|
### Docker Development Setup
|
2020-04-27 22:43:14 +02:00
|
|
|
|
2020-07-04 11:59:51 +02:00
|
|
|
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
|
2020-04-27 22:43:14 +02:00
|
|
|
at http://localhost . You're now all set to start working.
|
2020-07-04 11:59:51 +02:00
|
|
|
2. If you want to have some example data to work with run the command `make
|
|
|
|
|
init` after you successfully run `make`.
|
2019-06-10 20:59:46 +02:00
|
|
|
|
2019-08-28 21:32:16 +02:00
|
|
|
#### 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`.
|
2020-04-27 22:45:40 +02:00
|
|
|
|
|
|
|
|
## 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](./docs/notes.org).
|
