Warning this is an early release, please read the release notes of ALL the releases until now
OpenSOHO is built to manage a small number OpenWRT based network devices. Hence the name SOHO from Small Office Home Office (SOHO) Networks. Only OpenWRT 24.10.x is tested.
- From 2 to 20 devices
- No multitenancy
- Compatible with openwisp-config and openwisp-monitoring.
- Simple to deploy
It is inspired by OpenWisp, but aims for networks which are too small to be maintained with OpenWISP. As OpenWisp mentioned:
However, OpenWISP may not be the best fit for very small networks (fewer than 20 devices), organizations lacking IT expertise, or enterprises seeking open-source alternatives solely for cost-saving purposes.
- Download the latest OpenSOHO release
- Start OpenSOHO
The shared secret will be used by openwisp-config to register. Choose a long random string for optimal security. It needs to match what you will configure in Luci in the next steps.
OPENSOHO_SHARED_SECRET=randompassphrase ./opensoho serve --http 0.0.0.0:8090
OpenSOHO will output a URL on the commandline which will allow you to create the admin account. Simply copy paste it into your browser.
Alternatively you can create a superuser in via the commandline:
./opensoho superuser upsert EMAIL PASS
openwisp-config
openwisp-monitoring
luci-app-openwisp
if you want to use 802.11v client steering, you will need the full wpad-mbedtls. A Reboot afterwards is required!
opkg remove wpad-basic-mbedtls && \
opkg install wpad-mbedtls && \
reboot
When installing wpad-mbedtls, rebooting is required to switch to the new wpad binary. If not you'll get an error like daemon.notice netifd: radio1 (28210): WARNING (wireless_add_process): executable path /usr/sbin/wpad does not match process 1842 path (/usr/sbin/wpad (deleted))
(Please note that 802.11v client steering is still a work in progress)
- Set the
Server URLand theShared secretonly. - Optionally lower the
Update Intervalto 30 seconds for faster updates. (OpenSOHO will do this for you if you don't) - OpenSOHO will also enable monitoring and lower the monitoring interval to 15 seconds to have snappier updates of the network state.
It is highly recommended to enable monitoring, since OpenSOHO will deduce a lot of the current OpenWRT settings and fill them in for easy configuration.
- Wait for the devices to self register using the shared secret.
- Set the
numradiosto the correct value. For example for a 2.4 + 5GHz device, this value would be 2. - Setup a Wifi access point (SSID+KEY)
- Attach the configured Wifi access point to a device to have it configured.
- Currently each network will be automatically configured on all radios (configured using
numradios). - Optionally leds can also be turned on or off (only static config for now).
- Configuring radio frequencies is supported now. OpenSOHO will read the current radio config once and make it available under the radios config. It can take a minute or two before radio config appears (the configuration and the monitoring steps need some time to complete)
OpenSoho can now be accessed via http://ipaddress:8090/_/
There are several configuration collections:
These are the clients connected to wifi. This table should be considered read-only, except for the alias. It can be used to give devices a human-readable name. This only works properly when the client does not randomize its mac-address.
These are the connected devices.
- Use enable/disable to disable configuration updates. This is useful to avoid updating all devices at once. The monitoring remains active.
- Health status is read-only field. Healty means the device has sent/requested data during the last minute. If it didn't, the health status becomes critical and there might be something wrong with the device or its connection.
- Leds allows to choose led configs
- Numradios allows to set the number of radios on this device. This is not initially sent by OpenWisp, so this needs to be set by the user.
- Wifis allows to select a SSIDs to apply on this device.
- Basic LED configuration (more of a POC at this moment)
- Allows to set the frequency each radio.
- The band should not be modified, as this allows OpenSOHO to verify the frequency config. This is needed due to limitations within PocketBase.
- Allows to set up the different SSIDs. The selection of encryption modes is currently limited. WEP or Open is not supported by design.
Verify whether the device health is "healthy"
This view shows all wifi clients that were connected in the last 30 seconds.
OpenSOHO monitoring can be integrated with Home Assistant. (More info) This REST API is designed for use with Home Assistant, but can also be integrated with other tools.
When changing the OpenWISP Server URL in Luci doesn't seem to properly register with the new controller.
To fix this:
uci delete openwisp.http.uuid
uci delete openwisp.http.key
/etc/init.d/openwisp-config restart
There seems to be an issue in OpenWRT where the first configured SSID on the a Wifi device is not auto-enabled. This can be worked around with a click on the enable button in Luci.
- Install the dependencies
go mod tidy
- Start OpenSOHO
The shared secret will be used by openwisp-config to register. Choose a long random string for optimal security.
Running the unit tests:
go test -cover -v -coverprofile=coverage.out
go tool cover -html=coverage.out
Some OpenWISP features are (currently) consided out of scope for OpenSOHO
- Firmware updates: OpenWRT doesn't need frequent updating, it should be possible to use the Attended sysupgrade feature on a number of devices manually.
- Multi-tenancy
- Templates: OpenWISP has a powerful and versatile template mechanism, this is replaced by a more opinionated subset of features to provide an easier configuration experience.
The goal is to leverage the pocketbase to its fullest. Small modifications can be made since the pocketbase backend currently does not contain a plugin system. But it is not the goal to create a fork of pocketbase, so merging upstream changed should be remain straightforward.
GITHUB_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa goreleaser release