Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Jared-Bloomer committed Aug 26, 2024
1 parent 2791cfc commit 05e2a8c
Show file tree
Hide file tree
Showing 21 changed files with 29 additions and 107 deletions.
4 changes: 2 additions & 2 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: "netbox" #replace
MODNAME: "slurpit" #replace
MULTI_ARCH: "true" #set to false if not needed

jobs:
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="jared-bloomer"

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

This file was deleted.

26 changes: 3 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,5 @@
# Rsync - Docker mod for openssh-server
# SlurpIT - Docker mod for installing the SlurpIT plugin for netbox

This mod adds rsync to openssh-server, to be installed/updated during container start.
This mod adds the slurpit plugin to a netbox container.

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)
In netbox docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:netbox-slurpit`

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

23 changes: 23 additions & 0 deletions root/etc/s6-overlay/s6-rc.d/init-mod-netbox-slurpit-install/run
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/usr/bin/with-contenv bash

# This is an install script that is designed to run after init-mods-package-install
# 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 "**** Installing Netbox SlurpIT plugin ****"
echo "**** see https://netboxlabs.com/netbox-plugins/ for more information ****"

if ! command -v python3; then
echo "**** Python3 is not installed ****"
exit 1
else:
if [ -f /lsiopy/bin/python3 ]; then
/lsiopy/bin/python3 -m pip install --no-cache-dir slurpit_netbox
echo "Please update configuration.py to include "
echo "PLUGINS = ['slurpit_netbox']"
else:
echo "/lsiopy/bin/python3 not found!"
exit 1
fi
fi

Empty file.
Empty file.
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.
Empty file.

0 comments on commit 05e2a8c

Please sign in to comment.