Skip to content

Commit

Permalink
Merge pull request #924 from DaveO16176/template
Browse files Browse the repository at this point in the history
  • Loading branch information
Roxedus authored Jul 22, 2024
2 parents 9d6b690 + 4fba94e commit 03454d0
Show file tree
Hide file tree
Showing 23 changed files with 61 additions and 104 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/BuildImage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ on: [push, pull_request_target, workflow_dispatch]
env:
GITHUB_REPO: "linuxserver/docker-mods" #don't modify
ENDPOINT: "linuxserver/mods" #don't modify
BASEIMAGE: "replace_baseimage" #replace
MODNAME: "replace_modname" #replace
MULTI_ARCH: "true" #set to false if not needed
BASEIMAGE: "emby" #replace
MODNAME: "mediainfo-plugin" #replace
MULTI_ARCH: "false" #set to false if not needed

jobs:
set-vars:
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

FROM scratch

LABEL maintainer="username"
LABEL maintainer="DaveO16176"

# copy local files
COPY root/ /
33 changes: 0 additions & 33 deletions Dockerfile.complex

This file was deleted.

49 changes: 24 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
# Rsync - Docker mod for openssh-server

This mod adds rsync to openssh-server, to be installed/updated during container start.

In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`

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.
* After all init scripts and services are created, run `find ./ -path "./.git" -prune -o \( -name "run" -o -name "finish" -o -name "check" \) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions.
* Edit this readme with pertinent info, delete these instructions.
* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic and `MULTI_ARCH` if needed.
* 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.


## Tips and tricks

* Some images have 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)
# MediaInfo Plugin Support - Docker mod for Emby

This mod adds support for the Emby's MediaInfo plugin https://github.com/Cheesegeezer/MediaInfoWiki/wiki for Linuxserver.io's Emby container https://github.com/linuxserver/docker-emby.

Supports the Ubuntu version of the Emby container. This mod will only work on amd64 because the Roku BIF file creation tool is compiled only for Linux x86 64-bit machines. See https://developer.roku.com/en-gb/docs/developer-program/media-playback/trick-mode/bif-file-creation.md for more information.

In Emby Docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:emby-mediaserver`, such as:
- docker-compose:
```yaml
environment:
- DOCKER_MODS=linuxserver/mods:emby-mediaserver-plugin
```
- docker cli:
```sh
-e DOCKER_MODS=linuxserver/mods:emby-mediaserver-plugin
```

If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:emby-mediaserver-plugin|linuxserver/mods:universal-mod2`

# Settings in Emby
Configure the Media Toolbox plugin, applications installed will be located as follows:
- MediaInfoCL in `/usr/bin/mediainfo`
- MKVPropEdit in `/usr/bin/mkvpropedit`
- BifTool in `/usr/bin/biftool`
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/usr/bin/with-contenv bash

# This is the init file used for adding os or pip packages to install lists.
# It takes advantage of the built-in init-mods-package-install init script that comes with the baseimages.
# If using this, we need to make sure we set this init as a dependency of init-mods-package-install so this one runs first

# Determine if setup is needed
if [ ! -f /usr/bin/apt ]; then
echo "**** Image is not Ubuntu, exiting emby-mediainfo-plugin install. ****"
exit 0
fi

if [ $(uname -m) != "x86_64" ]; then
echo "**** MediaInfo plugin only works on x86_64, see README for more info. Exiting emby-mediainfo-plugin install. ****"
exit 0
fi

# Ubuntu
if [ -f /usr/bin/apt ]; then
echo "**** Installing packages ****"
echo "\
mediainfo \
mkvtoolnix \
unzip" >> /mod-repo-packages-to-install.list
fi
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/etc/s6-overlay/s6-rc.d/init-mod-emby-mediainfo-plugin-add-package/run
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,9 @@
# so it can take advantage of packages installed
# init-mods-end depends on this script so that later init and services wait until this script exits

echo "**** Setting up apprise ****"
apprise blah blah
echo "**** Installing BIF Tool ****"
curl -L \
"https://github.com/rokudev/samples/raw/master/utilities/bif%20tool/biftool_linux.zip" \
-o /tmp/biftool_linux.zip && \
cd /tmp && \
unzip biftool_linux.zip -d /usr/bin
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/etc/s6-overlay/s6-rc.d/init-mod-emby-mediainfo-plugin-postinstall/run

This file was deleted.

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/run

This file was deleted.

1 change: 0 additions & 1 deletion root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/type

This file was deleted.

Empty file.
Empty file.

0 comments on commit 03454d0

Please sign in to comment.