diff --git a/images/docker-readme-sync/index.html b/images/docker-readme-sync/index.html index 29bf502925..3c4f4909c5 100644 --- a/images/docker-readme-sync/index.html +++ b/images/docker-readme-sync/index.html @@ -5,4 +5,4 @@ -e DOCKER_REPOSITORY=<DOCKERHUB REPO> \ -e GIT_BRANCH=<GITHUB BRANCH> \ lsiodev/readme-sync bash -c 'node sync' -
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.
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. |