mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-26 16:11:44 +00:00
Experiment with PDF generation
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
102
docs/recipes/wetty.md
Normal file
102
docs/recipes/wetty.md
Normal file
@@ -0,0 +1,102 @@
|
||||
---
|
||||
title: Use wetty under Docker for SSH in the browser
|
||||
description: Use weTTY to run a terminal in a browser, baby!
|
||||
---
|
||||
|
||||
# Wetty
|
||||
|
||||
[Wetty](https://github.com/krishnasrinivas/wetty) is a responsive, modern terminal, in your web browser. Yes, your browser. When combined with secure authentication and SSL encryption, it becomes a useful tool for quick and easy remote access.
|
||||
|
||||
{ loading=lazy }
|
||||
|
||||
## Why would you need SSH in a browser window?
|
||||
|
||||
Need shell access to a node with no external access? Deploy Wetty behind an [traefik-forward-auth](/docker-swarm/traefik-forward-auth/) with a SSL-terminating reverse proxy ([traefik](/docker-swarm/traefik/)), and suddenly you have the means to SSH to your private host from any web browser (_protected by your [traefik-forward-auth](/docker-swarm/traefik-forward-auth/) of course._)
|
||||
|
||||
Here are some other possible use cases:
|
||||
|
||||
1. Access to SSH / CLI from an environment where outgoing SSH is locked down, or SSH client isn't / can't be installed. (_i.e., a corporate network_)
|
||||
2. Access to long-running processes inside a tmux session (_like [irrsi](https://irssi.org/)_)
|
||||
3. Remote access to a VM / [container running Kali linux](https://gitlab.com/kalilinux/build-scripts/kali-docker), for penetration testing
|
||||
|
||||
--8<-- "recipe-standard-ingredients.md"
|
||||
|
||||
## Preparation
|
||||
|
||||
### Setup data locations
|
||||
|
||||
First we create a directory to hold the data which wetty will serve:
|
||||
|
||||
```bash
|
||||
mkdir /var/data/config/wetty
|
||||
cd /var/data/config/wetty
|
||||
```
|
||||
|
||||
### Prepare environment
|
||||
|
||||
Create `/var/data/config/wetty.env`, and populate with the following variables
|
||||
|
||||
```yaml
|
||||
|
||||
# To use WeTTY to SSH to a host besides the (mostly useless) alpine container it comes with
|
||||
SSHHOST=batcomputer.batcave.com
|
||||
SSHUSER=batman
|
||||
|
||||
```
|
||||
|
||||
### Setup Docker Swarm
|
||||
|
||||
Create a docker swarm config file in docker-compose syntax (v3), something like this:
|
||||
|
||||
--8<-- "premix-cta.md"
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
services:
|
||||
wetty:
|
||||
image: krishnasrinivas/wetty
|
||||
env_file : /var/data/config/wetty/wetty.env
|
||||
deploy:
|
||||
labels:
|
||||
# traefik common
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network=traefik_public
|
||||
|
||||
# traefikv1
|
||||
- traefik.frontend.rule=Host:wetty.example.com
|
||||
- traefik.port=3000
|
||||
|
||||
# traefikv2
|
||||
- "traefik.http.routers.wetty.rule=Host(`wetty.example.com`)"
|
||||
- "traefik.http.services.wetty.loadbalancer.server.port=3000"
|
||||
- "traefik.enable=true"
|
||||
- "traefik.http.routers.wetty.middlewares=forward-auth@file"
|
||||
networks:
|
||||
- internal
|
||||
- traefik_public
|
||||
|
||||
networks:
|
||||
traefik_public:
|
||||
external: true
|
||||
internal:
|
||||
driver: overlay
|
||||
ipam:
|
||||
config:
|
||||
- subnet: 172.16.45.0/24
|
||||
```
|
||||
|
||||
--8<-- "reference-networks.md"
|
||||
|
||||
## Serving
|
||||
|
||||
### Launch Wetty stack
|
||||
|
||||
Launch the Wetty stack by running ```docker stack deploy wetty -c <path -to-docker-compose.yml>```
|
||||
|
||||
Browse to your new browser-cli-terminal at https://**YOUR-FQDN**. Authenticate with your OAuth provider, and then proceed to login, either to the remote host you specified (_batcomputer.batcave.com, in the example above_), or using user and password "term" to log directly into the Wetty alpine container (_from which you can establish egress SSH_)
|
||||
|
||||
[^1]: You could set SSHHOST to the IP of the "docker0" interface on your host, which is normally 172.17.0.1. (_Or run ```/sbin/ip route|awk '/default/ { print $3 }'``` in the container_) This would then provide you the ability to remote-manage your swarm with only web access to Wetty.
|
||||
|
||||
[^2]: The inclusion of Wetty was due to the efforts of @gpulido in our [Discord server](http://chat.funkypenguin.co.nz). Thanks Gabriel!
|
||||
|
||||
--8<-- "recipe-footer.md"
|
||||
Reference in New Issue
Block a user