From 1c49aaa652e1c4b49bbf3f7adbf47e67cd0a5c3a Mon Sep 17 00:00:00 2001 From: Jonathan Treffler Date: Tue, 27 Dec 2022 00:49:52 +0000 Subject: [PATCH] updated README --- README.md | 28 ++++------------------------ 1 file changed, 4 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index e2c84a5..4d7dc67 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,7 @@ -# Rsync - Docker mod for openssh-server +# MediaDC - Docker mod for nextcloud -This mod adds rsync to openssh-server, to be installed/updated during container start. +This mod adds the required packages the [Memories](https://apps.nextcloud.com/apps/memories) nextcloud app needs to work. -In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync` +In nextcloud docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:nextcloud-memories` -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. -* The mod should be compatible with both s6v2 and s6v3 (until s6v2 based baseimages are deprecated). -* After all init scripts and services are created, run `find ./ -name run -exec chmod +x {} +; find ./ -name finish -exec chmod +x {} +` to fix permissions. -* 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 `-`. 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. - - -## Tips and tricks - -* To decrease startup times when multiple mods are used, we have consolidated `apt-get update` down to one file. As seen in the [nodejs mod](https://github.com/linuxserver/docker-mods/tree/code-server-nodejs/root/etc/cont-init.d) -* Some images has helpers built in, these images are currently: - * [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files) - * [Code-server](https://github.com/linuxserver/docker-code-server/pull/95) +If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:nextcloud-memories|linuxserver/mods:nextcloud-mod2` \ No newline at end of file