From 0e69b6ac161e20544b61526201650be9efd28d81 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Habov=C5=A1tiak?= Date: Fri, 3 Dec 2021 11:41:39 +0100 Subject: [PATCH] Clarify that electrs is intended for personal use This is quite important information that people occasionally miss. Documenting it visibly should help. Additional context: https://github.com/romanz/electrs/issues/635#issuecomment-985402363 --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 1dfbdae..fad9eff 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ External guides can be out-of-date and have various problems. At least double-check that the guide you're using is actively maintained. If you can't use our guide, please ask about what you don't understand or consider using automated deployments. +Note that this implementation of Electrum server is optimized for **personal/small-scale (family/friends) usage**. +It's a bad idea to run it publicly as it'd expose you to DoS and maybe also other attacks. +If you want to run a public server you may be interested in the [Blockstream fork of electrs](https://github.com/Blockstream/electrs) +which is better optimized for public usage at the cost of consuming *significantly* more resources. + * [Installation from source](doc/install.md) * [Pre-built binaries](doc/binaries.md) (No official binaries available but a beta repository is available for installation) * [Configuration](doc/config.md)