Rename SSH-related variables and scripts for consistency

Renamed environment variables and script files to use 'SSHD' instead of 'SSH' for improved clarity and consistency. Updated documentation and templates to reflect these changes.
sitepilot · Sep 17, 2024 · 67dda39 · 67dda39
1 parent d05a134
commit 67dda39
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/compose.yml b/compose.yml
@@ -7,12 +7,12 @@ services:
       - "2222:2222"
     environment:
       RUNTIME_VERBOSITY: 2
-      RUNTIME_SSH_ENABLED: true
+      RUNTIME_SSHD_ENABLED: true
       RUNTIME_CRON_ENABLED: true
       RUNTIME_USER: captain
       # Generate with: openssl passwd -1
       RUNTIME_PASSWORD_FILE: /files/password # secret
-      RUNTIME_SSH_AUTH_KEYS_FILE: /files/authorized_keys
+      RUNTIME_SSHD_AUTH_KEYS_FILE: /files/authorized_keys
     volumes:
       - ./files:/files
     build:

diff --git a/src/runtime/README.md b/src/runtime/README.md
@@ -20,9 +20,9 @@ persist application data.
 | `/runtime/bin/rchown`              | Recursively change the owner and group of a folder (this allows services and scripts to access this folder while running the container with a non-root user) |
 | `/runtime/entrypoint.d`            | Each file in this folder is executed before the container command is executed                                                                                |
 | `/runtime/entrypoint.d/10-logo.sh` | Displays the brand logo                                                                                                                                      |
-| `/runtime/entrypoint.d/20-info.sh` | Modifies the user name and password                                                                                                                          |
-| `/runtime/entrypoint.d/40-cron.sh` | Enable and configure cron service                                                                                                                            |
-| `/runtime/entrypoint.d/40-ssh.sh`  | Enable and configure sshd service                                                                                                                            |
+| `/runtime/entrypoint.d/20-user.sh` | Configures the user name and password                                                                                                                        |
+| `/runtime/entrypoint.d/40-cron.sh` | Configures the cron service                                                                                                                                  |
+| `/runtime/entrypoint.d/40-sshd.sh` | Configures the sshd service                                                                                                                                  |
 | `/runtime/templates`               | Contains configuration templates                                                                                                                             |
 
 ## Environment

diff --git a/src/runtime/runtime/entrypoint.d/40-ssh.sh → src/runtime/runtime/entrypoint.d/40-sshd.sh b/src/runtime/runtime/entrypoint.d/40-ssh.sh → src/runtime/runtime/entrypoint.d/40-sshd.sh
@@ -3,10 +3,10 @@
 set -e
 set -u
 
-file_env "RUNTIME_SSH_AUTH_KEYS"
+file_env "RUNTIME_SSHD_AUTH_KEYS"
 
-if ${RUNTIME_SSH_ENABLED:-false} to_bool; then
-  info "SSH Server: Enabled"
+if ${RUNTIME_SSHD_ENABLED:-false} to_bool; then
+  info "SSHD: Enabled"
 
   touch  /etc/s6-overlay/s6-rc.d/user/contents.d/sshd
 
@@ -18,5 +18,5 @@ if ${RUNTIME_SSH_ENABLED:-false} to_bool; then
 
   template authorized_keys.tmpl ~/.ssh/authorized_keys
 else
-  info "SSH Server: Disabled"
+  info "SSHD: Disabled"
 fi
diff --git a/src/runtime/runtime/templates/authorized_keys.tmpl b/src/runtime/runtime/templates/authorized_keys.tmpl
@@ -1,2 +1,2 @@
 # This file is managed by the container; any changes will be lost.
-{{ default .Env.RUNTIME_SSH_AUTH_KEYS "" }}
+{{ default .Env.RUNTIME_SSHD_AUTH_KEYS "" }}
diff --git a/src/runtime/runtime/templates/sshd_config.tmpl b/src/runtime/runtime/templates/sshd_config.tmpl
@@ -12,7 +12,7 @@
 
 Include /etc/ssh/sshd_config.d/*.conf
 
-Port {{ default .Env.RUNTIME_SSH_PORT "2222" }}
+Port {{ default .Env.RUNTIME_SSHD_PORT "2222" }}
 #AddressFamily any
 #ListenAddress 0.0.0.0
 #ListenAddress ::