From cd57d42e63a950cbb291c371f22c9716b4579228 Mon Sep 17 00:00:00 2001 From: Lukasz Janyst Date: Tue, 17 May 2022 16:21:07 +0200 Subject: [PATCH] docs: Add a security note --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index fcca2fc..b263a0b 100644 --- a/README.md +++ b/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