Any plans for Alerts functionalilty?

[gh2023-aesun]

Firstly, thank you for this project.

I'd like to see some way to generate an alert for events such as device offline or new DHCP lease issued.

This could be as simple as posting to a webhook and then the user can take it from there. For example, the user could then use n8n to send an email alert etc. I think a webhook is the easiest and most versatile method, if alerts are implemented in OpenSOHO.

Obviously, it's easier said than done; your need an event bus, monitoring, triggering, rules engine etc.

Are there any plans for this functionality?

[rubenbe]

Hi,

Thanks for discovering it!

Yes there are some ideas for an alerts API. Currently there is only one: to check whether all APs are reachable by openSOHO (healthy).
I'm reworking the API a bit to use mac addresses (will be part of 0.6.0).
I could expand it easily to check whether other wifi clients are online.

The OpenSOHO documentation is catered towards Home Assistant, but I saw n8n (obviously) also supports REST apis
https://github.com/rubenbe/opensoho/blob/main/doc/hass.md
https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/

I'm currently not really planning to support OpenSOHO making REST callbacks itself since that opens a whole can of worms (dealing with timeouts, 10 authentication methods, SSL, etc) I might have a look later since golang might have some nice wrappers for that.
The advantage of OpenSOHO performing the callbacks is that there is less polling required though.
My rationale is that the n8n company/organisation has more manpower than me to implement all the different REST API variants, so I prefer to push that to the "other side" ;)
That being said, I see the advantage of openSOHO doing the calls itself too, since it's safer to pass firewalls in that direction.

Related and interesting for you maybe is that I might also add MQTT since that nicely integrates with home assistant, and I notice it is also supported by n8n

[gh2023-aesun]

Thanks for the detailed response, I'll take a look and share my experience.

I just upgraded to 0.6.0; you have been very busy :-)

[gh2023-aesun]

I know this is probably a simple thing, but I fell at the first hurdle; Generating an initial token.

I following the instructions here.

