-
Notifications
You must be signed in to change notification settings - Fork 1
Installing Add ons
Add-ons are Python packages that can be installed along with qToggleServer to extend its functionality.
You'll first need to log in remotely to your device using SSH. Use admin (or root) with your configured admin password as credentials.
Once logged in, you can install your desired packages by running:
# addons install <add-on>
After installation completes, follow the add-on instructions to enable and configure it; you may need to tweak your qtoggleserver.conf.
Finally, restart the entire Docker Compose project:
# service dockercompose restart
You'll find the addons command handy if you want to manage your add-ons. Just run it without arguments and you'll see what it can do for you.
Installing add-ons is just like installing any other Python package, using the pip command. In fact, the qToggleServer Docker image uses uv to manage Python packages and project dependencies, so you could use uv pip install <add-on> to install an add-on. The pip command is a compatibility wrapper script around uv pip.
However, qToggleServer runs inside a Docker container and on top of a Python virtual environment. So if you want to manually manage your add-ons (and other Python packages), you should first open a shell inside the qtoggleserver container:
docker exec -it qtoggleserver bash
Once inside this shell, you can run uv pip list to list all installed packages and finally, to install your add-on package:
# uv pip install <add-on>