https://github.com/sudo-tiz/ansible-role-endlessh-go
https://github.com/sudo-tiz/ansible-role-endlessh-go
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sudo-tiz/ansible-role-endlessh-go
- Owner: sudo-Tiz
- License: agpl-3.0
- Created: 2024-01-27T08:39:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-27T12:14:17.000Z (over 2 years ago)
- Last Synced: 2025-05-19T20:14:39.892Z (about 1 year ago)
- Language: Jinja
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Endlessh Ansible Role
**WIP Roles waiting for changes in endlessh-go. DO NOT USE**
[endlessh-go](https://github.com/shizunge/endlessh-go) is a golang implementation of endlessh, a ssh trapit
- with everything run in [Docker](https://www.docker.com/) containers
- powered by [endlessh-go container image](https://hub.docker.com/r/shizunge/endlessh-go)
## Installing
To configure and install endlessh on your own server(s), you should use a playbook like [Mother of all self-hosting](https://github.com/mother-of-all-self-hosting/mash-playbook) or write your own.
## Configuration
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
```yaml
########################################################################
# #
# endlessh #
# #
########################################################################
endlessh_enabled: true
########################################################################
# #
# /endlessh #
# #
########################################################################
```
You can overwrite the default config variable using ``endlessh_config`` variable.
Here is an exemple to use ssh port 22 on host and 2222 on container
```yaml
endlessh_config:
sshPorts:
- [22, 2222]
```
See the full list of options in the [default/main.yml](default/main.yml) file
### Exposing the web interface
By setting a hostname you will expose endlessh on this domain.
Usually you should also set up basic_auth in this case, otherwise everyone will be able to access your metrics
```yaml
endlessh_hostname: endlessh.example.org
# Uncomment following lines to add basic auth
#endlessh_container_labels_metrics_middleware_basic_auth_enabled: true
#endlessh_container_labels_metrics_middleware_basic_auth_users : ':'
```