Install on a Raspberry Pi
Flash EpilykosOS to a microSD card and finish setup in your browser.
Epilykos Wiki
Guides for installing, connecting and running Epilykos, the self-hosted energy dashboard.
Install with Docker
Run Epilykos with Docker Compose on any system that runs Docker.
EpilykosOS is an operating system made just for running Epilykos on a Raspberry Pi. You write it to a memory card, power the Pi on, and finish setting up in your browser. From then on it runs, updates and recovers by itself. There's more about what it does on the EpilykosOS page.
What you need
- A Raspberry Pi 3B. Support for the Pi 4 and Pi 5 is planned.
- A microSD card of 32 GB or more. Settings → System warns you about smaller cards; 64 GB is recommended.
- An Ethernet cable, or a 2.4 GHz Wi-Fi network (the Pi 3B can't see 5 GHz networks).
- A computer to write the card with, using Raspberry Pi Imager or balenaEtcher.
Install
Download the image
Get the latest image from the EpilykosOS releases page.
Write the card
Write the image to the microSD card with Raspberry Pi Imager or balenaEtcher.
If you use Raspberry Pi Imager, it can set up your Wi-Fi for you. Add EpilykosOS to its list of operating systems by entering this repository URL in Imager's app options:
https://github.com/ashipaek0/epilykos-os/releases/latest/download/epilykos-os-imager.jsonThen choose EpilykosOS from the list, and enter your Wi-Fi network and Wi-Fi country in Imager's settings before writing the card.
Connect it to your network
Any one of these will do:
- Ethernet: plug in a cable and you're done.
- Raspberry Pi Imager: the Wi-Fi details you entered in the previous step.
- A
wifi.txtfile on the card's boot drive; see Wi-Fi setup. - Your phone, over Bluetooth, once the box has started; see Wi-Fi setup.
Power it on and open the dashboard
Put the card in the Pi and plug in the power. Once it has started up, open this address in a browser on the same network:
http://epilykos.local:3000The setup wizard opens. On EpilykosOS it also asks for your time zone, so daily totals and forecasts line up with your local day.
Can't open the dashboard?
From another computer, try pinging a third device on the same network. If that fails too, your router is keeping devices apart from each other: turn off its "AP isolation" or "client isolation" setting and restart it. Plugging the Pi in with an Ethernet cable also gets around it.
Change the address
You can change the dashboard's port in Settings → Network → Dashboard address, to port 80 or any
port from 1024 to 65535. With port 80, the address is simply http://epilykos.local. Epilykos
restarts on the new port and the page follows it there.
Next steps
Last updated on