docs: Add a warning

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

@ -9,16 +9,9 @@ running it on the open Internet.
Peroxide is a fork of the [ProtonMail bridge][1]. Its goal is to be much like Peroxide is a fork of the [ProtonMail bridge][1]. Its goal is to be much like
[Hydroxide][2] except with as much re-use of the upstream code as possible. The [Hydroxide][2] except with as much re-use of the upstream code as possible. The
re-use ensures that the upstream changes to the service APIs can be merged in as re-use ensures that the upstream changes to the service APIs can be merged in as
fast and as efficiently as possible. At the same time, Peroxide aims to: fast and as efficiently as possible. At the same time, Peroxide aims to run as a
server providing data access using standard protocols so that a wide variety of
* run as a server providing data access using standard protocols so that a wide devices can use their native productivity tools.
variety of devices can use their native productivity tools instead of
ProtonMail's proprietary ones
* implement features that are missing from the upstream version because they
are hard to make work with Outlook
* make things easy to hack on without a deluge of dependencies providing little
value in the context of the two above points
* limit the exposure to supply chain attacs
To that end, Peroxide: To that end, Peroxide:
@ -36,6 +29,9 @@ To that end, Peroxide:
Server setup Server setup
------------ ------------
**Warning**: This software has not been thoroughly reviewed for security.
You should only use it if you know what you're doing. I strongly advise against
running it on the open Internet.
Run the `install.sh` script to install peroxide in your system. Run the `install.sh` script to install peroxide in your system.

Loading…
Cancel
Save