Skip to content
Snippets Groups Projects

GITHUB_REPONAMEGITHUB_REPONAME

Docker Pulls Docker Image Size (latest by date) Docker Cloud Build Status Docker Cloud Automated build GitHub Repo stars GitHub forks

GITHUB_REPONAME

DESCRIPTION

GITHUB_REPONAME


Creates a Container which runs CREATOR_NAME's CREATOR_REPO, with lsiobase/alpine as the base image, as seen on EXAMPLE_SITE_IF_EXISTS.

The lasiobase/alpine image is a custom base image built with Alpine linux and S6 overlay. Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier

Deployment

Pre-built images

version: '3.6'
services:
  GITHUB_REPONAME:
    container_name: GITHUB_REPONAME
    image: griefed/GITHUB_REPONAME
    restart: unless-stopped
    volumes:
      - ./path/to/config:/config
      - ./path/to/data:/data
    environment:
      - TZ=Europe/Berlin
      - PUID=1000  # User ID
      - PGID=1000  # Group ID
    ports:
      - 80:80

Configuration

Configuration Explanation
Restart policy "no", always, on-failure, unless-stopped
config volume Contains config files and logs.
data volume Contains your/the containers important data.
TZ Timezone
PUID for UserID
PGID for GroupID
ports The port where the service will be available at.

User / Group Identifiers

When using volumes, permissions issues can arise between the host OS and the container. Linuxserver.io avoids 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 any permissions issues will vanish like magic.

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

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Raspberry Pi & building the image yourself

Using the Dockerfile, this container can be built and run on a Raspberry Pi. I've tested it on a Raspberry Pi 3B.

docker-compose.yml

version: '3.6'
services:
  GITHUB_REPONAME:
    container_name: GITHUB_REPONAME
    build: ./GITHUB_REPONAME/
    restart: unless-stopped
    volumes:
      - ./path/to/config/files:/config
    environment:
      - TZ=Europe/Berlin
      - PUID=1000  # User ID
      - PGID=1000  # Group ID
    ports:
      - 80:80
  1. Clone the repository: git clone https://github.com/Griefed/GITHUB_REPONAME.git ./GITHUB_REPONAME
  2. Prepare docker-compose.yml file as seen above
  3. docker-compose up -d --build GITHUB_REPONAME
  4. Visit IP.ADDRESS.OF.HOST:80
  5. ???
  6. Profit!