Python Package Installation

• About
• Virtual Environment Installation
• System-wide Installation

---

About

qToggleServer is distributed as a regular Python package, published on PyPI. As long as your system runs a recent version of Python (at least 3.9), you can install it using pip.

Virtual Environment Installation

Unless you have it already, you'll need to install virtualenv (use sudo to run as root if needed):

# pip install virtualenv

Create and activate a virtual environment; if in doubt, you can choose a path inside your home directory:

$ virtualenv /path/to/your-env && source /path/to/your-env/bin/activate

Then install qToggleServer using pip:

$ pip install qtoggleserver

You'll now have a command called qtoggleserver that will start the server with a default configuration, in foreground (hit Ctrl+C to stop it):

$ qtoggleserver

Use the sample qtoggleserver.conf file to create your own configuration:

$ mkdir -p /path/to/your-env/etc
$ cp /path/to/your-env/share/qtoggleserver/extra/qtoggleserver.conf.sample /path/to/your-env/etc/qtoggleserver.conf

Now start the server, supplying your configuration file:

$ qtoggleserver -c /path/to/your-env/etc/qtoggleserver.conf

You should be able to access the web app by pointing your browser to http://localhost:8888. Use admin and empty password when prompted for login.

System-wide Installation

Since you'll be installing packages directly on your system, the following commands are assumed to be run as root (i.e. with sudo).

Install qToggleServer using pip:

# pip install qtoggleserver

You'll now have a command called qtoggleserver that will start the server with a default configuration, in foreground (hit Ctrl+C to stop it):

# qtoggleserver

Use the sample qtoggleserver.conf file to create your own configuration:

# cp /usr/share/qtoggleserver/extra/qtoggleserver.conf.sample /etc/qtoggleserver.conf

Now start the server, supplying your configuration file:

# qtoggleserver -c /etc/qtoggleserver.conf

You should be able to access the web app by pointing your browser to http://localhost:8888. Use admin and empty password when prompted for login.