From 7fa2e8cd0747de319509525d9ef659a96a82527b Mon Sep 17 00:00:00 2001
From: LinuxServer-CI <ci@linuxserver.io>
Date: Sat, 14 Dec 2019 18:33:26 +0000
Subject: [PATCH] Bot Updating Documentation

---
 images/docker-netbootxyz.md | 48 +++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/images/docker-netbootxyz.md b/images/docker-netbootxyz.md
index 7a43440bf..77a7c1a53 100755
--- a/images/docker-netbootxyz.md
+++ b/images/docker-netbootxyz.md
@@ -27,6 +27,14 @@ The architectures supported by this image are:
 | arm64 | arm64v8-latest |
 | armhf | arm32v7-latest |
 
+## Version Tags
+
+This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
+
+| Tag | Description |
+| :----: | --- |
+| latest | Web application for full self hosting |
+| tftp | TFTP server only with NETBOOT.XYZ boot files |
 
 ## Usage
 
@@ -37,7 +45,14 @@ Here are some example snippets to help you get started creating a container from
 ```
 docker create \
   --name=netbootxyz \
+  -e PUID=1000 \
+  -e PGID=1000 \
+  -e MENU_VERSION=1.9.9 `#optional` \
+  -p 3000:3000 \
   -p 69:69/udp \
+  -p 8080:80 `#optional` \
+  -v /path/to/config:/config \
+  -v /path/to/assets:/assets `#optional` \
   --restart unless-stopped \
   linuxserver/netbootxyz
 ```
@@ -54,8 +69,19 @@ services:
   netbootxyz:
     image: linuxserver/netbootxyz
     container_name: netbootxyz
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - MENU_VERSION=1.9.9 #optional
+    volumes:
+      - /path/to/config:/config
+    volumes:
+      - /path/to/assets:/assets #optional
     ports:
+      - 3000:3000
       - 69:69/udp
+    ports:
+      - 8080:80 #optional
     restart: unless-stopped
 ```
 
@@ -67,21 +93,41 @@ Docker images are configured using parameters passed at runtime (such as those a
 
 | Parameter | Function |
 | :----: | --- |
+| `3000` | Web configuration interface. |
 | `69/udp` | TFTP Port. |
+| `80` | NGINX server for hosting assets. |
 
 
 ### Environment Variables (`-e`)
 
 | Env | Function |
 | :----: | --- |
+| `PUID=1000` | for UserID - see below for explanation |
+| `PGID=1000` | for GroupID - see below for explanation |
+| `MENU_VERSION=1.9.9` | Specify a specific version of boot files you want to use from NETBOOT.XYZ (unset pulls latest) |
 
 ### Volume Mappings (`-v`)
 
 | Volume | Function |
 | :----: | --- |
+| `/config` | Storage for boot menu files and web application config |
+| `/assets` | Storage for NETBOOT.XYZ bootable assets (live CDs and other files) |
 
 
 
+## User / Group Identifiers
+
+When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
+
+Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
+
+In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
+
+```
+  $ id username
+    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
+```
+
 ## Application Setup
 
 To use this image you need an existing DHCP server where you can set this TFTP server as your DHCP boot destination. This image does not contain a DHCP server nor do we aim to support one in the future. This is simply a TFTP server hosting the latest IPXE kernel builds from [netboot.xyz](https://netboot.xyz). If you are interested in their project and lack the ability to setup a DHCP server to boot this payload they also have USB stick images you can use available on their [downloads page](https://netboot.xyz/downloads/).
@@ -169,4 +215,6 @@ This image also contains `netboot.xyz.efi` which can be used to boot using UEFI
 
 ## Versions
 
+* **13.12.19:** - Swapping latest tag over to webapp stack for management.
+* **10.12.19:** - Adding tftp branch to provide tftp only option to latest users.
 * **22.10.19:** - Initial release.