Windows Binary Installation
SolidPing can be run on Windows systems as a standalone executable or as a Windows Service.
winget
The simplest way, on Windows 10 and 11:
winget install fclairamb.SolidPing
This puts a solidping command on your PATH (open a new terminal first), so
the examples below work with solidping in place of .\solidping.exe.
Upgrade it later with winget upgrade fclairamb.SolidPing.
To install it for all users, which suits a Windows Service, add
--scope machine from an administrator prompt.
Download
Download the latest Windows release from GitHub:
- Go to the SolidPing Releases page
- Download
solidping-windows-amd64.zip - Extract it into
C:\Program Files\SolidPing— the archive contains a single, already-namedsolidping.exe
Or use PowerShell, from an administrator prompt:
# Download the latest release
Invoke-WebRequest -Uri "https://github.com/fclairamb/solidping/releases/latest/download/solidping-windows-amd64.zip" -OutFile "solidping-windows-amd64.zip"
# Extract it (produces C:\Program Files\SolidPing\solidping.exe)
Expand-Archive -Path "solidping-windows-amd64.zip" -DestinationPath "C:\Program Files\SolidPing"
Put solidping.exe in C:\Program Files\SolidPing (or another folder only
administrators can write) if you plan to run it as a service:
the service runs it as LocalSystem, so anyone who can replace the file gets
full control of the machine. A folder created directly under C:\, such as
C:\solidping, lets every local user change what it holds, and
solidping service install refuses a binary there.
Verify the checksum (recommended)
Every release also publishes solidping-checksums.txt, covering all five
published .gz/.zip archives. Verify it against the downloaded .zip
itself — before extracting it, so the check covers exactly what GitHub
served:
Invoke-WebRequest -Uri "https://github.com/fclairamb/solidping/releases/latest/download/solidping-checksums.txt" -OutFile "solidping-checksums.txt"
# The checksums file lists the sha256 for each platform's archive — find the
# solidping-windows-amd64.zip line and compare it to the hash below.
Get-FileHash solidping-windows-amd64.zip -Algorithm SHA256
Get-Content solidping-checksums.txt | Select-String "solidping-windows-amd64.zip"
postgres-embedded (the bundled PostgreSQL supervisor available on Linux and
macOS) is not available on Windows — use sqlite or an external postgres
database instead, as covered above and below.
Running
Quick Start with SQLite
Open Command Prompt or PowerShell in the directory containing solidping.exe:
# Run with SQLite (data stored in current directory)
.\solidping.exe serve
With PostgreSQL
# Set environment variables
$env:SP_DB_TYPE = "postgres"
$env:SP_DB_URL = "postgresql://user:password@localhost:5432/solidping"
# Run the server
.\solidping.exe serve
Run Database Migrations
.\solidping.exe migrate
Windows Service
solidping.exe runs as a native Windows service, with no third-party wrapper.
From an administrator PowerShell prompt:
# Register the service: automatic start, restarted on failure
solidping service install
This registers a SolidPing service that starts with Windows and restarts
after a failure. It also creates the data folder C:\ProgramData\SolidPing,
readable only by SYSTEM and Administrators, since it holds your configuration
and database. The service runs as LocalSystem from that folder, so the SQLite
database and the logs land there:
C:\ProgramData\SolidPing\
├── config.yml (your configuration)
├── solidping.db (the SQLite database, if you use SQLite)
├── data\files\ (file storage)
└── logs\
├── solidping.log (rotated at 20 MB, 2 backups kept)
└── crash.log (Go runtime crash output, if any)
Configure it in C:\ProgramData\SolidPing\config.yml (see
Configuration File below; open it from the same
administrator prompt, e.g. notepad C:\ProgramData\SolidPing\config.yml),
not with environment variables: the service registry key is readable by every
local user, so secrets such as the database URL or the SMTP password must not
go there.
Then start it:
solidping service start
Manage it:
Get-Service SolidPing # status
solidping service stop # waits until it has stopped
Restart-Service SolidPing # after a config.yml change
solidping service uninstall # stops and removes it, keeps C:\ProgramData\SolidPing
service install takes --dir to use another data folder and --name to
pick another service name (to run two instances, for example). Pass the same
--name to start, stop and uninstall.
If the data folder already exists, service install only reuses it when it is
still the way a previous install left it: a real folder (not a link or a
junction), owned by SYSTEM, Administrators or you, readable only by SYSTEM
and Administrators, with nothing inside owned by another account or opened to
other users. Otherwise it stops with an error naming the problem. Any local
user can create a folder under C:\ProgramData and would keep control of it,
so delete the folder (after saving what you need from it) or pick another one
with --dir, then run service install again.
The service runs the solidping.exe that installed it. If you move that file,
run service uninstall and service install again. service install refuses
a solidping.exe that another account could replace: the file and every folder
above it must be owned by SYSTEM, Administrators, TrustedInstaller or you,
and none of them may let another account write it (reading and running it is
fine, as in C:\Program Files). It checks the parents of the data folder the
same way, since whoever can replace C:\ProgramData\acme can swap the
SolidPing folder in it for their own. The service checks all of this again
each time it starts, and if a check fails it writes the reason to the
Application event log and does not start.
Agent mode works as a service too: set node.role: agent in config.yml
(the equivalent of SP_NODE_ROLE=agent; see the Configuration Guide).
Coming from NSSM
Earlier versions of this page used NSSM. To switch, from an administrator prompt:
nssm stop SolidPing
nssm remove SolidPing confirm
solidping service install
Then copy your config.yml and, with SQLite, solidping.db (and
data\files\, if any) from the old AppDirectory into
C:\ProgramData\SolidPing, turn any environment variables you set with
AppEnvironmentExtra into config.yml entries, and run
solidping service start. Copy rather than move: a copy takes the access rules
of the data folder, while a moved file keeps those of the old folder, which a
later service install refuses if they let other users in.
Configuration File
Instead of environment variables, you can use a configuration file. For the
service, create C:\ProgramData\SolidPing\config.yml; when running
solidping serve by hand, put it in the current directory:
db:
type: postgres
url: postgresql://user:password@localhost:5432/solidping
server:
listen: ":4000"
email:
enabled: true
host: smtp.example.com
port: 587
username: noreply@example.com
password: smtp-password
from: noreply@example.com
Without a config.yml, it uses SQLite and listens on port 4000. Every SP_*
variable has a config.yml equivalent, see the
Configuration Guide.
Firewall
Allow incoming connections through Windows Firewall:
# Allow inbound on port 4000
New-NetFirewallRule -DisplayName "SolidPing" -Direction Inbound -Protocol TCP -LocalPort 4000 -Action Allow
Or through the Windows Firewall GUI:
- Open "Windows Defender Firewall with Advanced Security"
- Click "Inbound Rules" → "New Rule"
- Select "Port" → TCP → Specific port: 4000
- Allow the connection
- Name it "SolidPing"
IIS Reverse Proxy
If you're using IIS, you can configure it as a reverse proxy:
- Install the URL Rewrite and Application Request Routing modules
- Enable proxy in ARR
- Add a rewrite rule in
web.config:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<rewrite>
<rules>
<rule name="SolidPing Proxy" stopProcessing="true">
<match url="(.*)" />
<action type="Rewrite" url="http://localhost:4000/{R:1}" />
</rule>
</rules>
</rewrite>
</system.webServer>
</configuration>
SolidPing gzip-compresses its own responses (SP_SERVER_COMPRESSION, default
true), so IIS needs no compression module of its own for this — and turning
one on anyway is harmless, since a response that already carries
Content-Encoding passes through untouched.
Logs
The service writes its logs to C:\ProgramData\SolidPing\logs\solidping.log,
rotated at 20 MB with two older files kept (solidping.log.1, .2). Go runtime
crash output (panics), if the service died unexpectedly, goes to crash.log in
the same folder.
# Follow the server log
Get-Content "C:\ProgramData\SolidPing\logs\solidping.log" -Tail 100 -Wait
# Crash output, if any
Get-Content "C:\ProgramData\SolidPing\logs\crash.log"
Updating
Stop the service first: Windows does not let you replace a running .exe.
With winget:
solidping service stop
winget upgrade fclairamb.SolidPing
solidping service start
With a downloaded binary, extract the new solidping.exe over the old one, in
place: the service points at its absolute path.
solidping service stop
Invoke-WebRequest -Uri "https://github.com/fclairamb/solidping/releases/latest/download/solidping-windows-amd64.zip" -OutFile "solidping-windows-amd64.zip"
Expand-Archive -Path "solidping-windows-amd64.zip" -DestinationPath "C:\Program Files\SolidPing" -Force
solidping service start
The data folder is untouched by an upgrade.
Troubleshooting
Service Won't Start
- Check
C:\ProgramData\SolidPing\logs\solidping.logandcrash.log - Check
C:\ProgramData\SolidPing\config.yml - Ensure the database is accessible
- Check port 4000 is not in use:
netstat -an | findstr :4000
solidping service run is what Windows launches; run from a terminal, it
refuses to start. To debug in a console, stop the service and run
solidping serve from the data folder instead.
Permission Issues
service install, uninstall, start and stop need an administrator
prompt, and so does editing anything in C:\ProgramData\SolidPing.
File Storage
Alongside the database, SolidPing writes a handful of blobs — org logos,
status-page assets, incident screenshots — under SP_FILESTORAGE_LOCAL_ROOT
(default ./data/files, relative to the working directory). The service runs
from C:\ProgramData\SolidPing, so that resolves to
C:\ProgramData\SolidPing\data\files and there is
nothing extra to configure here — this only matters for containerized
deployments. See File Storage for the S3
backend, useful once you run more than one node.
Next Steps
- Configuration Guide - All configuration options
- Check Types - Configure your first checks