freebox plugin version 2

This commit is contained in:
Alvise Bruniera
2026-03-26 16:03:45 +01:00
parent 84eb4d2c92
commit 21f6a53830
4 changed files with 20 additions and 47 deletions

View File

@@ -28,31 +28,17 @@ Limitations:
- The Freebox must be your gateway
- The device must be in the same lan as the Freebox
### Offline setup (recommended)
Use this configuration if you wish to connect to your Freebox even when you are offline, or the Freebox is not your gateway.
Find the local IP address of your Freebox, if it is your gateway, you can find the address on your computer/smartphone network configuration (usually it's `192.168.1.1`). Go in the plugin settings and set the IP as address and `80` as the port (do *not* use `443` as the port). This configuration works regardless of your internet connection and poses little limitations.
Limitations:
- *If* there is no internet connection, the plugin will fallback to HTTP (not HTTPS)
For more detail: the plugin will connect to the specified address and port to fetch information about the Freebox, then it will either connect in HTTPS through the Freebox's unique domain name, or connect over HTTP if there is no internet connection. The freebox does offer an HTTPS port on the local network, but the certificate will be invalid for the local IP, and the connection will be aborted.
### Remote setup
Use this configuration if you wish to connect to your Freebox through the internet. You still need to pair from the local network.
If the Freebox is not your gateway, configure a NAT and follow the [offline setup](#offline-setup-recommended).
If the Freebox is your gateway you need to find its HTTPS (or HTTP if you prefer) public port. This can be found either in the Freeboxe's web interface and by navigating to `settings>access management`, or (just for the HTTPS port) by visiting http://mafreebox.freebox.fr:80/api_version from the local network (you can use the local ip as well). This is the port you need to access your Freebox through the internet
As address, you can either use the public IP of the Freebox, or the unique domain name you found on http://mafreebox.freebox.fr:80/api_version listed as `api_domain`.
## Other info
- Version: 1.0
- Version: 2.0
- Author: [KayJay7](https://github.com/KayJay7), [Lucide](https://github.com/Lucide)
- Maintainers: [mathoudebine](https://github.com/mathoudebine)
- Release Date: 2-Dec-2024