aptalca / docker-readme-sync

Contact information:-

Type	Address/Details
Discord	Discord
Forum	Linuserver.io forum
IRC	freenode at #linuxserver.io more information at:- IRC
Podcast	Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! Linuxserver.io Podcast

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

lsiodev/readme-sync

Utility to copy README.md from a given github.com repository to a given dockerhub.com repository.

 

Usage

docker run --rm=true \
    -e DOCKERHUB_USERNAME=<USERNAME> \
    -e DOCKERHUB_PASSWORD=<PASSWORD> \
    -e GIT_REPOSITORY=<GITHUB REPO> \
    -e DOCKER_REPOSITORY=<DOCKERHUB REPO> \
    -e GIT_BRANCH=<GITHUB BRANCH> \
    lsiodev/readme-sync bash -c 'node sync'

 

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
-e DOCKERHUB_USERNAME	your dockerhub username
-e DOCKERHUB_PASSWORD	your dockerhub password
-e GIT_REPOSITORY	github repository, i.e. linuxserver/docker-readme-sync
-e DOCKER_REPOSITORY	dockerhub repository, i.e. lsiodev/docker-readme-sync
-e GIT_BRANCH	github repository branch, optional (default: master)

  It is based on alpine and is not meant to run as a service. The sync is performed and the command exits.  

Versions

Date	Changes
13.01.21	Use ghcr baseimages. Fall back to external folder for readme lite.
28.07.20	Rebase to alpine 3.12.
20.08.18	Rebase to alpine 3.8.
28.02.18	convert repo to use node.js implementation.
17.11.17	add github branch support.
16.10.16	merge ruby app.
11.10.16	Initial development release.