docs: Add a security note

create-reload-action
Lukasz Janyst 4 years ago
parent 888ba677ca
commit cd57d42e63
No known key found for this signature in database
GPG Key ID: 32DE641041F17A9A
  1. 4
      README.md

@ -29,6 +29,10 @@ To that end, Peroxide:
Server setup
------------
**Note:** This software has not been thoroughly reviewed for security.
Therefore, I strongly advise against running it on the open Internet - run it
locally or use a trusted VPN.
Peroxide reads its settings from a configuration file located in
`/etc/peroxide.conf` by default. This configuration file holds a bunch of
key-value pairs in YAML format. There's an example in the root of the source

Loading…
Cancel
Save