Not yet. Version 2 will come with a guide, but there isn’t one yet. I’m actively writing it.
No worries, getting started with Linux can be intimidating at first, but it’s perfectly manageable.
It’s free 
Let’s get started: Are you on Ubuntu Desktop or Server?
Either way, you probably at least got that HQPTuner is currently distributed through a system called Docker.
Docker runs applications in ‘containers’: an independent, isolated, and pre-packaged virtual machine containing everything the app needs. Unlike traditional VMs which require dedicated CPU cores and memory, a container shares the host’s resources and kernel for efficiency. It cannot access the filesystem unless you give it explicit access to a folder.
For the Docker Compose system, the application and its top-level settings are managed by a file compose.yaml, which tells Docker how to build the container and how it communicates with the outside world.
So the overview of the workflow is:
- Install and start Docker and Docker Compose on Ubuntu
- Create two folders, one for HQPTuner and one for its state files.
- Copy the
compose.yaml file from the GitHub repo and place it in your HQPTuner folder.
- Pull the image and bring the container up.
If not all of that made sense, don’t worry yet.
First and foremost, if you haven’t, set the HQPlayer credentials:
hqplayerd -u <username> <password>
If you’re on Desktop and have a graphical interface for software installation, use that to install Docker and Docker Compose; otherwise, use:
sudo apt install docker.io docker-compose-v2
Do NOT install Docker Desktop; the networking is not the same and it won’t work.
Now, once it’s installed, we’re going to have to dive into the command line a little bit to configure it, because “real” Docker has no GUI by default. First, start the service:
sudo systemctl enable --now docker
Now, we’ll prepare for HQPTuner by making a folder for it in your home folder:
cd ~ # move to your home folder if you're not there already
mkdir -p hqptuner/state # this makes both folders at once
cd hqptuner # move into the new HQPTuner folder
Now, create the file compose.yaml in the HQPTuner folder (not state/) and fill it out with the contents from here. Save and close (if you need to do it from the CLI, that’s nano compose.yaml, paste, then Ctrl+X to save).
Finally, you’re ready to “pull the image” (download the container) and build it:
# one of these two will work
sudo docker compose up -d
sudo docker-compose up -d
That’s it, HQPTuner should now be running, check 127.0.0.1:8090 in a web browser if it’s running on the same machine, or <ipaddress>:8090 if it’s on a separate server. You’ll need to enter the credentials in HQPTuner; if the connection window doesn’t pop up automatically, click the status pill in the top right.
Don’t hesitate to reply back or DM me if any of that’s confusing or if you hit a snag somewhere!
Last but not least, I highly recommend two additional containers:
- Watchtower (https://watchtower.nickfedor.com) will automatically update your containers at the time you specify.
- Portainer (free version) provides a visual interface for managing containers.