Skip to content

Commit

Permalink
fix (doc): README
Browse files Browse the repository at this point in the history
  • Loading branch information
mickael-kerjean committed Jan 18, 2024
1 parent 2cc6434 commit 375b69e
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,20 @@ I've build WebPty so you can't missuse it in a way that could do something bad m
- rely on SSH to authorise users meaning only people who already have an account on the box can connect to webpty
- I have it exposed on the internet to manage my servers which run in prod at [Filestash](https://github.com/mickael-kerjean/filestash)

# Documentation

Installation: http://www.webpty.io/

# Fleet server

WebPty works with an associated web fleet server to centralise all your devices in one place even though they don't sit in the same network:
WebPty works with an associated [web fleet server](https://github.com/mickael-kerjean/webpty/tree/main/webfleet) to centralise all your devices in one place even though they don't sit in the same network:

<img src="https://raw.githubusercontent.com/mickael-kerjean/webpty/main/.assets/webfleet-banner.png" alt="WebFleet server" />

# Documentation

- webpty installation guide: http://www.webpty.io/
- run webfleet (alpha release):
```
# run the fleet server
sudo CERTBOT=home.webptio.io AUTH_DRIVER=simple AUTH_USER=username:password ./webfleet.bin
# attach your webpty to the fleet server
FLEET=home.webpty.io go run ./main.go
```

0 comments on commit 375b69e

Please sign in to comment.