diff --git a/_Sidebar.md b/_Sidebar.md index 624394d..2ed6656 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -1,11 +1,11 @@ ### 🌿 EcoDash - [📖 Home](./Home) -- [👷 Building from Source](./Building) +- [👷 Building from Source](./building) - Installing - - [🐳 Docker](./Installing%20on%20Docker) - - [🐧 Linux](./Installing%20on%20Linux) + - [🐳 Docker](./install-docker) + - [🐧 Linux](./install-linux) - Configuration - - [🏠 HomeAssistant Setup](./HomeAssistant%20Setup) - - [⚙️ Admin Panel](./Admin%20Panel) - - [📚 Advanced Configuration](./Advanced%20Configuration) + - [🏠 HomeAssistant Setup](./config-homeassistant) + - [⚙️ Admin Panel](./config-admin-panel) + - [📚 Advanced Configuration](./config-advanced) diff --git a/Building.md b/building.md similarity index 100% rename from Building.md rename to building.md diff --git a/Admin Panel.md b/config-admin-panel.md similarity index 86% rename from Admin Panel.md rename to config-admin-panel.md index db21f7a..f8b7944 100644 --- a/Admin Panel.md +++ b/config-admin-panel.md @@ -15,12 +15,12 @@ If you do not see that button, you can still access the admin panel by appending ### 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.yourdomain.com/`. -- **HomeAssistant's API Key**: Read [HomeAssistant Setup](./HomeAssistant Setup) to learn how to get it. +- **HomeAssistant's API Key**: Read [HomeAssistant Setup](./config-homeassistant) to learn how to get it. - **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. +- **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 the entity which shows the total consumed energy in kWh, which is often 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 diff --git a/Advanced Configuration.md b/config-advanced.md similarity index 100% rename from Advanced Configuration.md rename to config-advanced.md diff --git a/HomeAssistant Setup.md b/config-homeassistant.md similarity index 100% rename from HomeAssistant Setup.md rename to config-homeassistant.md diff --git a/Installing on Docker.md b/install-docker.md similarity index 97% rename from Installing on Docker.md rename to install-docker.md index ed464d6..d0013d1 100644 --- a/Installing on Docker.md +++ b/install-docker.md @@ -2,7 +2,7 @@ Docker is the recommended deployment method for EcoDash. It allows to run on different architectures and operating systems without hassle. -Pre-built Docker containers are offered for Linux on ARM and x86_64. If you're not on a supported architecture or operating system, please check the [Building the container](./Building) guide. +Pre-built Docker containers are offered for Linux on ARM and x86_64. If you're not on a supported architecture or operating system, please check the [Building the container](./building) guide. ### Tags diff --git a/Installing on Linux.md b/install-linux.md similarity index 98% rename from Installing on Linux.md rename to install-linux.md index f024490..3cfc83a 100644 --- a/Installing on Linux.md +++ b/install-linux.md @@ -1,7 +1,7 @@ # 🐧 Linux Pre-built binaries are available for Linux systems with x86_64 and ARM architecture. They should work on any distribution, but haven't been tested on all. Please open an issue if problems arise. -If you're not on a supported architecture, please check the [Building on Linux](./Building) guide. +If you're not on a supported architecture, please check the [Building on Linux](./building) guide. ## Download