Merge pull request #1091 from somewatson/code-server-rbenv

Create mod to include rbenv in code-server

.github/workflows/BuildImage.yml

@@ -12,10 +12,10 @@ on:
 env:
   GITHUB_REPO: "linuxserver/docker-mods" #don't modify
   ENDPOINT: "linuxserver/mods" #don't modify
-  BASEIMAGE: "replace_baseimage" #replace
-  MODNAME: "replace_modname" #replace
+  BASEIMAGE: "code-server" #replaced
+  MODNAME: "rbenv" #replaced
   MOD_VERSION: ${{ inputs.mod_version }} #don't modify
-  MULTI_ARCH: "true" #set to false if not needed
+  MULTI_ARCH: "false" #set to false if not needed
 
 jobs:
   set-vars:

Dockerfile

@@ -2,7 +2,7 @@
 
 FROM scratch
 
-LABEL maintainer="username"
+LABEL maintainer="somewatson"
 
 # copy local files
 COPY root/ /

Dockerfile.complex

@@ -1,33 +0,0 @@
-# syntax=docker/dockerfile:1
-
-## Buildstage ##
-FROM ghcr.io/linuxserver/baseimage-alpine:3.20 AS buildstage
-
-RUN \
-  echo "**** install packages ****" && \
-  apk add --no-cache \
-    curl && \
-  echo "**** grab rclone ****" && \
-  mkdir -p /root-layer && \
-  if [ $(uname -m) = "x86_64" ]; then \
-    echo "Downloading x86_64 tarball" && \
-    curl -o \
-      /root-layer/rclone.deb -L \
-      "https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-amd64.deb"; \
-  elif [ $(uname -m) = "aarch64" ]; then \
-    echo "Downloading aarch64 tarball" && \
-    curl -o \
-      /root-layer/rclone.deb -L \
-      "https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-arm64.deb"; \
-  fi && \
-
-# copy local files
-COPY root/ /root-layer/
-
-## Single layer deployed image ##
-FROM scratch
-
-LABEL maintainer="username"
-
-# Add files from buildstage
-COPY --from=buildstage /root-layer/ /

README.md

@@ -1,25 +1,54 @@
-# Rsync - Docker mod for openssh-server
+# Rbenv - Docker mod for code-server
 
