extern/netbox-docker
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox-docker.git synced 2025-06-08 11:06:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Getting Started (markdown)

Ryan Merolle 2022-01-18 11:46:09 -05:00
parent 0f26910a05
commit e3b4bf0d96
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Getting-Started.md

@ -1,6 +1,6 @@
# Getting Started with Netbox Docker # Getting Started with NetBox Docker
This is a basic introduction on how to get started using Netbox with Docker on your local machine. This is a basic introduction on how to get started using NetBox with Docker on your local machine.
## Requirements ## Requirements
@ -10,7 +10,7 @@ It is required that you have a recent installation of _Docker Community Edition_
You also need to have [`Git` installed][git]. You also need to have [`Git` installed][git].
And finally you should be working on a Linux or macOS computer. And finally you should be working on a Linux or macOS computer.
Netbox Docker should technically also work on _Docker for Windows_ (with Linux backend) or on the _Windows Subsystem for Linux (WSL)_, but this guide does not cover this (yet). NetBox Docker should technically also work on _Docker for Windows_ (with Linux backend) or on the _Windows Subsystem for Linux (WSL)_, but this guide does not cover this (yet).
[dependencies]: https://github.com/netbox-community/netbox-docker#dependencies [dependencies]: https://github.com/netbox-community/netbox-docker#dependencies
[git]: https://git-scm.com/downloads [git]: https://git-scm.com/downloads
@ -35,7 +35,7 @@ git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker cd netbox-docker
``` ```
Now you need to create a new file which defines the port under which Netbox will be available. Now you need to create a new file which defines the port under which NetBox will be available.
The file's name must be `docker-compose.override.yml` and it's content should be as follows: The file's name must be `docker-compose.override.yml` and it's content should be as follows:
```yaml ```yaml
@ -55,11 +55,11 @@ services:
- 8000:8080 - 8000:8080
``` ```
This file will define that Netbox Docker will always listen on port `8000` when it starts up. This file will define that NetBox Docker will always listen on port `8000` when it starts up.
(Without that file it would listen on a random port so that you can start multiple Netbox instances in parallel.) (Without that file it would listen on a random port so that you can start multiple NetBox instances in parallel.)
If you already have something listening on port `8000` feel free to change it. If you already have something listening on port `8000` feel free to change it.
To get Netbox Docker up-and-running, here are the two final steps: To get NetBox Docker up-and-running, here are the two final steps:
4. You will need to pull all the containers from the Docker registry. 4. You will need to pull all the containers from the Docker registry.
This may take a while, depending on your internet connection. This may take a while, depending on your internet connection.
@ -74,11 +74,11 @@ docker-compose up
``` ```
You will see a lot of output on your screen. You will see a lot of output on your screen.
Netbox will be initializing the database and then start. NetBox will be initializing the database and then start.
The whole application will be available after a few minutes. The whole application will be available after a few minutes.
Open the URL `http://0.0.0.0:8000/` in a web-browser. Open the URL `http://0.0.0.0:8000/` in a web-browser.
You should see the Netbox homepage. You should see the NetBox homepage.
On the top-right corner you can log-in. On the top-right corner you can log-in.
The default credentials are: The default credentials are:
@ -91,7 +91,7 @@ The default credentials are:
## Shutdown ## Shutdown
If you want to just stop Netbox to continue work later on, use the following command. If you want to just stop NetBox to continue work later on, use the following command.
```bash ```bash
# Stop all the containers # Stop all the containers
@ -101,7 +101,7 @@ docker-compose stop
docker-compose up docker-compose up
``` ```
If you want to stop Netbox and clean up any resources it allocated (database, files, etc.), use the following command. **Attention:** It will remove any data you have entered in Netbox! If you want to stop NetBox and clean up any resources it allocated (database, files, etc.), use the following command. **Attention:** It will remove any data you have entered in NetBox!
```bash ```bash
docker-compose down -v docker-compose down -v