-
Notifications
You must be signed in to change notification settings - Fork 1
Configuration
qToggleServer is configured via the qtoggleserver.conf file that lives in /data/etc. At first boot it is copied from /etc/qtoggleserver.conf which is a system-provided default configuration.
To edit the configuration file you can:
-
log in remotely using SSH and use the
nanoeditor:# nano /data/etc/qtoggleserver.conf -
insert the SD card into your Windows or OSX laptop and provide your
qtoggleserver.conffile on the boot partition -
insert the SD card into your Linux laptop and edit the
/etc/qtoggleserver.conffile on the data partition
See Partitions for more details on the partitions layout.
There are a few system settings that can and should be adjusted via the web app. Just go to the Settings page in the app and you'll notice the following system settings:
The device name plays an important role in a master-slave qToggle setup and also represents the hostname of your board on the network. Use simple names made of non-accented letters, numbers and dashes.
Every qToggle device has the following roles:
- administrator role - unlimited privileges, used for administrative purposes
- normal role - daily, regular usage with no access to the Settings page
- view-only role - can only view the state of your qToggle device
By default, all passwords are empty. It is important to set up strong passwords for at least the administrator and normal roles, since these roles can do damage to your home automation.
The administrator password is also used when logging in remotely using SSH with user root or its alias admin. This is yet another reason for setting a strong administrator password.
The system date/time is automatically managed by the OS so you should change it via the app.
Choose the correct timezone of your device, so that the local time is used when writing time-based automation rules.
Since you're already viewing the app Settings page, your qToggleOS device has network access, whether wired or wireless. Nevertheless, you can change or remove your WiFi network name and password using this field. Be sure to enter data correctly so that you don't break the device's network access.
Since you're already viewing the app Settings page, your qToggleOS device has a working IP configuration. You may want though to set up a static IP using this field. Be sure to enter data correctly so that you don't break the device's network access.
Add-ons are Python packages that can be installed along with qToggleServer to extend its functionality.
Installing add-ons is just like installing any other Python package, using the pip command. You'll first need to log in remotely to your Raspberry Pi using SSH. Use admin (or root) with your configured admin password as credentials.
Once logged in, you can install your desired packages by running:
# pip install <package>
After installation completes, follow the add-on instructions to enable and configure it in qtoggleserver.conf and restart qToggleServer:
# service qtoggleserver restart
qToggleOS is based on thingOS so you'll find a lot of operating system-related information by reading the thingOS wiki.
Most of the configuration files are already provided by qToggleOS and come with default values that provide a reasonable out-of-the-box experience. There are however some optional features that you'll probably want to configure: