Skip to content
This repository has been archived by the owner on Jun 3, 2019. It is now read-only.

Latest commit

 

History

History
111 lines (73 loc) · 3.83 KB

READMETEMPLATE.md

File metadata and controls

111 lines (73 loc) · 3.83 KB

linuxserver.io

Contact information:-

Type Address/Details
Discord Discord
IRC freenode at #linuxserver.io more information at:- IRC
Forum Linuserver.io forum

   

The LinuxServer.io team brings you another image release featuring :-

  • regular and timely application updates
  • easy user mappings
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • security updates

Dockerfile-link

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>  \
  -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. 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.

Parameter Function
-p 1234 the port(s)
-v /config explain what lives here
-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.

Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.

In this instance PUID=1001 and PGID=1001, to find yours use id user as below:

  $ id <dockeruser>
    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
Shell access (live container) docker exec -it <container-name> /bin/bash
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

 

Changelog

Date Changes
dd.MM.yy Initial Release.