Update README.md

This commit is contained in:
driz
2020-10-14 14:48:00 -04:00
committed by Eric Nemchik
parent a2930f35c9
commit cd504b15b7
+4 -14
View File
@@ -1,17 +1,7 @@
# Rsync - Docker mod for openssh-server
# tshoot - Docker mod for any container
This mod adds rsync to openssh-server, to be installed/updated during container start.
This mod adds common troubleshooting tools to any container, to be installed/updated during container start.
In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
In any container docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:universal-tshoot`
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
# Mod creation instructions
* Fork the repo, create a new branch based on the branch `template`.
* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
* Inspect the `root` folder contents. Edit, add and remove as necessary.
* Edit this readme with pertinent info, delete these instructions.
* Finally edit the `travis.yml`. Customize the build branch, and the vars for `BASEIMAGE` and `MODNAME`.
* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
* Submit PR against the branch created by the team.
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:universal-tshoot|linuxserver/mods:universal-mod2`