readme-vars.yml

---

# project information
project_name: endlessh
project_url: "https://github.com/skeeto/endlessh"
project_logo: "https://github.com/linuxserver/docker-templates/raw/master/linuxserver.io/img/openssh-server-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is an SSH tarpit that very slowly sends an endless, random SSH banner. It keeps SSH clients locked up for hours or even days at a time. The purpose is to put your real SSH server on another port and then let the script kiddies get stuck in this tarpit instead of bothering a real server."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

project_deprecation_status: true
project_deprecation_message: |
  We recommend looking at an alternative implementation such as:
  https://github.com/shizunge/endlessh-go/

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}

# development version
development_versions: false

# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_ports: true
param_ports:
  - { external_port: "22", internal_port: "2222", port_desc: "ssh port" }

# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "MSDELAY", env_value: "10000", desc: "The endless banner is sent one line at a time. This is the delay in milliseconds between individual lines." }
  - { env_var: "MAXLINES", env_value: "32", desc: "The length of each line is randomized. This controls the maximum length of each line. Shorter lines may keep clients on for longer if they give up after a certain number of bytes." }
  - { env_var: "MAXCLIENTS", env_value: "4096", desc: "Maximum number of connections to accept at a time. Connections beyond this are not immediately rejected, but will wait in the queue." }
  - { env_var: "LOGFILE", env_value: "false", desc: "By default, the app logs to container log. If this is set to `true`, the log will be output to file under `/config/logs/endlessh` (`/config` needs to be mapped)." }
  - { env_var: "BINDFAMILY", env_value: "", desc: "By default, the app binds to IPv4 and IPv6 addresses. Set it to `4` or `6` to bind to IPv4 only or IPv6 only, respectively. Leave blank to bind to both." }
opt_param_usage_include_vols: true
opt_param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/appdata", desc: "Required if `LOGFILE` is set to `true`." }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  The app listens on the port mapped for ssh connections. To log to file, set the environment variable `LOGFILE` to `true` and map a volume for `/config`. The logs will be under `/config/logs/endlessh`.

# changelog
changelogs:
  - { date: "20.03.24:", desc: "Deprecate image." }
  - { date: "12.06.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }
  - { date: "05.03.23:", desc: "Rebase to Alpine 3.17." }
  - { date: "23.09.22:", desc: "Migrate to s6v3." }
  - { date: "20.07.22:", desc: "Rebase to Alpine 3.16." }
  - { date: "16.04.22:", desc: "Rebase to Alpine 3.15." }
  - { date: "07.10.21:", desc: "Fix typo on MAXLINES var." }
  - { date: "08.06.21:", desc: "Add BINDFAMILY option." }
  - { date: "16.04.21:", desc: "Initial Release." }