From 13751c416ff05dd6f86ddf766909fd930feabfff Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 28 Jul 2020 12:15:22 -0400 Subject: [PATCH] Bot Updating Documentation --- images/docker-readme-sync.md | 83 ++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100755 images/docker-readme-sync.md diff --git a/images/docker-readme-sync.md b/images/docker-readme-sync.md new file mode 100755 index 0000000000..6673af140f --- /dev/null +++ b/images/docker-readme-sync.md @@ -0,0 +1,83 @@ +[linuxserverurl]: https://linuxserver.io +[forumurl]: https://forum.linuxserver.io +[ircurl]: https://www.linuxserver.io/irc/ +[podcasturl]: https://www.linuxserver.io/podcast/ +[appurl]: www.example.com +[hub]: https://hub.docker.com/r/lsiodev/readme-sync/ + + +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png?v=4&s=4000)][linuxserverurl] + + +## Contact information:- + +| Type | Address/Details | +| :---: | --- | +| Discord | [Discord](https://discord.gg/YWrKVTn) | +| Forum | [Linuserver.io forum][forumurl] | +| IRC | freenode at `#linuxserver.io` more information at:- [IRC][ircurl] +| 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][podcasturl] | + + +The [LinuxServer.io][linuxserverurl] 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 + +[![](https://images.microbadger.com/badges/version/lsiodev/readme-sync.svg)](https://microbadger.com/images/lsiodev/readme-sync "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/lsiodev/readme-sync.svg)](https://microbadger.com/images/lsiodev/readme-sync "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/lsiodev/readme-sync.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/lsiodev/readme-sync.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/lsiodev/readme-sync-docker)](https://ci.linuxserver.io/job/Docker-Builders/job/lsiodev/job/readme-sync-docker/) + +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= \ + -e DOCKERHUB_PASSWORD= \ + -e GIT_REPOSITORY= \ + -e DOCKER_REPOSITORY= \ + -e GIT_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 | +| :---: | --- | +| 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. |