-This mod adds rsync to openssh-server, to be installed/updated during container start.
+This mod adds [rbenv](https://github.com/rbenv/rbenv) to code-server, to be installed/updated during container start.
 
-In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
+rbenv is a version manager tool for the Ruby programming language on Unix-like systems. It is useful for switching between multiple Ruby versions on the same machine and for ensuring that each project you are working on always runs on the correct Ruby version.
 
-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`
+In code-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:code-server-rbenv`
 
-# Mod creation instructions
+If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:code-server-rbenv|linuxserver/mods:openssh-server-mod2`
 
-* 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.
+### Shell completions
 
+This mod includes adding [shell completions](https://github.com/rbenv/rbenv?tab=readme-ov-file#shell-completions) for `rbenv` in `bash` and `zsh`.
 
-## Tips and tricks
+The zsh completion script ships with the project, but needs to be added to FPATH in zsh before it can be discovered by the shell. So, the mod will automatically detect and update the `~/.zshrc` file:
 
-* 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)
+```
+FPATH=~/.rbenv/completions:"$FPATH"
+autoload -U compinit
+compinit
+```
+
+### Ruby-build
+
+This mod includes [ruby-build](https://github.com/rbenv/ruby-build), which allows you to run the `rbenv install` command.
+
+It will automatically check for an existing `ruby-build` installation upon `docker build`. If it detects `ruby-build`, it will upgrade it.
+
+You can also manually upgrade `ruby-build`, as described in the [documentation](https://github.com/rbenv/ruby-build?tab=readme-ov-file#clone-as-rbenv-plugin-using-git), without bringing down the docker instance by running:
+
+```
+git -C "$(rbenv root)"/plugins/ruby-build pull
+```
+
+### Build environment
+
+In order to compile Ruby, you need the proper toolchain and build environment. The required system packages can be found in the [documentation](https://github.com/rbenv/ruby-build/wiki#ubuntudebianmint).
+
+This mod will install these requirements for you:
+
+* autoconf
+* build-essential
+* libffi-dev
+* libgmp-dev
+* libssl-dev
+* libyaml-dev
+* rustc
+* zlib1g-dev
+
+With these installed, you should be able to compile any of the latest stable Ruby versions, which you can find by running the command `rbenv install --list`.
+
+### Installed Ruby versions
+
+By default, `rbenv` is installed in `~/.rbenv`. This mod will update the permissions of that folder to ensure that your user can install new versions of Ruby into it.

root/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-add-package/run

@@ -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
+#!/usr/bin/with-contenv bash
+
+if ! dpkg -s git >/dev/null 2>&1; then
+    echo "**** Adding git to package install list ****"
+    echo "git" >> /mod-repo-packages-to-install.list
+else
+    echo "**** git already installed, skipping ****"
+fi
+
+# List comes from: https://github.com/rbenv/ruby-build/wiki#ubuntudebianmint
+echo "Adding the required packages of the build environment for rbenv ruby-build "
+echo "\
+        autoconf \
+        build-essential \
+        libffi-dev \
+        libgmp-dev \
+        libssl-dev \
+        libyaml-dev \
+        rustc \
+        zlib1g-dev" >> /mod-repo-packages-to-install.list

root/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-add-package/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-add-package/run

root/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-install/run

@@ -0,0 +1,66 @@
+#!/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
+
+if [ -d /config/.rbenv ]; then
+    echo 'rbenv already cloned, skipping'
+else
+    echo 'Cloning rbenv repo'
+    git clone https://github.com/rbenv/rbenv.git /config/.rbenv
+fi
+
+if [ -d /config/.rbenv/plugins/ruby-build ]; then
+    echo 'ruby-build plugin already cloned, skipping'
+
+    # On a docker start, even if this folder exists, we need to own it first for git to be able to pull
+    echo 'Setting permissions for ~/.rbenv'
+    lsiown -R abc:abc \
+        /config/.rbenv
+
+    echo 'Upgrading ruby-build plugin'
+    git config --global --add safe.directory /config/.rbenv/plugins/ruby-build
+    git -C /config/.rbenv/plugins/ruby-build pull
+else
+    echo 'Cloning ruby-build plugin repo'
+    git clone https://github.com/rbenv/ruby-build.git /config/.rbenv/plugins/ruby-build
+fi
+
+# This will add `eval "$(~/.rbenv/bin/rbenv init - --no-rehash bash)"` to the ~/.bashrc or ~/.bash_profile file
+echo 'Initializing rbenv for bash'
+/config/.rbenv/bin/rbenv init
+
+if ! command -v zsh >/dev/null 2>&1; then
+    echo "**** zsh not installed, skipping shell completions setup ****"
+else
+    # This will add `eval "$(~/.rbenv/bin/rbenv init - --no-rehash zsh)"` to the ~/.zshrc file
+    echo 'Initializing rbenv for zsh'
+    /config/.rbenv/bin/rbenv init zsh
+
+    if [ -f /config/.zshrc ]; then
+        if ! grep -q 'FPATH=~/.rbenv/completions:"$FPATH"' /config/.zshrc; then
+            echo 'Adding shell completions to zsh for rbenv'
+
+            echo '' >> /config/.zshrc
+            echo '# For rbenv shell completions' >> /config/.zshrc
+            echo 'FPATH=~/.rbenv/completions:"$FPATH"' >> /config/.zshrc
+            echo 'autoload -U compinit' >> /config/.zshrc
+            echo 'compinit' >> /config/.zshrc
+        else
+            echo 'rbenv shell completions already exist in zsh, skipping'
+        fi
+    else
+        echo '/config/.zshrc not found, creating one with the shell completions'
+
+        echo '' >> /config/.zshrc
+        echo '# For rbenv shell completions' >> /config/.zshrc
+        echo 'FPATH=~/.rbenv/completions:"$FPATH"' >> /config/.zshrc
+        echo 'autoload -U compinit' >> /config/.zshrc
+        echo 'compinit' >> /config/.zshrc
+    fi
+fi
+
+echo 'Setting permissions for ~/.rbenv'
+lsiown -R abc:abc \
+    /config/.rbenv

root/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-install/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-install/run

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

@@ -1,30 +0,0 @@
-#!/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
-
-if ! command -v apprise; then
-    echo "**** Adding apprise and its deps to package install lists ****"
-    echo "apprise" >> /mod-pip-packages-to-install.list
-    ## Ubuntu
-    if [ -f /usr/bin/apt ]; then
-        echo "\
-            python3 \
-            python3-pip \
-            runc" >> /mod-repo-packages-to-install.list
-    fi
-    # Alpine
-    if [ -f /sbin/apk ]; then
-        echo "\
-            cargo \
-            libffi-dev \
-            openssl-dev \
-            python3 \
-            python3-dev \
-            python3 \
-            py3-pip" >> /mod-repo-packages-to-install.list
-    fi
-else
-    echo "**** apprise already installed, skipping ****"
-fi

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

@@ -1,8 +0,0 @@
-#!/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 "**** Setting up apprise ****"
-apprise blah blah

root/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/up

@@ -1 +0,0 @@
-/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/run

@@ -1,7 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# This is an example service that would run for the mod
-# It depends on init-services, the baseimage hook for start of all longrun services
-
-exec \
-    s6-setuidgid abc run my app

root/etc/s6-overlay/s6-rc.d/svc-mod-imagename-modname/type

@@ -1 +0,0 @@
-longrun