diff --git a/images/docker-netbootxyz/index.html b/images/docker-netbootxyz/index.html index bd78606f05..0973c11f5b 100644 --- a/images/docker-netbootxyz/index.html +++ b/images/docker-netbootxyz/index.html @@ -40,7 +40,7 @@ - NGINX_PORT=80 #optional - WEB_APP_PORT=3000 #optional volumes: - - /path/to/config:/config + - /path/to/netbootxyz/config:/config - /path/to/assets:/assets #optional ports: - 3000:3000 @@ -60,11 +60,11 @@ -p 3000:3000 \ -p 69:69/udp \ -p 8080:80 `#optional` \ - -v /path/to/config:/config \ + -v /path/to/netbootxyz/config:/config \ -v /path/to/assets:/assets `#optional` \ --restart unless-stopped \ lscr.io/linuxserver/netbootxyz:latest -

Parameters

Containers 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.

Ports (-p)

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
TZ=Etc/UTC specify a timezone to use, see this list.
MENU_VERSION=1.9.9 Specify a specific version of boot files you want to use from NETBOOT.XYZ (unset pulls latest)
PORT_RANGE=30000:30010 Specify the port range tftp will use for data transfers (see Wikipedia)
SUBFOLDER=/ Specify a sobfolder if running this behind a reverse proxy (IE /proxy/)
NGINX_PORT=80 Specify a different internal port for the asset server
WEB_APP_PORT=3000 Specify a different internal port for the configuration UI

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)

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
+

Parameters

Containers 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.

Ports (-p)

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
TZ=Etc/UTC specify a timezone to use, see this list.
MENU_VERSION=1.9.9 Specify a specific version of boot files you want to use from NETBOOT.XYZ (unset pulls latest)
PORT_RANGE=30000:30010 Specify the port range tftp will use for data transfers (see Wikipedia)
SUBFOLDER=/ Specify a subfolder if running this behind a reverse proxy (IE /proxy/)
NGINX_PORT=80 Specify a different internal port for the asset server
WEB_APP_PORT=3000 Specify a different internal port for the configuration UI

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)

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods

We publish various 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.

Support Info