OttPeterR / addon-babybuddy

BabyBuddy, wrapped into a Home Assistant addon

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Baby Buddy - Home Assistant Addon

Run Baby Buddy on Home Assistant!

Other Important Repos

  • Baby Buddy Integration
    • get BB data as sensors and entities in HA so you can automate! You can install this from HACS.
  • Baby Buddy Source Code
    • application code is located in that repo, the repo you are currently viewing simply takes that code and wraps it up into a Home Assistant addon

Contributing

PRs welcome!

If you'd like to make a modification to Baby Buddy, fork this repo and add your changes! There's a github action that builds the container so you can check that your code works. See here for more info about developing Home Assistant Add-Ons

Accessing Baby Buddy

Access BB though ingress in HA as you normally would. If you would like to skip the login process, there is a way to auto-login, but please be aware of the security implications. See more in the docs

Alternatively if you configure a port in the addon configuration, you can access through http://your-home-assistant.local:PORT. This is what you must do if you want to host BB with another name (such as mydomain.duckdns.org/babybuddy)

If you come across a CSRF_TRUSTED_ORIGINS error, you can add that domain in the addon's Configuration page. Multiple domains can be added with a comma and no space to separate them.

Home Assistant Integration

This addon only runs Baby Buddy, if you would like to see some of the data as sensors in Home Asssitant to crete automations, you also need the integration that pulls data from the addon.

Installation (basic)

Add this addon-repo to your home assistant by going to to Settings -> Add-ons -> Add-on Store and add this URL as an additional repository:

https://github.com/OttPeterR/addon-babybuddy

Additional setup for HTTPS via NGINX (using your own domain)

The standard way of accessing Baby Buddy is through Home Assistant Ingress, so under normal use these instructions won't be needed.

Follow these additional instructions if your Home Assistant instance is set up so that it can only be accessed via HTTPS (e.g., using the DuckDNS add-on. For example, you access your Home Assistant instance at https://example.duckdns.org:8123.

  1. Install the Nginx Proxy Manager available from the Home Assistant Add-on Store. Closely follow the installation instructions. We will use this add-on the set up a reverse proxy so that you can access BabyBuddy via HTTPS externally.

  2. From a machine on the same local network as your Home Assistant instance, identify the local IP address of the Home Assistant machine (e.g., 192.168.1.100). Then, direct your browser to http://192.168.1.100:81 to access the Nginx Proxy Manager admin page. (Note, even though Home Assistant is set up to only be accessed on your domain via HTTPS, you can access Nginx Proxy Manager locally because it is an add-on running in a separate Docker container. The Nginx Proxy Manager admin page will only ever be accessible via your local network for security reasons, assuming your router does not forward port 81 to your Home Assistant machine)

  3. Forward port 80 and 443 on your router to your Home Assistant machine. These ports will be sent to the Nginx Proxy Manager add-on, and not directly to Home Assistant Core. This will allow you to access Baby Buddy via HTTPS on your domain.

  4. On the Nginx Proxy Manager admin dashboard, navigate to Hosts -> Proxy Hosts -> Add Proxy Host. Enter the domain you want to use to access Baby Budy (e.g., babybuddy.example.duckdns.org). Use http as the scheme (i.e., how Baby Buddy is accessed locally). Enter the Home Assistant local IP address as the Forward IP (e.g. 192.168.1.100). Enter 8000 as the forward port (or whatever you have set up in the Baby Buddy add-on configuration as the port.) Under the SSL tab, select Request a new SSL certificate and check Force SSL and agree.

  5. In the Baby Budy add-on configuration, under CSRF_TRUSTED_ORIGINS enter your domain for Baby Buddy (e.g., https://babybuddy.example.duckdns.org). If you want to use multiple domains, enter them with a comma and no space (eg http://baby.example.com,https://babybuddy.mydomain.com)

You should now be able to acess Baby Buddy via your domain (e.g., [https://babybuddy.example.duckdns.org]). You may want to use a Markdown card or a Button set up to your domain.

About

BabyBuddy, wrapped into a Home Assistant addon


Languages

Language:Dockerfile 43.2%Language:Shell 31.2%Language:Groovy 22.6%Language:Python 3.0%