Bot Updating Templated Files

Author: LinuxServer-CI

README.md

@@ -189,11 +189,13 @@ It is possible to install extra packages during container start using [universal
     - INSTALL_PACKAGES=libfuse2|git|gdb
 ```
 
- 
 ## 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
@@ -211,7 +213,7 @@ services:
       - PGID=1000
       - TZ=Etc/UTC
     volumes:
-      - /path/to/config:/config
+      - /path/to/github-desktop/config:/config
     ports:
       - 3000:3000
       - 3001:3001
@@ -231,7 +233,7 @@ docker run -d \
   -e TZ=Etc/UTC \
   -p 3000:3000 \
   -p 3001:3001 \
-  -v /path/to/config:/config \
+  -v /path/to/github-desktop/config:/config \
   --shm-size="1gb" \
   --restart unless-stopped \
   lscr.io/linuxserver/github-desktop:latest
@@ -243,14 +245,15 @@ Containers are configured using parameters passed at runtime (such as those abov
 
 | Parameter | Function |
 | :----: | --- |
-| `-p 3000` | Github Desktop gui. |
-| `-p 3001` | HTTPS Github Desktop gui. |
+| `-p 3000:3000` | Github Desktop gui. |
+| `-p 3001:3001` | HTTPS Github Desktop gui. |
 | `-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). |
 | `-v /config` | Users home directory in the container, stores local files and settings |
 | `--shm-size=` | This is needed for electron applications to function properly. |
 | `--security-opt seccomp=unconfined` | For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Github Desktop runs in no-sandbox mode without it. |
+| `--cap-add=IPC_LOCK` | Required for keyring functionality. |
 
 ### Portainer notice