mirrors/docker-netbootxyz
1
0
Fork 0
mirror of https://github.com/netbootxyz/docker-netbootxyz.git synced 2025-08-07 06:37:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Antony Messerli 2021-09-06 21:56:10 -05:00
parent 9d758fdb93
commit 7b96357238
1 changed files with 30 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -15,12 +15,12 @@ Services are managed in the container by [supervisord](http://supervisord.org/).
The following snippets are examples of starting up the container.
### docker-cli
```
```bash
docker run -d \
--name=netbootxyz \
-e MENU_VERSION=2.0.47 `# optional` \
-p 3000:3000 \ # sets webapp port
-p 69:69/udp \ # sets tftp port
-p 3000:3000 `# sets webapp port` \
-p 69:69/udp `# sets tftp port` \
-p 8080:80 `# optional` \
-v /local/path/to/config:/config `# optional` \
-v /local/path/to/assets:/assets `# optional` \
@ -28,9 +28,20 @@ docker run -d \
ghcr.io/netbootxyz/netbootxyz
```
#### Updating the image with via docker-cli
```bash
docker pull ghcr.io/netbootxyz/netbootxyz # pull the latest image down
docker stop netbootxyz # stop the existing container
docker rm netbootxyz # remove the image
docker run -d ... # previously ran start command
```
Start the container with the same parameters used above. If the same folders are used your settings will remain. If you want to start fresh, you can remove the paths and start over.
### docker-compose
```
```yaml
---
version: "2.1"
services:
@ -49,6 +60,21 @@ services:
restart: unless-stopped
```
#### Updating the image with via docker-compose
```bash
docker-compose pull netbootxyz # pull the latest image down
docker-compose up -d netbootxyz # start containers in the background
```
Once the container is started, the netboot.xyz web application can be accessed by the web configuration interface at http://localhost:3000 or via the specified port.
Downloaded web assets will be available at http://localhost:8080 or the specified port. If you have specified the assets volume, the assets will be available at http://localhost:8080.
If you wish to start over from scratch, you can remove the local configuration folders and upon restart of the container, it will load the default configurations.
### Accessing the container services
Once the container is started, the netboot.xyz web application can be accessed by the web configuration interface at http://localhost:3000 or via the specified port.
Downloaded web assets will be available at http://localhost:8080 or the specified port. If you have specified the assets volume, the assets will be available at http://localhost:8080.