Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sudo-tiz/ansible-role-endlessh
https://github.com/sudo-tiz/ansible-role-endlessh
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sudo-tiz/ansible-role-endlessh
- Owner: sudo-Tiz
- License: agpl-3.0
- Created: 2024-07-06T14:37:56.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-06T14:43:50.000Z (6 months ago)
- Last Synced: 2024-07-06T15:57:56.379Z (6 months 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
[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 #
# #
########################################################################
```
See the full list of options in the [default/main.yml](default/main.yml) file
## Exporting Prometheus metrics
Default port is 2112
Default entrypoint is /metrics
use environment variable
```yaml
endlessh_container_extra_arguments_custom:
- "-enable_prometheus"
```
### Exposing the web interface
By setting a hostname you will expose endlessh metrics publicly.
```yaml
endlessh_hostname: endlessh.example.org
# Uncomment following lines to add basic auth (Recommended°
#endlessh_container_labels_metrics_middleware_basic_auth_enabled: true
#endlessh_container_labels_metrics_middleware_basic_auth_users : ':'
```