mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-11-13 01:03:45 +01:00

Files

T

43cb0f04b2 docs(eosdash): describe the setup assistant (#1516 )

Add a how-to page for the first setup with the EOSdash setup assistant and link it from the documentation index, the getting started tutorial and the README.

The status of the measurements step is derived from the configuration only. Say what that means for a system that sends the state of charge on its own.

Add the new Home Assistant step to the list of steps, say that the Home Assistant 
adapter needs EOS to run as an add-on and that an automation has to act on the 
instructions, and update the screenshot to the eleven steps.

The devices step of the setup assistant now asks for the size of each unit,
because the packaged battery and inverter profiles are generic and give no
capacity or nominal power. Say so on the setup page, point to the Profiles
page and link the battery configuration and the inverter profiles.

Signed-off-by: SchaafAlexander <86607129+SchaafAlexander@users.noreply.github.com>
Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>

2026-11-12 14:47:10 +01:00

2.6 KiB

Raw Blame History

% SPDX-License-Identifier: Apache-2.0 (getting-started-page)=

Getting Started

Installation and Running

AkkudoktorEOS can be installed and run using several different methods:

Release package (for stable versions)
Docker image (for easy deployment)
From source (for developers)

See the installation guideline for detailed instructions on each method.

Where to Find AkkudoktorEOS

Release Packages: GitHub Releases
Docker Images: Docker Hub
Source Code: GitHub Repository

Configuration

AkkudoktorEOS uses the EOS.config.json file to manage all configuration settings.

Default Configuration

If essential configuration settings are missing, the application automatically uses a default configuration to get you started quickly.

Custom Configuration Directory

You can specify a custom location for your configuration by setting the EOS_DIR environment variable:

export EOS_DIR=/path/to/your/config

How it works:

If EOS.config.json exists in the EOS_DIR directory → the application uses this configuration
If EOS.config.json doesn't exist → the application copies default.config.json to EOS_DIR as EOS.config.json

Creating Your Configuration

There are three ways to configure AkkudoktorEOS:

EOSdash (Recommended) - The easiest method is to use the web-based dashboard at http://localhost:8504. Its setup assistant takes you through the first configuration step by step.
Manual editing - Create or edit the EOS.config.json file directly in your preferred text editor
Server API - Programmatically change configuration through the server API

For a complete reference of all available configuration options, see the configuration guideline.

Quick Start Example

# Pull the latest docker image
docker pull akkudoktor/eos:latest

# Run the application
docker run -d \
  --name akkudoktoreos \
  -p 8503:8503 \
  -p 8504:8504 \
  -e OPENBLAS_NUM_THREADS=1 \
  -e OMP_NUM_THREADS=1 \
  -e MKL_NUM_THREADS=1 \
  -e EOS_SERVER__HOST=0.0.0.0 \
  -e EOS_SERVER__PORT=8503 \
  -e EOS_SERVER__EOSDASH_HOST=0.0.0.0 \
  -e EOS_SERVER__EOSDASH_PORT=8504 \
  --ulimit nproc=65535:65535 \
  --ulimit nofile=65535:65535 \
  --security-opt seccomp=unconfined \
  akkudoktor/eos:latest

# Access the dashboard
open http://localhost:8504

2.6 KiB Raw Blame History