Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

transmission-trguing new mod creation #890

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/BuildImage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ 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
BASEIMAGE: "transmission" #replace
MODNAME: "transmission-trguing" #replace

jobs:
set-vars:
Expand All @@ -20,7 +20,7 @@ jobs:
echo "BASEIMAGE=${{ env.BASEIMAGE }}" >> $GITHUB_OUTPUT
echo "MODNAME=${{ env.MODNAME }}" >> $GITHUB_OUTPUT
# **** If the mod needs to be versioned, set the versioning logic below. Otherwise leave as is. ****
MOD_VERSION=""
MOD_VERSION=$(curl -s https://api.github.com/repos/openscopeproject/TrguiNG/releases/latest | jq -rc ".tag_name")
echo "MOD_VERSION=${MOD_VERSION}" >> $GITHUB_OUTPUT
outputs:
GITHUB_REPO: ${{ steps.outputs.outputs.GITHUB_REPO }}
Expand Down
29 changes: 26 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
# syntax=docker/dockerfile:1

FROM scratch
FROM ghcr.io/linuxserver/baseimage-alpine:3.19 as buildstage

ARG MOD_VERSION

LABEL maintainer="username"
RUN \
echo "**** grab transmission trguing ****" && \
mkdir -p /root-layer/themes && \
if [ -z ${MOD_VERSION} ]; then \
MOD_VERSION=$(curl -s "https://api.github.com/repos/openscopeproject/TrguiNG/releases/latest" \
| jq -rc ".tag_name"); \
fi && \
curl -o \
/tmp/trguing-web.zip -L \
"https://github.com/openscopeproject/TrguiNG/releases/download/${MOD_VERSION}/trguing-web-${MOD_VERSION}.zip" && \
mkdir -p /root-layer/themes/trguing && \
unzip \
/tmp/trguing-web.zip -d \
/root-layer/themes/trguing

# copy local files
COPY root/ /
COPY root/ /root-layer/

# ## Single layer deployed image ##
FROM scratch

LABEL maintainer="Azlux"

# # Add files from buildstage
COPY --from=buildstage /root-layer/ /
25 changes: 0 additions & 25 deletions Dockerfile.complex

This file was deleted.

26 changes: 6 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,11 @@
# Rsync - Docker mod for openssh-server
# TrguiNG - Remote GUI for Transmission torrent daemon

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

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

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:transmission-trguing|linuxserver/mods:transmission-mod2`

# Mod creation instructions
## Notes

* 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 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)
* This mod will *overwrite* any existing `TRANSMISSION_WEB_HOME` environment variable that has been set.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/usr/bin/with-contenv bash
# shellcheck shell=bash

printf "/themes/transmission-trguing" > /var/run/s6/container_environment/TRANSMISSION_WEB_HOME

lsiown -R abc:abc /themes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/etc/s6-overlay/s6-rc.d/init-mod-transmission-trguing-install/run
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.