62 lines
1.2 KiB
Markdown
62 lines
1.2 KiB
Markdown
# netbox-docker
|
|
|
|
This repository houses the components needed to build NetBox as a Docker container. It is a work in progress; please submit a bug report for any issues you encounter.
|
|
|
|
## Quickstart
|
|
|
|
To get NetBox up and running:
|
|
|
|
```
|
|
# git clone -b master https://github.com/digitalocean/netbox-docker.git
|
|
# cd netbox-docker
|
|
# docker-compose up -d
|
|
```
|
|
|
|
The application will be available on http://localhost/ after a few minutes.
|
|
|
|
Default credentials:
|
|
|
|
* Username: **admin**
|
|
* Password: **admin**
|
|
|
|
## Configuration
|
|
|
|
You can configure the app at runtime using variables (see `docker-compose.yml`). Possible environment variables include:
|
|
|
|
* SUPERUSER_NAME
|
|
* SUPERUSER_EMAIL
|
|
* SUPERUSER_PASSWORD
|
|
* ALLOWED_HOSTS
|
|
* DB_NAME
|
|
* DB_USER
|
|
* DB_PASSWORD
|
|
* DB_HOST
|
|
* DB_PORT
|
|
* SECRET_KEY
|
|
* EMAIL_SERVER
|
|
* EMAIL_PORT
|
|
* EMAIL_USERNAME
|
|
* EMAIL_PASSWORD
|
|
* EMAIL_TIMEOUT
|
|
* EMAIL_FROM
|
|
* LOGIN_REQUIRED
|
|
* MAINTENANCE_MODE
|
|
* NETBOX_USERNAME
|
|
* NETBOX_PASSWORD
|
|
* PAGINATE_COUNT
|
|
* TIME_ZONE
|
|
* DATE_FORMAT
|
|
* SHORT_DATE_FORMAT
|
|
* TIME_FORMAT
|
|
* SHORT_TIME_FORMAT
|
|
* DATETIME_FORMAT
|
|
* SHORT_DATETIME_FORMAT
|
|
|
|
## Tests
|
|
|
|
To run the bundled test, use the `docker-compose.test.yml` file.
|
|
|
|
```
|
|
# docker-compose -f docker-compose.test.yml run --rm app
|
|
```
|