initial commit

This commit is contained in:
Alex Phillips
2021-12-17 10:22:06 -05:00
parent d1dc6e5858
commit 4611b332e1
6 changed files with 9 additions and 67 deletions
+5 -13
View File
@@ -1,17 +1,9 @@
# Rsync - Docker mod for openssh-server
# stdout-logging - Docker mod for any container
This mod adds rsync to openssh-server, to be installed/updated during container start.
This mod allows any specified log files to be tailed and included in the container's STDOUT.
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-stdout-logging`
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`
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:universal-stdout-logging|linuxserver/mods:universal-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 `.github/workflows/BuildImage.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.
Simply set the environment variable `LOGS_TO_STDOUT` with a space-delimited list of log files to include, such as `LOGS_TO_STDOUT="/config/logs/radarr.txt /config/logs/radarr.debug.txt"`