From ce28534ade067ec4bae81c9468d7090655051843 Mon Sep 17 00:00:00 2001 From: Georg Ledermann Date: Mon, 15 Jul 2024 10:31:54 +0200 Subject: [PATCH] Replace this guide by configurator --- README.md | 50 ++------------------------------------------------ old-README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 48 deletions(-) create mode 100644 old-README.md diff --git a/README.md b/README.md index 2bfdb5d..8f6c1d0 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,5 @@ # SOLECTRUS Hosting Guide -**Currently, I'm working on the SOLECTRUS Configurator, a web-based tool to configure your SOLECTRUS installation. It is intended to make the installation process easier and more user-friendly and will replace the current guides. The Configurator can already be checked out at [configurator.solectrus.de](https://configurator.solectrus.de). BEWARE: It will install beta versions of SOLECTRUS and is not yet fully tested. If you are not interested in experimenting, please use the guides below.** +**This guide has been replaced by the new SOLECTRUS Configurator. Please check out [configurator.solectrus.de](https://configurator.solectrus.de)** -There are different ways to install **SOLECTRUS**: - -## A: You have a SENEC.Home? - -If you have a SENEC.Home battery system, installing is simple. The toolchain is quiet stable and used by many users. Please choose one of the following guides: - -1. [Local installation on Synology NAS](/guide/synology) - - You need a Synology NAS (Kernel v4+) with Docker installed (tested with Synology DS220+ with 10GB RAM) - -2. [Local installation on Raspberry Pi](/guide/raspberry-pi) - - You need a Raspberry Pi running a 64bit OS with Docker installed (tested with Raspberry Pi 4 Model B Rev 1.4 with 8GB RAM) - -3. [Distributed installation on Raspberry Pi + remote server](/guide/external-server) - - You need a Raspberry Pi at home **and** a remote server somewhere on the internet (tested with Hetzner Cloud) - - Server costs at Hetzner: €4,51 per month - -4. [Remote installation with cloud access to SENEC](/guide/external-server-cloud) - - You need a remote server somewhere on the internet (tested with Hetzner Cloud). No Raspberry or other local hardware required. Data is pulled from SENEC via cloud access by using your credentials from mein-senec.de - **Please note: Cloud access is new and not yet tested by many users.** - - Server costs at Hetzner: €4,51 per month - -## B: You have a PV system, but no SENEC? - -If you do not have a SENEC battery system, you may still be able to use **SOLECTRUS**. There is a brand new [MQQT-collector](https://github.com/solectrus/mqtt-collector), so SOLECTRUS can be used with any PV device that supports MQTT. Please note that the MQTT-collector is in an experimental stage and I would appreciate your feedback. - -There are two guides available, both targeting **experienced** users having a deeper understanding of MQTT: - -1. [Installation for use with ioBroker](/guide/mqtt-iobroker/) - - You need: - - - Linux server (64bit, Kernel v4+) with Docker installed (Raspberry Pi, Synology NAS, virtual machine, etc.) - - Running instance of [ioBroker](https://www.iobroker.net/), which already includes a MQTT broker - -2. [Installation for use with evcc](/guide/mqtt-evcc/) - - You need: - - - Linux server (64bit, Kernel v4+) with Docker installed (Raspberry Pi, Synology NAS, virtual machine, etc.) - - Running instance of [evcc](https://evcc.io/) - - MQTT broker +[The old guide](/old-README.md) is still available, but is no longer maintained. diff --git a/old-README.md b/old-README.md new file mode 100644 index 0000000..d2b004c --- /dev/null +++ b/old-README.md @@ -0,0 +1,47 @@ +There are different ways to install **SOLECTRUS**: + +## A: You have a SENEC.Home? + +If you have a SENEC.Home battery system, installing is simple. The toolchain is quiet stable and used by many users. Please choose one of the following guides: + +1. [Local installation on Synology NAS](/guide/synology) + + You need a Synology NAS (Kernel v4+) with Docker installed (tested with Synology DS220+ with 10GB RAM) + +2. [Local installation on Raspberry Pi](/guide/raspberry-pi) + + You need a Raspberry Pi running a 64bit OS with Docker installed (tested with Raspberry Pi 4 Model B Rev 1.4 with 8GB RAM) + +3. [Distributed installation on Raspberry Pi + remote server](/guide/external-server) + + You need a Raspberry Pi at home **and** a remote server somewhere on the internet (tested with Hetzner Cloud) + + Server costs at Hetzner: €4,51 per month + +4. [Remote installation with cloud access to SENEC](/guide/external-server-cloud) + + You need a remote server somewhere on the internet (tested with Hetzner Cloud). No Raspberry or other local hardware required. Data is pulled from SENEC via cloud access by using your credentials from mein-senec.de + **Please note: Cloud access is new and not yet tested by many users.** + + Server costs at Hetzner: €4,51 per month + +## B: You have a PV system, but no SENEC? + +If you do not have a SENEC battery system, you may still be able to use **SOLECTRUS**. There is a brand new [MQQT-collector](https://github.com/solectrus/mqtt-collector), so SOLECTRUS can be used with any PV device that supports MQTT. Please note that the MQTT-collector is in an experimental stage and I would appreciate your feedback. + +There are two guides available, both targeting **experienced** users having a deeper understanding of MQTT: + +1. [Installation for use with ioBroker](/guide/mqtt-iobroker/) + + You need: + + - Linux server (64bit, Kernel v4+) with Docker installed (Raspberry Pi, Synology NAS, virtual machine, etc.) + - Running instance of [ioBroker](https://www.iobroker.net/), which already includes a MQTT broker + +2. [Installation for use with evcc](/guide/mqtt-evcc/) + + You need: + + - Linux server (64bit, Kernel v4+) with Docker installed (Raspberry Pi, Synology NAS, virtual machine, etc.) + - Running instance of [evcc](https://evcc.io/) + - MQTT broker