Initial commit

docs/setup/_category_.json

@@ -0,0 +1,9 @@
+{
+  "label": "⚙️ Setup",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Learn how to configure EcoDash, from the basics to the most advanced settings. If you're just getting started, follow the tutorials in this section in order.",
+    "slug": "/setup",
+  }
+}

docs/setup/admin-panel.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 2
+---
+
+# ⚙️ Admin Panel
+
+The Admin Panel is the right place to configure and customize EcoDash.
+
+## How to access the Admin Panel
+
+If this is the first time you've run EcoDash, you will load directly into the Admin Panel, and you won't be able to leave it until you've changed the settings.
+
+After the first run, click the "Admin" button in the left side of the navbar, or in the hamburger menu from mobile devices.
+
+If you do not see that button, you can still access the admin panel by appending "/admin" to the URL of your EcoDash homepage.
+
+## Configuration
+
+### HomeAssistant
+
+- **HomeAssistant's base URL**: the base URL which you use to access HomeAssistant on your server. It should be something like `http://INTERNAL_IP_ADDRESS:8123/` or `https://homeassistant.youdomain.com/`.
+- **HomeAssistant's API Key**:
+- **Installation date**: Select the date of the first day in which your server's consumption was  logged in its entirety. Users won't be able to see consumption data  before this date.
+
+### Sensors
+
+- **Polled Smart Energy Summation entity ID**: After your plug is added in HomeAssistant, get it in Settings -> Devices & Services -> Select the smart plug (or the Zigbee dongle -> Smart plug) -> look for an entity called like "[Name of your plug]  Polledsmartenergysummation" -> Settings -> Copy the Entity ID.  Check that the unit of measurement in the "Info" tab is kWh.
+- **CO2 signal Grid fossil fuel percentage entity ID**: After the CO2 Signal integration is enabled in HomeAssistant, get it in Settings -> Devices & Services -> CO2 Signal "2 entities" -> CO2 signal Grid fossil fuel percentage -> Settings -> Copy the Entity ID.  Check that the unit of measurement in the "Info" tab is %.
+
+### Admin account
+
+- **Username**: The username which you will have to enter the Admin Panel. Note it doesn't have to be the same as HomeAssistant.
+- **Password**: The password which you will have to enter the Admin Panel. Note it doesn't have to be the same as HomeAssistant.
+
+### Personalization
+
+- **Theme**: This setting will allow you to change the theme. There are no alternative themes at the moment.
+- **Dashboard name**: This will change the name shown in the top-left corner of the screen.
+

docs/setup/advanced.md

@@ -0,0 +1,9 @@
+---
+sidebar_position: 3
+---
+
+# 📚 Advanced configuration
+
+This section describes how to customize EcoDash beyond the Admin Panel's limits. It's not necessary to change these settings.
+
+This section is still a work in progress. It will be published before release v1.

docs/setup/ecodash.md

@@ -0,0 +1,15 @@
+---
+sidebar_position: 1
+---
+
+# 🏠 HomeAssistant Setup
+
+EcoDash requires HomeAssistant to run. Its purpose is translating the protocols that different smart plugs use into a simple universal HTTP API that EcoDash can use.
+
+1.  Install HomeAssistant: follow [this](https://www.home-assistant.io/installation/) guide. The installation method you choose doesn't matter.
+2. Add your smart energy monitor. Go to Settings -> Devices and Services -> Add Integration -> Choose your device type. Follow [this](https://www.home-assistant.io/integrations/zha/#configuration---gui) guide for Zigbee devices.
+3. Generate an API Key for EcoDash:
+   1. Go to your profile (bottom left of the page - click on your account name)
+   2. Scroll to "Long-Lived Access Tokens"
+   3. Press "Create token", give it a name and click OK
+   4. Copy the token and paste it in a safe place.