Skip to main content

Quick Start

Get PatchOne running in under 5 minutes using the on-premises mode (SQLite, single Windows Server).

Prerequisites​

  • Windows Server 2019+ (or Windows 10/11 for dev/test)
  • Python 3.11+ installed
  • At least one Windows machine for the agent

1. Clone and configure​

Clone the repository
git clone <repo> patchone
cd patchone
copy server\.env.example server\.env

Open server\.env and set at minimum:

server/.env
SECRET_KEY=change-this-to-a-random-string-at-least-32-chars
ADMIN_PASSWORD=your-admin-password
SERVER_MODE=onprem
SECRET_KEY

Generate a strong key with python -c "import secrets; print(secrets.token_hex(32))". Never reuse or commit this value.

2. Run the installer​

Run as Administrator
deploy\install_server.bat

This single script:

  1. Creates a Python virtual environment
  2. Installs all server dependencies
  3. Initialises the database and seeds the 50-title software catalog
  4. Creates the initial admin account
  5. Registers PatchOne as a Windows Service
  6. Configures the firewall

3. Open the dashboard​

Navigate to http://<server-ip> and log in with your admin credentials.

4. Deploy the first agent​

Create config.ini from the template and fill in your server URL and API key:

config.ini
[server]
SERVER_URL=https://your-patchone-server
API_KEY=<your-api-key>
TENANT_ID=default
HEARTBEAT_INTERVAL=300

[agent]
LOG_LEVEL=INFO

Copy PatchPilotAgent.exe and config.ini to a test machine and run:

Install the agent (run as Administrator)
PatchPilotAgent.exe install

The machine appears in the Machines page after the next check-in.

5. Push your first update​

  1. Go to Deploy in the dashboard
  2. Select the test machine
  3. Choose a software title from the catalog (e.g., Google Chrome)
  4. Click Deploy

The job runs silently on the agent. Check Jobs for the result.

Verification checklist​

  • Dashboard loads and login works
  • Test machine appears in Fleet view
  • Software inventory visible on machine detail page
  • Deploy job completes successfully

Next steps​