mirror of
https://github.com/netbox-community/netbox-docker.git
synced 2024-11-07 16:44:02 +01:00
77 lines
2.1 KiB
Markdown
77 lines
2.1 KiB
Markdown
# netbox-docker
|
||
|
||
This repository houses the components needed to build NetBox as a Docker container.
|
||
Images built using this code are released to [Docker Hub](https://hub.docker.com/r/ninech/netbox) every night.
|
||
|
||
## Quickstart
|
||
|
||
To get NetBox up and running:
|
||
|
||
```
|
||
$ git clone -b master https://github.com/ninech/netbox-docker.git
|
||
$ cd netbox-docker
|
||
$ docker-compose up -d
|
||
```
|
||
|
||
The application will be available after a few minutes.
|
||
Use `docker-compose port nginx 80` to find out where to connect to.
|
||
|
||
```
|
||
$ echo "http://$(docker-compose port nginx 80)/"
|
||
http://0.0.0.0:32768/
|
||
|
||
# Open netbox in your default browser on macOS:
|
||
$ open "http://$(docker-compose port nginx 80)/"
|
||
|
||
# Open netbox in your default browser on (most) linuxes:
|
||
$ xdg-open "http://$(docker-compose port nginx 80)/" &>/dev/null &
|
||
```
|
||
|
||
Default credentials:
|
||
|
||
* Username: **admin**
|
||
* Password: **admin**
|
||
|
||
## Configuration
|
||
|
||
You can configure the app using environment variables. These are defined in `netbox.env`.
|
||
|
||
## Rebuilding & Publishing images
|
||
|
||
`./build.sh` is used to rebuild the Docker image:
|
||
|
||
```
|
||
$ ./build.sh --help
|
||
Usage: ./build.sh <branch> [--push]
|
||
branch The branch or tag to build. Required.
|
||
--push Pushes built Docker image to docker hub.
|
||
|
||
You can use the following ENV variables to customize the build:
|
||
BRANCH The branch to build.
|
||
Also used for tagging the image.
|
||
DOCKER_REPO The Docker registry (i.e. hub.docker.com/r/DOCKER_REPO/netbox)
|
||
Also used for tagging the image.
|
||
Default: ninech
|
||
SRC_REPO Which fork of netbox to use (i.e. github.com/<SRC_REPO>/netbox).
|
||
Default: digitalocean
|
||
URL Where to fetch the package from.
|
||
Must be a tar.gz file of the source code.
|
||
Default: https://github.com/${SRC_REPO}/netbox/archive/$BRANCH.tar.gz
|
||
```
|
||
|
||
## Tests
|
||
|
||
To run the bundled test, use the `docker-compose.test.yml` file.
|
||
|
||
```
|
||
$ docker-compose -f docker-compose.test.yml run --rm app
|
||
```
|
||
|
||
## About
|
||
|
||
This repository is currently maintained by [nine.ch](https://nine.ch).
|
||
|
||
[](https://nine.ch)
|
||
|
||
We run your Linux server infrastructure – without interruptions, around the clock.
|