Installation guide
Install TED in a few minutes
Three methods depending on your hardware: Synology NAS with a guided script, custom Docker, or directly in Home Assistant OS. Your settings stay at home, on your own machine.
Before you start
- Home Assistant working and reachable on your local network.
- Your inverters and batteries visible in Home Assistant, through their brand's integration.
- A long-lived access token from Home Assistant: Profile › Security › Long-lived access tokens › Create token. Not needed with the Home Assistant OS app.
- An electricity meter whose measurement (import and export) reaches Home Assistant, or a Shelly read directly by IP.
Synology / NAS Recommended for 24/7
The provided script loads the image, creates the folders and the Docker network, reads your Home Assistant token and starts TED.
- 1
Copy the files to the NAS
Download
ted-bot-v3.2.tar.gz,install_ted_prebuilt.shand your license, then copy the image and the script to/volume1/docker/ted-bot(for example with File Station). - 2
Connect over SSH
On Synology: Control Panel › Terminal & SNMP › enable the SSH service, then connect to the NAS from a terminal.
- 3
Run the installation
Paste the block below, replacing
COLLER_ICI_VOTRE_TOKEN_HAwith your token. Adjust the Home Assistant address and the Docker network if needed. - 4
Open the interface
Go to
http://NAS-IP:5001, import your license in Paramètres (Settings), then follow the getting-started guide.
ARM-based NAS? Download the ARM64 image (ted-bot-v3.2-arm64.tar.gz) and put that file name in IMAGE_ARCHIVE: everything else is identical.
cd /volume1/docker/ted-bot
mkdir -p runtime logs
printf "%s\n" "COLLER_ICI_VOTRE_TOKEN_HA" > ha_token.txt
sudo CONTAINER_NAME=ted-bot \
BASE_DIR=/volume1/docker/ted-bot \
HA_TOKEN_FILE=/volume1/docker/ted-bot/ha_token.txt \
NETWORK_NAME=iot-net \
IMAGE_ARCHIVE=./ted-bot-v3.2.tar.gz \
SKIP_PULL=1 \
HA_URL=http://homeassistant:8123 \
INTERACTIVE_PATH_PROMPT=0 \
INTERACTIVE_NETWORK_PROMPT=0 \
INTERACTIVE_HA_TOKEN_PROMPT=0 \
bash install_ted_prebuilt.sh
sudo docker ps --filter name=ted-bot
sudo docker logs --tail 80 ted-bot
Advanced Docker Integrators
No script, Docker only: you stay in control of the network, ports and volumes.
- 1
Prepare the environment
Create your persistent folders (
runtimeandlogs), choose the Docker network shared with Home Assistant and the exposed port. - 2
Load the image
From the
ted-bot-v3.2.tar.gzarchive (49 Mo). - 3
Start the container
With your environment variables and volumes, then open the exposed interface.
Raspberry Pi or another ARM processor? Load the ARM64 image (ted-bot-v3.2-arm64.tar.gz) instead: it also loads as ted-bot:latest, so the commands do not change.
gunzip -c ted-bot-v3.2.tar.gz | sudo docker load
sudo docker rm -f ted-bot >/dev/null 2>&1 || true
sudo docker run -d \
--name ted-bot \
--network iot-net \
--restart unless-stopped \
-p 5001:5000 \
-e DEPLOYMENT_ENV=docker \
-e HA_URL=http://homeassistant:8123 \
-e HA_TOKEN="YOUR_HA_TOKEN" \
-e WEB_PORT=5000 \
-e LOGS_DIR=/data/logs \
-e RUNTIME_FILES_DIR=/data/runtime \
-v /volume1/docker/ted-bot/runtime:/data/runtime \
-v /volume1/docker/ted-bot/logs:/data/logs \
ted-bot:latest python app_web.pyc
Home Assistant OS No Docker
TED installs as a Home Assistant app on the same machine: Raspberry Pi, Home Assistant Green or Yellow, mini-PC or virtual machine.
- 1
Download the app
On the Download page, choose "Home Assistant OS": you get your license and the
ted-bot-v3.2-home-assistant.zippackage. - 2
Drop it into Home Assistant
One command to paste into the Home Assistant Terminal, or the
tedfolder to copy into theaddonsshare. - 3
Install and start TED
Settings › Apps › Store › ⋮ › Check for updates, then TED under "Local apps" › Install.
- 4
Open TED from the sidebar
Import your license in Paramètres (Settings), then follow the getting-started guide. The connection to Home Assistant is automatic.
Troubleshooting
A problem during installation?
TED's interface does not open
Check the logs with sudo docker logs --tail 80 ted-bot.
The Home Assistant connection test fails
Check that the Home Assistant address can be reached from the machine running TED and that the token is valid and complete. With Docker, the container must be on the same network as Home Assistant (NETWORK_NAME) or use its IP address (HA_HOST_IP).
Port 5001 is already used on my NAS
Add HOST_WEB_PORT=5002 (or another free port) to the installation command, then open the interface on that port.
Where do I import my license?
In TED's interface, Paramètres (Settings) tab. If you lost the file, request it again on the Download page with the same email address.
Still stuck? Ask for help on Discord
TED is running? Move on to getting started.
License, Home Assistant, meter and first inverters: the initial setup explained step by step.