1![logo](logo.png)
 2
 3### parados
 4A simple home media server for UNIX systems.
 5
 6### Build
 7```sh
 8make release # or debug
 9make install-conf
10./parados -v
11./parados
12```
13
14### Startup Scripts
15Parados has platform specific init scripts to launch it. As
16of now, there are: OpenBSD(rcctl), OpenRC(rc-service)
17startup scripts.
18
19```sh
20make install-rcctl # Change to init platform script
21```
22> If you want to contribute more init scripts, feel free to
23> do so; any help appreciated!
24
25### Documentation
26All documentation can be found in [docs/](docs/)
27```sh
28man 1 parados       # Parados server usage
29man 7 parados       # Interfacing with parados
30man 5 parados.conf  # Parados configuration
31```
32
33### Clients
34In the parados Git repo, you can find two clients which use
35the protocol.
36
37First, _gorados_ is a Go based WebUI; it is
38bare bones and if anyone would like to contribute, feel free
39to do so!
40
41Second, _shrados_ is a client written in POSIX shell. A list
42of dependancies are in the [README](clients/shrados/README.md).
43It behaves like a parados shell and is the one I peronally
44use.
45
46### Issues
47If you find a bug or would like to suggest something,
48open an issue on the GitHub page. Issues should be
49detailed and give steps on replicating the issue if
50possible.
51
52### Contributions
53If you wish to contribute, create a PR with details
54on what is being changed, added or removed. **The code
55style (indentation, variable names, formatting) should
56_not_ be altered.** Please make sure you know how the
57formatting of the project looks like before submitting
58a PR.
59
60> Note: it is recommended you don't expose parados itself
61> but rather the client if using a web client. Also setting
62> a HTTPS reverse proxy is a good idea
63
64### Repository Links
65[[GitHub](https://github.com/uint23/parados)] [[SourceHut](https://sr.ht/~uint/parados)]
66