diff --git a/README.md b/README.md index 0399570..3ddaac3 100644 --- a/README.md +++ b/README.md @@ -73,11 +73,13 @@ You can explicitly set the amount of memory Ubooquity is allowed to use (be care If no value is set it will default to 512MB. - ## Usage 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 @@ -127,8 +129,8 @@ Containers are configured using parameters passed at runtime (such as those abov | Parameter | Function | | :----: | --- | -| `-p 2202` | The library port. | -| `-p 2203` | The admin port. | +| `-p 2202:2202` | The library port. | +| `-p 2203:2203` | The admin port. | | `-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). |