-
-
Notifications
You must be signed in to change notification settings - Fork 283
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jared-Bloomer
committed
Aug 26, 2024
1 parent
2791cfc
commit 05e2a8c
Showing
21 changed files
with
29 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
|
||
FROM scratch | ||
|
||
LABEL maintainer="username" | ||
LABEL maintainer="jared-bloomer" | ||
|
||
# copy local files | ||
COPY root/ / |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |
30 changes: 0 additions & 30 deletions
30
root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/up
This file was deleted.
Oops, something went wrong.
8 changes: 0 additions & 8 deletions
8
root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run
This file was deleted.
Oops, something went wrong.
1 change: 0 additions & 1 deletion
1
root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/type
This file was deleted.
Oops, something went wrong.
File renamed without changes.
23 changes: 23 additions & 0 deletions
23
root/etc/s6-overlay/s6-rc.d/init-mod-netbox-slurpit-install/run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file.
Empty file removed
0
root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/dependencies.d/init-services
Empty file.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Empty file removed
0
root/etc/s6-overlay/s6-rc.d/user/contents.d/init-mod-imagename-modname-add-package
Empty file.
Empty file.
File renamed without changes.
Empty file.