I created a user in the Users collection (http://xxx.xxx.xxx.xxx:8090/_/#/collections?collection=_pb_users_auth_) with:

• id: <id>
• email: <email>
• password: <password>
• name: <name>
• all other settings are defaults

However, I get the following error trying to generate a token:

root@opensoho:~# curl -X POST http://xxx.xxx.xxx.xxx:8090/api/collections/api_users/auth-with-password -H "Content-type:application/json" -d '{"identity":"<id>", "password":"<password>"}'

{"data":{},"message":"Missing or invalid collection context.","status":404}

I've tried <id>, <email>, <name> for the "identity" key, but all with the same result.

I found this corresponding log entry:

Also, I've enabled Batch API in settings (http://xxx.xxx.xxx.xxx:8090/_/#/settings).

I'm using OpenSOHO version 0.6.0.

What am I doing wrong?

[rubenbe]

On 0.6.0 the Users collection should be called API users 🤔 I'll have a look later to verify whether I didn't forget to commit a migration.

[gh2023-aesun]

I also downgraded to version 0.5.1, with the same behavior, so most likely something I'm missing.

[rubenbe]

Hmm, no, it should work on 0.6.0. This is the error I get when I purposefully enter the wrong xxx password.

curl -X POST http://localhost:8090/api/collections/api_users/auth-with-password -H "Content-type:application/json" -d '{"identity":"hass", "password":"xxx"}'
{"data":{},"message":"Failed to authenticate.","status":400}

Can you delete the pb_migrations directory and rerun the 0.6.0 release?

If it doesn't work please send me the list of files in pb_migrations.

[gh2023-aesun]

Can you confirm the "identity" api data key is the name field in the users record please?

[gh2023-aesun]

I created a new user for testing only in the Users collection with:

• email: email.example.com
• password: xxxxxxxx (the password is literally xxxxxxxx)
• name: hass
• all other settings are defaults

Rerunning the curl command yields:

root@opensoho:~# curl -X POST http://localhost:8090/api/collections/api_users/auth-with-password -H "Content-type:application/json" -d '{"identity":"hass", "password":"xxxxxxxx"}'
curl -X POST http://localhost:8090/api/collections/api_users/auth-with-password -H "Content-type:application/json" -d '{"identity":"email@example.com", "password":"xxxxxxxx"}'
curl -X POST http://localhost:8090/api/collections/api_users/auth-with-password -H "Content-type:application/json" -d '{"identity":"onwuaxzbgfgl0as", "password":"xxxxxxxx"}'
{"data":{},"message":"Missing or invalid collection context.","status":404}
{"data":{},"message":"Missing or invalid collection context.","status":404}
{"data":{},"message":"Missing or invalid collection context.","status":404}

As requested:

root@opensoho:~# sudo find / -iname '*pb_migrations*' 2>&1 | grep -v "Permission denied"
/pb_migrations
root@opensoho:~# ls -lah /pb_migrations
total 652K
drwxr-xr-x  2 root root  12K Sep  7 12:25 .
drwxr-xr-x 19 root root 4.0K Sep  7 12:25 ..
-rw-r--r--  1 root root  37K Sep  7 12:25 1743869747_collections_snapshot.js
-rw-r--r--  1 root root  897 Sep  7 12:25 1743882701_updated_wifi.js
-rw-r--r--  1 root root 2.4K Sep  7 12:25 1744469495_created_clients.js
-rw-r--r--  1 root root  516 Sep  7 12:25 1744540671_updated_clients.js
-rw-r--r--  1 root root  688 Sep  7 12:25 1744543662_updated_clients.js
-rw-r--r--  1 root root 1.6K Sep  7 12:25 1744696938_created_radios.js
-rw-r--r--  1 root root 1.6K Sep  7 12:25 1744824486_created_connected_clients.js
-rw-r--r--  1 root root 2.6K Sep  7 12:25 1744824596_updated_connected_clients.js
-rw-r--r--  1 root root 2.3K Sep  7 12:25 1745000837_created_vlan.js
-rw-r--r--  1 root root 2.6K Sep  7 12:25 1745390044_updated_radios.js
-rw-r--r--  1 root root  634 Sep  7 12:25 1747573057_updated_clients.js
-rw-r--r--  1 root root 3.4K Sep  7 12:25 1747574248_updated_connected_clients.js
-rw-r--r--  1 root root  673 Sep  7 12:25 1747590784_updated_clients.js
-rw-r--r--  1 root root 4.1K Sep  7 12:25 1747590797_updated_connected_clients.js
-rw-r--r--  1 root root  604 Sep  7 12:25 1748776664_updated_devices.js
-rw-r--r--  1 root root  634 Sep  7 12:25 1749245830_updated_clients.js
-rw-r--r--  1 root root 4.8K Sep  7 12:25 1749245850_updated_connected_clients.js
-rw-r--r--  1 root root  691 Sep  7 12:25 1749289460_updated_radios.js
-rw-r--r--  1 root root  961 Sep  7 12:25 1749289584_updated_radios.js
-rw-r--r--  1 root root 1.5K Sep  7 12:25 1749310741_updated_radios.js
-rw-r--r--  1 root root  846 Sep  7 12:25 1749311915_updated_radios.js
-rw-r--r--  1 root root 2.0K Sep  7 12:25 1752327664_created_client_steering.js
-rw-r--r--  1 root root  969 Sep  7 12:25 1752328214_updated_client_steering.js
-rw-r--r--  1 root root  936 Sep  7 12:25 1752344504_updated_clients.js
-rw-r--r--  1 root root  959 Sep  7 12:25 1752345620_updated_client_steering.js
-rw-r--r--  1 root root  687 Sep  7 12:25 1752349752_updated_client_steering.js
-rw-r--r--  1 root root 1.2K Sep  7 12:25 1752430024_updated_vlan.js
-rw-r--r--  1 root root  689 Sep  7 12:25 1752435775_updated_wifi.js
-rw-r--r--  1 root root  684 Sep  7 12:25 1752697347_updated_client_steering.js
-rw-r--r--  1 root root  952 Sep  7 12:25 1752735543_updated_client_steering.js
-rw-r--r--  1 root root  574 Sep  7 12:25 1752929014_updated_wifi.js
-rw-r--r--  1 root root  722 Sep  7 12:25 1753012533_updated_radios.js
-rw-r--r--  1 root root  677 Sep  7 12:25 1753038430_updated_client_steering.js
-rw-r--r--  1 root root  939 Sep  7 12:25 1753038719_updated_client_steering.js
-rw-r--r--  1 root root 3.0K Sep  7 12:25 1753038857_updated_client_steering.js
-rw-r--r--  1 root root 2.7K Sep  7 12:25 1753205227_created_interfaces.js
-rw-r--r--  1 root root  534 Sep  7 12:25 1753213288_updated_interfaces.js
-rw-r--r--  1 root root  662 Sep  7 12:25 1753896678_updated_interfaces.js
-rw-r--r--  1 root root 1023 Sep  7 12:25 1753896701_updated_interfaces.js
-rw-r--r--  1 root root 1023 Sep  7 12:25 1753896747_updated_interfaces.js
-rw-r--r--  1 root root 5.2K Sep  7 12:25 1754158403_updated_connected_clients.js
-rw-r--r--  1 root root  666 Sep  7 12:25 1754159186_updated_clients.js
-rw-r--r--  1 root root  665 Sep  7 12:25 1754159246_updated_clients.js
-rw-r--r--  1 root root  665 Sep  7 12:25 1754159346_updated_clients.js
-rw-r--r--  1 root root 5.6K Sep  7 12:25 1754159791_updated_connected_clients.js
-rw-r--r--  1 root root 6.3K Sep  7 12:25 1754244280_updated_connected_clients.js
-rw-r--r--  1 root root 2.6K Sep  7 12:25 1754503306_created_dhcp_leases.js
-rw-r--r--  1 root root  793 Sep  7 12:25 1754550575_updated_dhcp_leases.js
-rw-r--r--  1 root root  573 Sep  7 12:25 1754678672_updated_radios.js
-rw-r--r--  1 root root 7.3K Sep  7 12:25 1754850849_updated_connected_clients.js
-rw-r--r--  1 root root 6.9K Sep  7 12:25 1754850883_updated_connected_clients.js
-rw-r--r--  1 root root 6.9K Sep  7 12:25 1754851113_updated_connected_clients.js
-rw-r--r--  1 root root 4.1K Sep  7 12:25 1754851496_created_disconnected_clients.js
-rw-r--r--  1 root root 7.0K Sep  7 12:25 1754851554_updated_disconnected_clients.js
-rw-r--r--  1 root root 2.4K Sep  7 12:25 1754897113_created_stats_device.js
-rw-r--r--  1 root root  455 Sep  7 12:25 1754897132_updated_stats_device.js
-rw-r--r--  1 root root  704 Sep  7 12:25 1754908510_updated_devices.js
-rw-r--r--  1 root root  903 Sep  7 12:25 1754936841_updated_client_steering.js
-rw-r--r--  1 root root 1.7K Sep  7 12:25 1754939667_updated_devices.js
-rw-r--r--  1 root root  934 Sep  7 12:25 1754939741_updated_devices.js
-rw-r--r--  1 root root  934 Sep  7 12:25 1754939905_updated_devices.js
-rw-r--r--  1 root root 1.7K Sep  7 12:25 1754980626_created_ssh_keys.js
-rw-r--r--  1 root root 2.4K Sep  7 12:25 1755068691_deleted_device_stats.js
-rw-r--r--  1 root root 1.6K Sep  7 12:25 1755106225_updated_vlan.js
-rw-r--r--  1 root root 2.0K Sep  7 12:25 1755107027_updated_vlan.js
-rw-r--r--  1 root root 1.1K Sep  7 12:25 1755110034_updated_devices.js
-rw-r--r--  1 root root 1.3K Sep  7 12:25 1755150358_updated_wifi.js
-rw-r--r--  1 root root  633 Sep  7 12:25 1755420791_updated_devices.js
-rw-r--r--  1 root root  635 Sep  7 12:25 1755497923_updated_clients.js
-rw-r--r--  1 root root 7.3K Sep  7 12:25 1755498335_updated_connected_clients.js
-rw-r--r--  1 root root 7.3K Sep  7 12:25 1755498350_updated_disconnected_clients.js
-rw-r--r--  1 root root  682 Sep  7 12:25 1755758618_updated_devices.js
-rw-r--r--  1 root root 1.6K Sep  7 12:25 1755969614_updated_vlan.js
-rw-r--r--  1 root root  633 Sep  7 12:25 1755969675_updated_devices.js
-rw-r--r--  1 root root 1.7K Sep  7 12:25 1756138148_updated_clients.js
-rw-r--r--  1 root root 9.0K Sep  7 12:25 1756140424_updated_connected_clients.js
-rw-r--r--  1 root root 9.0K Sep  7 12:25 1756140461_updated_disconnected_clients.js
-rw-r--r--  1 root root  11K Sep  7 12:25 1756186830_updated_connected_clients.js
-rw-r--r--  1 root root 9.7K Sep  7 12:25 1756187468_updated_disconnected_clients.js
-rw-r--r--  1 root root 2.3K Sep  7 12:25 1756195713_created_ethernet.js
-rw-r--r--  1 root root  522 Sep  7 12:25 1756195731_updated_ethernet.js
-rw-r--r--  1 root root  989 Sep  7 12:25 1756199143_updated_ethernet.js
-rw-r--r--  1 root root  575 Sep  7 12:25 1756234490_updated_client_steering.js
-rw-r--r--  1 root root  575 Sep  7 12:25 1756234518_updated_devices.js
-rw-r--r--  1 root root  575 Sep  7 12:25 1756274923_updated_clients.js
-rw-r--r--  1 root root  575 Sep  7 12:25 1756274935_updated_client_steering.js
-rw-r--r--  1 root root  713 Sep  7 12:25 1756274947_updated_devices.js
-rw-r--r--  1 root root  667 Sep  7 12:25 1756274958_updated_dhcp_leases.js
-rw-r--r--  1 root root  667 Sep  7 12:25 1756274972_updated_ethernet.js
-rw-r--r--  1 root root  573 Sep  7 12:25 1756274980_updated_interfaces.js
-rw-r--r--  1 root root  851 Sep  7 12:25 1756274992_updated_leds.js
-rw-r--r--  1 root root  849 Sep  7 12:25 1756275005_updated_ssh_keys.js
-rw-r--r--  1 root root  851 Sep  7 12:25 1756275164_updated_vlan.js
-rw-r--r--  1 root root  849 Sep  7 12:25 1756275175_updated_wifi.js
-rw-r--r--  1 root root 8.4K Sep  7 12:25 1756275184_updated_connected_clients.js
-rw-r--r--  1 root root 8.4K Sep  7 12:25 1756275190_updated_disconnected_clients.js
-rw-r--r--  1 root root  619 Sep  7 12:25 1756279296_updated_client_steering.js
-rw-r--r--  1 root root  671 Sep  7 12:25 1756279317_updated_clients.js
-rw-r--r--  1 root root  531 Sep  7 12:25 1756279591_updated_radios.js
-rw-r--r--  1 root root 1.2K Sep  7 12:25 1756279638_updated_leds.js
-rw-r--r--  1 root root  721 Sep  7 12:25 1756279654_updated_radios.js
-rw-r--r--  1 root root 1.2K Sep  7 12:25 1756279710_updated_users.js
-rw-r--r--  1 root root 1.1K Sep  7 12:25 1756282527_updated_client_steering.js
-rw-r--r--  1 root root  959 Sep  7 12:25 1756282547_updated_clients.js
-rw-r--r--  1 root root  727 Sep  7 12:25 1756282566_updated_devices.js
-rw-r--r--  1 root root  883 Sep  7 12:25 1756282594_updated_ethernet.js
-rw-r--r--  1 root root  717 Sep  7 12:25 1756282608_updated_interfaces.js
-rw-r--r--  1 root root 1.2K Sep  7 12:25 1756282634_updated_ssh_keys.js
-rw-r--r--  1 root root 1.2K Sep  7 12:25 1756282646_updated_vlan.js
-rw-r--r--  1 root root 1.2K Sep  7 12:25 1756282660_updated_wifi.js
-rw-r--r--  1 root root 8.6K Sep  7 12:25 1756282671_updated_connected_clients.js
-rw-r--r--  1 root root 8.6K Sep  7 12:25 1756282678_updated_disconnected_clients.js
-rw-r--r--  1 root root 3.1K Sep  7 12:25 1756361182_updated_users.js
-rw-r--r--  1 root root  505 Sep  7 12:25 1756361404_updated_api_users.js
-rw-r--r--  1 root root  653 Sep  7 12:25 1756398751_updated_wifi.js
-rw-r--r--  1 root root  574 Sep  7 12:25 1756495170_updated_wifi.js
-rw-r--r--  1 root root 9.0K Sep  7 12:25 1756500864_updated_wifi.js
-rw-r--r--  1 root root 1.1K Sep  7 12:25 1756501762_updated_wifi.js
-rw-r--r--  1 root root  585 Sep  7 12:25 1756630696_updated_wifi.js
-rw-r--r--  1 root root  578 Sep  7 12:25 1756636344_updated_radios.js

[gh2023-aesun]

I see that there are separate updated_api_users.js and updated_users.js listed.

I created the user with the http://localhost:8090/_/#/collections?collection=_pb_users_auth_ dialog, or are api users created differently?

[rubenbe]

I used exactly the same URL, so that's ok.
The two js files are indeed correct (since the "API Users" used to be called "Users")
Why did you have to filter out permission denied errors? That shouldn't be the case:

sudo find / -iname '*pb_migrations*' 2>&1 | grep -v "Permission denied"

Also try to make a fresh setup and see if you can reproduce the issue (simply start opensoho in another directory). It might be setup (permissions?) related.

[gh2023-aesun]

Why did you have to filter out permission denied errors? That shouldn't be the case:

sudo find / -iname '*pb_migrations*' 2>&1 | grep -v "Permission denied"

You are right it's not needed; It's the default hotkey I setup; it's needed when trying to find random stuff on android via adb.