Where to Start in the CoolerControl Documentation

Updated

Start with the section that matches what you are trying to do: new users should open Getting Started, server operators should go to Running a server?, and developers should use Building something?. If you are unsure whether your devices will work at all, check Is my hardware supported? before installing anything. The documentation home page is organized around exactly these entry points, so you can pick one without reading the whole site.

Choose your path

Your situation Start here What you get
First time using CoolerControl New here? → Getting Started Install steps for your distribution, hardware detection check, and the Auto-Create wizard
Not sure your fans, pumps, or sensors are detected Is my hardware supported? Confirmation of whether your devices are recognized
Want a working cooling setup Setting up cooling? Guidance on building a configuration
Running CoolerControl on a server or headless machine Running a server? Server-oriented documentation
Building or extending something Building something? Developer/build material

If you are a new user

The home page describes the intended first-run flow in three steps: install for your distribution, check that your hardware is detected, and let the Auto-Create wizard build a working setup. Follow them in that order — the wizard depends on detected hardware, so verifying detection first avoids configuring devices that are not visible.

A practical check after each step:

  1. Install — complete the instructions for your distribution, then confirm the application starts.
  2. Detect — verify your fans, pumps, and temperature sensors appear. If something is missing, switch to the hardware support section before continuing.
  3. Auto-Create — run the wizard and confirm it produces a setup; then adjust from there.

Common sticking point: skipping the detection check and going straight to the wizard, which can leave you with a partial configuration.

If your hardware may not be supported

Use the Is my hardware supported? section first. It is the fastest way to avoid spending time on installation when a device will not be recognized. If your hardware is listed, continue to Getting Started; if not, you know early where the limit is.

If you run a server

Go directly to Running a server?. This is a separate entry point from the desktop getting-started flow, so server operators do not need to work through the new-user path first.

If you build or develop

Use Building something? for build and development material. This is the right starting point for anyone working with the project beyond normal use.

The short version

Open the documentation home page and pick the heading that matches your goal — new user, hardware check, cooling setup, server, or building. New users should follow install → detect → Auto-Create in that order, because each step depends on the previous one.