commit 363bc86
uint
·
2026-03-10 18:55:08 +0000 UTC
parent b01b444
update README to mention clients, add safety notice at bottom of README
1 files changed,
+17,
-0
+17,
-0
1@@ -19,6 +19,19 @@ man 7 parados # Interfacing with parados
2 man 5 parados.conf # Parados configuration
3 ```
4
5+### Clients
6+In the parados Git repo, you can find two clients which use
7+the protocol.
8+
9+First, _gorados_ is a Go based WebUI; it is
10+bare bones and if anyone would like to contribute, feel free
11+to do so!
12+
13+Second, _shrados_ is a client written in POSIX shell. A list
14+of dependancies are in the [README](clients/shrados/README.md).
15+It behaves like a parados shell and is the one I peronally
16+use.
17+
18 ### Issues
19 If you find a bug or would like to suggest something,
20 open an issue on the GitHub page. Issues should be
21@@ -33,6 +46,10 @@ _not_ be altered.** Please make sure you know how the
22 formatting of the project looks like before submitting
23 a PR.
24
25+> Note: it is recommended you don't expose parados itself
26+> but rather the client if using a web client. Also setting
27+> a HTTPS reverse proxy is a good idea
28+
29 ### Repository Links
30 [[GitHub](https://github.com/uint23/parados)] [[SourceHut](https://sr.ht/~uint/parados)]
31