Home Assistant repository to run Actual Budget as an addon
No, the add-on currently only supports the method described below using NGINX Proxy Manager. Nabu Casa and similar ingress based deployments are not currently supported. This is due to limitations in Actual Budget itself. For more info see Issue #5
Both the edge and stable versions are tracked from the official sources automatically and the latest releases should generally be available through Home Assistant within 24 hours. If it has been more than that time, feel free to create a GitHub Issue detailing the problem.
The following are based on obtaining a free DuckDNS domain with a Let's Encrypt certificate. If you want to use your own domain the steps around DuckDNS won't apply.
First to install use the following link to add the repository:
Alternatively go to the Add-On Store, Click the three dots, then Repositories, and then add the following:
https://github.com/sztupy/hassio-actualbudget
Once present you will need to install the following Add-Ons:
Note: the Stable and Edge versions can be installed in parallel but they will use a different datastore. To sync between the two you would need to download a backup and restore that in the other instance manually.
Make sure you have an account set up with DuckDNS http://www.duckdns.org/ Once logged in note the Token
value at the top as it'll be needed. You should also set up your DuckDNS domain. In the examples below we will use hassio-actualbudget.duckdns.org
Once registered go to the Add-On config in Home Assistant for DuckDNS and add your domain into the Domains
section, and your token into the Token
section. Change the accept_terms
section to true
to accept the Let's Encrypt terms and conditions.
Once the changes are done go to Info
and START
the service. After a minute or so it should start up, if there are issues you can check the Log
page for notes
Before you start MariaDB you should go to it's Add-On configuration and change the Login password to something more secure. Once that's done keep the rest of the config and START
the Add-On
There is no configuration for Actual Budget. If you plan on running both the Stable and Edge versions, make sure you change the Port for one of them to something else than the default 5006
. You can then START
the service.
To check it has started you should navigate to http://homeassistant.local:5006
. There will be a warning message about the connection not being secure, which we will sort out in the next step.
Finally START
the Nginx Proxy Manager. Once started go to http://homeassistant.local:81
to set it up
admin@example.com
/ changeme
SSL Certificates
tab, and click Add SSL Certificate
. Use Let's Encrypt
*.hassio-actualbudget.duckdns.org
if you wish to use the certificate for multiple proxies, for example the stable and the edge versions separately.Use a DNS Challenge
DuckDNS
, and in the configuration section below replace the your-duckdns-token
part with your DuckDNS token. Keep the rest of the configSave
After a while the certificate will be ready, and you are allowed to continue
Hosts
-> Proxy hosts
Add Proxy Host
stable.hassio-actualbudget.duckdns.org
http
, forward hostname to homeassistant.local
and port to 5006
(or the port you have configured for Actual Budget)SSL
tab and select the certificate you created earlierSave
The following steps are based on where you would like to access your Actual Budget instance.
If you only wish to access Actual Budget in your local network then no changes are needed on the router. However you will need to set up a local DNS update to make sure that your domain points to your local instant of homeassistant. The easiest way to do it is by changing your hosts file:
ping homeassistant.local
. You should get an IP address that looks something like 192.168.1.181
/etc/hosts
on Windows this will be at c:\Windows\System32\Drivers\etc\hosts
. Note you will need admin privileges to edit these files.hassio-actualbudget.duckdns.org 192.168.1.181
Once you have done this you should be able to access Actual Budget on https://hassio-actualbudget.duckdns.org
with a fully verified certificate and no security errors. Note that you will need to do the hosts
file change for every computer you wish to access your budget from, and your budget will only be accessible from your home network, and not from the internet.
On mobile phones where the hosts file cannot be edited you can use some "DNS filtering" applications, adding your domain above to the filter list (making sure it points to the IP address obtained above)
If you wish to access your Actual Budget instance anywhere in the world, you'll need to update your router settings to forward port 443
to your Home Assistant box. This step is different for each router, and you should consult the manual on how to do this step.
Once this has been done you should be able to access https://hassio-actualbudget.duckdns.org
from anywhere where you have internet connection.
Do note that enabling port forwarding on your home router can expose you to additional security risks, so thread carefully when using this option. Your router's manual might have additional suggestion on how to keep your system as safe as possible after port forwarding is set up.