Announcement: AppDaemon version 2.1.6

This release is to clean up things in the API department. Rather than forcing you to partially configure HADashboard just to run the AppDaemon API, the API now runs completely separately from HADashboard on a separate port with it’s own configuration. It is now also possible to run either a http or https independently.

This means some slight changes in the config if you have been using the API, otherwise no changes.

For API users:

  1. Rename ad_key to api_key if you are using it
  2. Add a valid api_port to the AppDaemon section
  3. If desired add api_ssl_certificate and api_ssl_key to ther AppDaemon section to run with SSL.

2.1.6

Features

  • API now runs on a separate port to the dashboard

Fixes

None

Breaking Changes

  • API requires the api_port configuration value to be set and now runs on a different port from the dashboard
  • SSL Setup for API now requires api_ssl_certificate and api_ssl_key to be set
  • ad_key has been renamed to api_key
3 Likes

Could you clarify “valid api_port”? Where would this port be referenced?

Thanks.

Ken

It’s in the docs (although there was a typo, here is a corrected version:

AppDaemon:
  logfile: STDOUT
  errorfile: STDERR
  logsize: 100000
  log_generations: 3
  threads: 10
  cert_path: <path/to/root/CA/cert>
  cert_verify: True
  time_zone: <time zone>
  api_port: 5000
  api_key: !secret api_key
  api_ssl_certificate: <path/to/root/CA/cert>
  api_ssl_key: <path/to/root/CA/key>

  • api_port (optional) - Port the AppDaemon RESTFul API will liten on. If not specified, the RESTFul API will be turned off
  • api_key (optional) - adds the requirement for AppDaemon API calls
    to provide a key in the header of a request
  • api_ssl_certificate (optional) - certificate to use when running the API over SSL
  • api_ssl_key (optional) - key to use when running the API over SSL

I

Now corrected in the online docs:

http://appdaemon.readthedocs.io/en/latest/INSTALL/

Oops. RTFM. I keep forgetting that the online manual is constantly updated with the latest. Thanks.

Ken

1 Like

Doesn’t look like it’s implemented yet, so can I RFE per-dashboard password? I want some dashboards “public” but others protected. I apologize if I missed where this is possible and documented!!

Not at this point no, the password is global. I’ll add it to the list though.

Just found some time to update AppDaemon to 2.1.6 (and HA 0.51.2), nothing bad so far…

However, at first I missed the dependency of libffi-dev, (being on RPi and using pip) so perhaps that could be mentioned in http://appdaemon.readthedocs.io/en/latest/INSTALL/ :wink:

Also, https://home-assistant.io/docs/ecosystem/appdaemon/updating/ is perhaps kind of old now that we can use pip directly (without going via git)…

Thanks - yes the FFI piece is in the next version of the docs already. I’ll fix that page.