Skip to content

Commit 6ae1c00

Browse files
Bot Updating Templated Files
1 parent 29d23b3 commit 6ae1c00

File tree

2 files changed

+29
-25
lines changed

2 files changed

+29
-25
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
9696

9797
### Testing your changes
9898

99-
```
99+
```bash
100100
git clone https://github.com/linuxserver/docker-netbox.git
101101
cd docker-netbox
102102
docker build \
@@ -106,13 +106,14 @@ docker build \
106106
```
107107

108108
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109-
```
109+
110+
```bash
110111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111112
```
112113

113114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114115

115-
## Update the chagelog
116+
## Update the changelog
116117

117118
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-netbox/tree/master/root), add an entry to the changelog
118119

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the CONTRIBUTING.md -->
2+
<!-- Please read the https://github.com/linuxserver/docker-netbox/blob/master/.github/CONTRIBUTING.md -->
33

44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
55

@@ -12,13 +12,14 @@
1212

1313
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
1414

15-
* regular and timely application updates
16-
* easy user mappings (PGID, PUID)
17-
* custom base image with s6 overlay
18-
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19-
* regular security updates
15+
* regular and timely application updates
16+
* easy user mappings (PGID, PUID)
17+
* custom base image with s6 overlay
18+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19+
* regular security updates
2020

2121
Find us at:
22+
2223
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2324
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
2425
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -40,7 +41,6 @@ Find us at:
4041

4142
[Netbox](https://github.com/netbox-community/netbox) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations.
4243

43-
4444
[![netbox](https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg)](https://github.com/netbox-community/netbox)
4545

4646
## Supported Architectures
@@ -57,6 +57,9 @@ The architectures supported by this image are:
5757
| arm64 | arm64v8-latest |
5858
| armhf | arm32v7-latest |
5959

60+
## Application Setup
61+
62+
Access the WebUI at <your-ip>:8000. For more information, check out [NetBox](https://github.com/netbox-community/netbox).
6063

6164
## Usage
6265

@@ -104,7 +107,7 @@ services:
104107
105108
### docker cli
106109
107-
```
110+
```bash
108111
docker run -d \
109112
--name=netbox \
110113
-e PUID=1000 \
@@ -134,7 +137,6 @@ docker run -d \
134137
ghcr.io/linuxserver/netbox
135138
```
136139

137-
138140
## Parameters
139141

140142
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
@@ -171,7 +173,7 @@ You can set any environment variable from a file by using a special prepend `FIL
171173

172174
As an example:
173175

174-
```
176+
```bash
175177
-e FILE__PASSWORD=/run/secrets/mysecretpassword
176178
```
177179

@@ -190,24 +192,17 @@ Ensure any volume directories on the host are owned by the same user you specify
190192

191193
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
192194

193-
```
195+
```bash
194196
$ id username
195197
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
196198
```
197199

198-
199-
&nbsp;
200-
## Application Setup
201-
202-
Access the WebUI at <your-ip>:8000. For more information, check out [NetBox](https://github.com/netbox-community/netbox).
203-
204-
205200
## Docker Mods
201+
206202
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=netbox&query=%24.mods%5B%27netbox%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=netbox "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
207203

208204
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
209205

210-
211206
## Support Info
212207

213208
* Shell access whilst the container is running: `docker exec -it netbox /bin/bash`
@@ -224,38 +219,45 @@ Most of our images are static, versioned, and require an image update and contai
224219
Below are the instructions for updating containers:
225220

226221
### Via Docker Compose
222+
227223
* Update all images: `docker-compose pull`
228224
* or update a single image: `docker-compose pull netbox`
229225
* Let compose update all containers as necessary: `docker-compose up -d`
230226
* or update a single container: `docker-compose up -d netbox`
231227
* You can also remove the old dangling images: `docker image prune`
232228

233229
### Via Docker Run
230+
234231
* Update the image: `docker pull ghcr.io/linuxserver/netbox`
235232
* Stop the running container: `docker stop netbox`
236233
* Delete the container: `docker rm netbox`
237234
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
238235
* You can also remove the old dangling images: `docker image prune`
239236

240237
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
238+
241239
* Pull the latest image at its tag and replace it with the same env variables in one run:
242-
```
240+
241+
```bash
243242
docker run --rm \
244243
-v /var/run/docker.sock:/var/run/docker.sock \
245244
containrrr/watchtower \
246245
--run-once netbox
247246
```
247+
248248
* You can also remove the old dangling images: `docker image prune`
249249

250250
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
251251

252252
### Image Update Notifications - Diun (Docker Image Update Notifier)
253+
253254
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
254255

255256
## Building locally
256257

257258
If you want to make local modifications to these images for development purposes or just to customize the logic:
258-
```
259+
260+
```bash
259261
git clone https://github.com/linuxserver/docker-netbox.git
260262
cd docker-netbox
261263
docker build \
@@ -265,7 +267,8 @@ docker build \
265267
```
266268

267269
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
268-
```
270+
271+
```bash
269272
docker run --rm --privileged multiarch/qemu-user-static:register --reset
270273
```
271274

0 commit comments

Comments
 (0)