dployr

Appearance

Installation ​

Quick Install ​

Linux/macOS ​

bash
curl -sSL https://raw.githubusercontent.com/dployr-io/dployr/master/install.sh | bash

For first-time installation with a bootstrap token.:

bash
curl -sSL https://raw.githubusercontent.com/dployr-io/dployr/master/install.sh \
  | bash -s -- --token "<bootstrap_token>"

Windows ​

Run PowerShell as Administrator:

powershell
iwr "https://raw.githubusercontent.com/dployr-io/dployr/master/install.ps1" -OutFile install.ps1
.\install.ps1

For first-time installation with a bootstrap token:

powershell
.\install.ps1 -Token $env:DPLOYR_INSTALL_TOKEN

To obtain a new bootstrap token, create a new instance in the dployr web dashboard at https://app.dployr.io/clusters/[cluster-id]/instances/?new=true.

Manual Installation ​

  1. Download the latest release from GitHub Releases
  2. Extract the binary to your PATH

Package Managers ​

Homebrew (macOS/Linux) ​

bash
brew tap dployr-io/dployr
brew install dployr

Scoop (Windows) ​

powershell
scoop bucket add dployr https://github.com/dployr-io/scoop-bucket
scoop install dployr

Starting the Daemon ​

Linux (systemd) ​

bash
sudo systemctl enable dployrd
sudo systemctl start dployrd
sudo systemctl status dployrd

macOS (launchd) ​

bash
sudo launchctl load /Library/LaunchDaemons/io.dployr.dployrd.plist
sudo launchctl start io.dployr.dployrd

Windows (NSSM) ​

The installer automatically configures dployrd as a Windows service using NSSM.

powershell
# Start service
Start-Service dployrd

# Check status
Get-Service dployrd

Verification ​

Check the daemon version:

bash
dployrd --version

View logs:

  • Linux/macOS: /var/log/dployrd/app.log
  • Windows: C:\ProgramData\dployr\logs\app.log

Dependencies ​

dployr automatically downloads and configures the following dependencies:

DependencyPurposePlatform
CaddyReverse proxy and automatic HTTPSAll
vfoxRuntime version managementAll
SQLiteEmbedded databaseAll
systemdService managerLinux
launchdService managermacOS
NSSMService managerWindows

Troubleshooting ​

No bootstrap token ​

Set it in the configuration file or rerun the installer with --token.

WebSocket authentication errors (401/403) ​

The daemon will automatically clear the access_token and reacquire it. Check logs for details.

mTLS/certificate issues ​

Ensure the pinned CA/cert path is correct if you customized certificates.

Permission errors ​

Service managers may require admin/root privileges for installation and startup.

Next Steps ​