LAB-linuxserver/docker-project-template
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-project-template.git synced 2026-02-20 02:41:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

spacing

Browse Source
This commit is contained in:
sparklyballs 2017-09-19 10:32:17 +01:00 committed by GitHub
parent 640520d62e
commit 1985bc1550
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docker/READMETEMPLATE.md
View File

@ -26,6 +26,8 @@ Provide a short, concise description of the application. No more than two SHORT
`IMPORTANT, replace all instances of <image-name> with the correct dockerhub repo (ie linuxserver/plex) and <container-name> information (ie, plex)`
&nbsp;
## Usage
```
@ -55,6 +57,8 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po
| `-e PGID` | for GroupID, see below for explanation |
| `-e PUID` | for UserID, see below for explanation |
&nbsp;
## User / Group Identifiers
Sometimes 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`.
@ -75,6 +79,8 @@ In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as bel
Insert a basic user guide here to get a n00b up and running with the software inside the container. DELETE ME
&nbsp;
## Container access and information.
| Function | Command |
@ -84,6 +90,8 @@ Insert a basic user guide here to get a n00b up and running with the software in
| Container version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' <container-name>` |
| Image version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' <image-name>` |
&nbsp;
## Versions
| Date | Changes |