mirror of
https://github.com/linuxserver/docker-project-template.git
synced 2026-02-20 02:41:25 +08:00
Update links and spacing
This commit is contained in:
Jonathan Dahan
parent
ca3c99294d
commit
e24ff1430d
@ -1,15 +1,9 @@
|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[linuxserver]: https://linuxserver.io
|
||||
[][linuxserver]
|
||||
|
||||
[][linuxserverurl]
|
||||
## This is a Container in active development by the [LinuxServer.io][linuxserver] team and is not recommended for use by the general public.
|
||||
|
||||
## This is a Container in active development by the [LinuxServer.io][linuxserverurl] team and is not recommended for use by the general public.
|
||||
|
||||
If you want to comment\contribute on this container , are looking for support on any of our other work , or are curious about us in general, check out the following.
|
||||
|
||||
* [forum.linuxserver.io][forumurl]
|
||||
* [IRC][ircurl] on freenode at `#linuxserver.io`
|
||||
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
|
||||
If you want to comment\contribute on this container, are looking for support on any of our other work, or are curious about us in general, check out the following.
|
||||
|
||||
* [IRC][irc://irc.freenode.net/linuxserver.io] on freenode at `#linuxserver.io`
|
||||
* [Discord](https://discord.gg/YWrKVTn)
|
||||
|
||||
@ -1,27 +1,14 @@
|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[appurl]: www.example.com
|
||||
[dockerfileurl]: https://github.com/linuxserver/docker-<container-name>/blob/master/Dockerfile
|
||||
[hub]: https://hub.docker.com/r/<image-name>/
|
||||
[dockerfile]: https://github.com/linuxserver/docker-<container-name>/blob/master/Dockerfile
|
||||
[linuxserver]: https://linuxserver.io
|
||||
|
||||
[][linuxserver]
|
||||
|
||||
## Contact information:-
|
||||
|
||||
[][linuxserverurl]
|
||||
* [IRC](irc://irc.freenode.net/linuxserver.io) on freenode at `#linuxserver.io`
|
||||
* [Discord](https://discord.gg/YWrKVTn)
|
||||
|
||||
|
||||
## Contact information:-
|
||||
|
||||
| Type | Address/Details |
|
||||
| :---: | --- |
|
||||
| Discord | [Discord](https://discord.gg/YWrKVTn) |
|
||||
| IRC | freenode at `#linuxserver.io` more information at:- [IRC][ircurl]
|
||||
| Forum | [Linuserver.io forum][forumurl] |
|
||||
|
||||
|
||||
|
||||
|
||||
The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :-
|
||||
The [LinuxServer.io][linuxserver] team brings you another image release featuring :-
|
||||
|
||||
+ regular and timely application updates
|
||||
+ easy user mappings
|
||||
@ -31,30 +18,26 @@ The [LinuxServer.io][linuxserverurl] team brings you another image release featu
|
||||
|
||||
# <image-name>
|
||||
|
||||
[][dockerfileurl]
|
||||
[][dockerfile]
|
||||
|
||||
Provide a short, concise description of the application. No more than two SHORT paragraphs. Link to sources where possible and include an image illustrating your point if necessary. Point users to the original applications website, as that's the best place to get support - not here.
|
||||
|
||||
`IMPORTANT, replace all instances of <image-name> with the correct dockerhub repo (ie linuxserver/plex) and <container-name> information (ie, plex) and make sure to update the block at the top of this file containing app specific urls, dockerhub url and dockerfile url etc.`
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name=<container-name> \
|
||||
-v <path to data>:/config \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-v <path to data>:/config \
|
||||
-p 1234:1234 \
|
||||
<image-name>
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Parameters
|
||||
|
||||
The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
||||
The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
||||
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
|
||||
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
|
||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
|
||||
@ -68,8 +51,6 @@ 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 |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
@ -83,15 +64,10 @@ In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as bel
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Setting up the application
|
||||
|
||||
Insert a basic user guide here to get a n00b up and running with the software inside the container. DELETE ME
|
||||
|
||||
|
||||
|
||||
|
||||
## Container access and information.
|
||||
|
||||
| Function | Command |
|
||||
@ -100,9 +76,7 @@ Insert a basic user guide here to get a n00b up and running with the software in
|
||||
| Realtime container logs | `docker logs -f <container-name>` |
|
||||
| Container version | `docker inspect -f '{{ index .Config.Labels "build_version" }}' <container-name>` |
|
||||
| Image version | `docker inspect -f '{{ index .Config.Labels "build_version" }}' <image-name>` |
|
||||
| Dockerfile | [Dockerfile][dockerfileurl] |
|
||||
|
||||
|
||||
| Dockerfile | [Dockerfile][dockerfile] |
|
||||
|
||||
## Changelog
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user