Active GitHub Forks Docker Container Revisited

docker-Active-GitHub-Forks

docker-Active-GitHub-Forks

This project allows you to find the most active forks of a repository.


Creates a Container which runs techgaun’s active-forks, with lsiobase/nginx as the base image, as seen on https://techgaun.github.io/active-forks/.

The lasiobase/nginx 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:
  active-github-forks:
    container_name: active-github-forks
    image: griefed/active-github-forks
    restart: unless-stopped
    volumes:
      - ./path/to/config:/config
    environment:
      - TZ=Europe/Berlin
      - PUID=1000  # User ID
      - PGID=1000  # Group ID
    ports:
      - 80:80
      - 443:443

Raspberry Pi

To run this container on a Raspberry Pi, use the arm-tag. I’ve tested it on a Raspberry Pi 3B.

griefed/active-github-forks:arm

Configuration

ConfigurationExplanation
Restart policy“no”, always, on-failure, unless-stopped
config volumeContains config files and logs.
data volumeContains your/the containers important data.
TZTimezone
PUIDfor UserID
PGIDfor GroupID
portsThe 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)

Building the image yourself

Use the Dockerfile to build the image yourself, in case you want to make any changes to it

docker-compose.yml

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