From c3abd5b4c64d59081a594428459a5d231f5c7dd2 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 3 Dec 2024 21:30:18 +0000 Subject: [PATCH] Bot Updating Templated Files --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 367e9fbe..f1c8e5e3 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,6 @@ This image provides various versions that are available via tags. Please read th - Once running the URL will be `http://:6767`. - You must complete all the setup parameters in the webui before you can save the config. - ## Read-Only Operation This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/). @@ -80,6 +79,9 @@ This image can be run with a read-only container filesystem. For details please To help you get started creating a container from this image you can either use docker-compose or the docker cli. +>[!NOTE] +>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. + ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml @@ -123,7 +125,7 @@ Containers are configured using parameters passed at runtime (such as those abov | Parameter | Function | | :----: | --- | -| `-p 6767` | Allows HTTP access to the internal webserver. | +| `-p 6767:6767` | Allows HTTP access to the internal webserver. | | `-e PUID=1000` | for UserID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation | | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |