Skip to main content
99.99% Uptime SLA Network status

How to Self-Host Paperclip on a VPS

This guide shows how to self-host Paperclip on a self-managed VPS so the server, UI, adapters, heartbeats, tasks, and logs can run from a persistent remote environment instead of a workstation. Virtarix provides the VPS infrastructure. You install, configure, secure, update, and operate the software you run on it. Each VPS/VDS plan includes 1 free snapshot and 1 backup. You bring Paperclip, provider accounts, API keys, repositories, model access, monitoring, updates, and security configuration, and you should verify exact Paperclip commands against the current upstream docs before production changes.

20% welcome offer $4.40/mo for first 3 months (then $5.50)
Trustpilot rating: 4.5 out of 5 4.5/5 on Trustpilot

Recommended Quick Setup

Use this path when you want the shortest practical route from VPS order to a usable Paperclip server workspace. It keeps the first deployment private by default, then lets you choose LAN, tailnet, reverse-proxy, or authenticated access deliberately. The full checklist below expands each step.

01

VPS plan

Starter VPS Includes 3 CPU cores, 6 GB RAM, 50 GB NVMe storage, Unlimited bandwidth, subject to plan terms, 1 free snapshot, 1 backup included, IPv4 + IPv6.

02

Operating system

Use an Ubuntu VPS or another Linux distribution supported by the selected Paperclip runtime path.

03

Access method

Connect with SSH keys where possible, use root or sudo access only for setup tasks that need it, and restrict exposed ports to the services you intentionally run.

04

Runtime workflow

Run the Paperclip NPX onboarding path first, confirm loopback access, then choose an explicit bind preset such as LAN or tailnet, or a reviewed reverse-proxy/authenticated access pattern, only when you are ready to expose the service.

05

Session continuity

Start with the documented Paperclip run command, then add tmux, systemd, Docker Compose, queues, or service supervision only where they fit the chosen deployment path.

06

Safety checkpoint

Take a snapshot before major dependency changes, protect provider keys and repository credentials, keep local_trusted setups off the public internet, test a small workflow, and scale the VPS only after measuring real CPU, RAM, storage, and runtime activity.

Who This Guide Is For

This page is for users who want Paperclip experiments or team workflows to run from a central VPS environment with observable agents, adapters, heartbeats, tasks, and logs.

Teams experimenting with multi-agent control planes

Use a VPS when multiple agents, task state, and scheduled wakeups need a shared runtime boundary.

Operators coordinating adapters and heartbeats

Keep adapters, heartbeat schedules, process managers, and service logs in one server-side control point.

Builders who need a central dashboard and server logs

Use the VPS as the place to inspect UI state, background processes, run output, and troubleshooting evidence.

Developers who want AI agent company experiments isolated from a workstation

Virtarix provides the VPS infrastructure. You install, configure, secure, update, and operate the software you run on it.

What You Need Before You Start

Before selecting a plan or installing Paperclip, confirm the server access, runtime path, credentials, firewall exposure, and recovery routine needed for the deployment.

Choose the Paperclip Runtime Path

Before running commands, decide how Paperclip should be installed, updated, restarted, and recovered on the VPS. Paperclip currently documents NPX Onboard, manual Git clone, and Docker installation paths; use current upstream documentation as the authority for exact versions and flags.

NPX quickstart

Best for a first VPS proof where onboarding creates a local Paperclip instance quickly before you decide whether to bind it to a LAN, tailnet, reverse proxy, or authenticated private surface.

Manual Git clone

Best for contributors or advanced teams that need pnpm-based source development and repository-level control.

Docker deployment

Best when you want a containerized Paperclip deployment with explicit volume, port, secret, and update handling.

Trusted local mode

Best for loopback-only solo operation behind SSH or a private tunnel. Do not expose local_trusted mode directly to the public internet.

Authenticated mode

Best for LAN, tailnet, or public deployments that need login, stricter access checks, and a reviewed base URL or reverse-proxy plan.

Recommended VPS Requirements

Minimum starting point for a test environment. Confirm current Paperclip prerequisites before production use:

Minimum starting point for a test environment

Use this to validate the workflow before committing to an always-on deployment. This is a practical VPS starting point, not a guarantee for every agent count or provider workload.

  • 2 CPU cores
  • 4 GB RAM
  • 30 GB NVMe storage
  • Ubuntu VPS or another supported Linux server
  • Root access

Recommended Virtarix starting point

Starter VPS

20% off your first 3 months - normally $5.50/month

  • 3 CPU cores
  • 6 GB RAM
  • 50 GB NVMe storage
  • Unlimited bandwidth, subject to plan terms
  • 1 free snapshot
  • 1 backup included
  • IPv4 + IPv6

Recommended Architecture

The VPS is the runtime layer. You connect over SSH, configure Paperclip, and control logs, state, and access. For production use, plan authenticated or private networking before exposing it to other users.

You (Operator)

You connect over SSH and control the full workflow, configuration, security, and updates.

Virtarix VPS

Provides the persistent server with storage, networking, root access, snapshots, and backups.

Paperclip Runtime

Paperclip server, UI, agents, heartbeats, tasks, database, and adapter layer running on the VPS.

External Services

API and model providers, repositories, tools, and integrations that you connect and manage.

Step-by-Step Setup Flow

Follow this sequence as a practical deployment checklist for an Ubuntu-style VPS, but confirm Paperclip-specific versions, installer flags, deployment modes, Docker files, and service commands against current official documentation before production use.

Deploy and connect

Prepare the VPS, connect over SSH, and create a clean workspace before installing Paperclip-specific dependencies.

Deploy the VPS

Choose Ubuntu or another Linux distribution supported by the selected Paperclip path. Select the location closest to the user, app, API provider, or team where practical, and start with enough CPU, RAM, and storage for persistent background work.

Connect over SSH

ssh root@YOUR_SERVER_IP

Update the server

sudo apt update && sudo apt upgrade -y

Create a non-root user where practical

Create a dedicated non-root deployment user for day-to-day project work, then verify that user can connect by SSH and run sudo before disabling root or password login. Reconnect as the deployment user before installing or configuring the agent when your selected runtime path stores user-scoped configuration.

# Create a dedicated non-root user for day-to-day project work
adduser deploy
usermod -aG sudo deploy

Prepare a private runtime workspace

Create one directory tree for Paperclip config examples, working files, logs, and backups. Keep secrets out of shell history and commit only templates, not real keys.

APP_HOME="$HOME/self-host-paperclip-on-vps-runtime"
mkdir -p "$APP_HOME/config" "$APP_HOME/workspace" "$APP_HOME/logs" "$APP_HOME/backups"
chmod 700 "$APP_HOME/config"
printf '%s\n' "# add real provider keys privately" > "$APP_HOME/config/env.example"
chmod 600 "$APP_HOME/config/env.example"

Install and configure

Install base packages, follow the current upstream install path, and configure runtime/environment settings.

Install base dependencies

sudo apt install -y git curl wget unzip ca-certificates gnupg ufw

Install runtime dependencies

Paperclip public materials identify a Node.js server and React UI, with agents driven through adapters and heartbeat-style execution. For NPX or manual source paths, confirm Node.js 20+ and pnpm 9.15+ before relying on the server setup; install Docker separately if you choose the container path, and review Paperclip's Docker notes for API key wiring, persistence, host binding, and public URL handling.

Install or clone Paperclip

Paperclip documents an NPX Onboard quickstart, a manual Git clone path, and Docker deployment. Choose one path for the first test so you do not run multiple Paperclip processes on the same port. Keep the default loopback/private setup until authentication, public URL, host binding, and firewall exposure are reviewed.

# Choose ONE path for the first test; do not paste this whole block as one script.

# Option 1: NPX quickstart path from current public docs
npx paperclipai onboard --yes
paperclipai run

# Option 2: Manual Git clone path for contributors or advanced customization
git clone https://github.com/paperclipai/paperclip.git
cd paperclip
pnpm install
pnpm dev

# Option 3: Docker path from the Paperclip repository
git clone https://github.com/paperclipai/paperclip.git
cd paperclip
docker compose -f docker/docker-compose.quickstart.yml up --build

Configure Paperclip settings

For Paperclip, use the configuration command for the setup path you already selected. The quickstart onboarding command creates the initial configuration; do not rerun onboarding during the normal configuration step unless you are intentionally resetting or changing the bind preset. Review server exposure, bind mode, deployment mode, database, storage, public URL, allowed hosts, and provider secret handling before opening remote access.

# Inspect current config-derived environment
paperclipai env

# Reconfigure only the sections you need
paperclipai configure --section server
paperclipai configure --section database
paperclipai configure --section storage

# If the Paperclip binary is not on PATH, use npx paperclipai ... instead.

Start Paperclip

Start Paperclip with the same path you used for setup. The quickstart path should continue with the Paperclip CLI run command printed by onboarding; the repository development path should use the documented development command for development validation only.

# Choose the command that matches your setup.

# NPX/onboard path after setup
paperclipai run
# If needed:
npx paperclipai run

# Use a custom config only if you created and reviewed one
paperclipai run --config /path/to/config.json

# Source development path only; do not treat this as a production service wrapper
pnpm dev

Run, secure, and maintain

Keep the selected Paperclip server path observable, lock down access, test the setup, and plan ongoing maintenance.

Keep It Running

Use the process-management path that matches the deployment you selected. For the quickstart path, first verify the Paperclip run command printed by onboarding, then place that reviewed command behind a service manager only after config, bind mode, authentication, public URL, database/storage, and secret storage are understood. For a source checkout, keep pnpm dev clearly labeled as development-only and separated from any production service wrapper.

# Choose the command that matches your setup.
paperclipai run
# If needed:
npx paperclipai run

# Or, from a development-only source checkout:
pnpm dev

Secure the VPS

Use SSH keys where possible, restrict password login if appropriate, enable a firewall, expose only the ports Paperclip actually needs, protect Paperclip instance config, local encryption keys, provider credentials, and database backups, keep packages updated, and use backups or snapshots before major changes. Do not open port 3100 publicly until authenticated mode, allowed hosts, public URL, private networking, or a TLS reverse proxy has been reviewed.

sudo ufw allow OpenSSH
sudo ufw enable
sudo ufw status verbose

Test the Setup

Confirm the Paperclip process starts, run paperclipai doctor where available, check logs, test provider authentication, test any webhook or interface the setup uses, restart the VPS, and confirm the service returns cleanly.

Maintain It Over Time

Review Paperclip logs, rotate keys when needed, monitor disk usage, monitor RAM and CPU usage, update framework dependencies, snapshot before upgrades, test restores, and keep rollback notes.

Why Paperclip Benefits from a VPS

Paperclip benefits from a VPS because the server, UI, adapters, heartbeats, tasks, budgets, and logs should be reachable in one controlled place when multiple agents or scheduled wakeups are involved.

01

Central multi-agent runtime

Keep the Paperclip server, UI, agent state, adapters, database/storage path, and background services together in an always-on environment.

02

Observable heartbeats and tasks

Track wakeups, recurring work, process output, failures, and retries from a single server-side log trail.

03

Clear adapter and credential boundaries

Document adapters, credentials, allowed actions, network access, cost limits, and storage paths before connecting real work.

04

Controlled scaling path

Map the company structure, agents, adapters, credentials, run frequency, and storage needs before opening the system to real work. Multi-agent orchestration should be observed with logs and budgets before scaling.

Security Basics for Paperclip on a VPS

Privileged runtime

The server can contain agent adapters, heartbeats, company state, UI/API services, credentials, local encryption keys, database files, and run logs. Harden it before production use, and use authenticated mode or private networking before remote users connect.

Troubleshooting

Common setup problems to check before blaming the VPS or framework.

SSH issues

SSH connection refused

Server firewall, wrong IP, or SSH service unavailable Confirm the VPS is running, check the IP, and verify port 22 or your configured SSH port.

Permission denied over SSH

Wrong key, wrong user, or disabled login method Check ~/.ssh/authorized_keys, user permissions, and your SSH config.

Dependency and runtime issues

Missing dependencies

Base packages or runtime packages were not installed Re-run the dependency step and compare runtime versions with official Paperclip docs.

Node.js or pnpm mismatch

The selected Paperclip path expects a different Node.js or pnpm version Use the version manager or package source recommended by upstream docs.

Docker and process issues

Docker service not running

Docker daemon stopped or not installed This only applies if your Paperclip deployment path uses Docker; otherwise inspect the Paperclip CLI or Node process logs instead.

Process stops after logout

Paperclip was started from an interactive shell Verify paperclipai run or the source command first, then run that reviewed command through a service manager if you need it to survive logout.

Port and firewall issues

Paperclip service, dashboard, API, webhook, or supporting tool port already in use

A selected Paperclip service, dashboard, API, webhook, or supporting tool is bound to a port already used by another process Run ss -tulpn and move one service to a different port.

Firewall blocking Paperclip service, dashboard, API, webhook, or supporting tool access

A required Paperclip service, dashboard, API, webhook, or supporting tool port is not open Open only the required port, and keep all other ports restricted. Do not expose Paperclip publicly until authenticated mode, private networking, or a TLS reverse proxy is in place.

Environment and API key issues

Missing configuration or credentials

Configuration is absent or incomplete Compare the generated configuration with the selected deployment path and add only the secrets and paths required.

Invalid API key or provider error

Key is wrong, expired, or lacks access Rotate the key through the provider and update the server configuration.

Disk and memory issues

Disk space issues

Logs, caches, repositories, or embedded database files grew over time Check df -h, rotate logs, clean caches, back up required data, and scale storage if needed.

High memory usage

Too many agents, adapters, heartbeats, or background jobs Reduce concurrency, inspect process memory, and scale the VPS if the workload is valid.

When This Setup Is Not Necessary

Local testing is enough

You may not need a VPS if you are only testing Paperclip locally, working from one private machine, reviewing a small repository, or experimenting without persistent SSH access.

Server management may be unnecessary

This setup is not ideal if you do not want to manage Linux updates, SSH access, firewall rules, disk usage, credentials, or repository permissions yourself.

Use a VPS for persistent remote state

Use a VPS when the workspace, company state, logs, tools, and multi-agent workflow should stay available in a controlled remote environment.

Ready to run Paperclip on an always-on VPS?

Deploy a Paperclip VPS, keep the first setup private, and use this guide with the official Paperclip docs as your review checklist while you prepare the runtime, access controls, backups, and logs.

FAQ

Can I run Paperclip on a VPS?

Yes, if the Paperclip release supports the Linux distribution and runtime path you choose, and the deployment mode is configured safely. Use this guide together with the current official documentation.

Do I need a GPU VPS for Paperclip?

Not for the VPS runtime pattern described here. This guide focuses on the Paperclip server, React UI, adapters, heartbeats, provider access, company state, and run logs. Verify separate hardware needs if you plan local model inference.

Does Virtarix provide API keys or model access?

No. Bring your own provider accounts, credentials, API keys, model access, repositories, and framework configuration.

What VPS size should I use for Paperclip?

Start a practical test with the recommended Virtarix Starter VPS, then scale after measuring CPU, RAM, storage, and process count for agent adapters, heartbeats, companies, UI/API services, database/storage growth, and run logs.

Can Paperclip keep running without my local machine?

Yes, if Paperclip is run as a server-side process using the documented Paperclip run command and a reviewed service or process-management method. The VPS keeps agent adapters, heartbeats, companies, UI/API services, and run logs separate from your local desktop session; public access still needs reviewed authentication, allowed hosts, and network controls.

Can I use Docker for this setup?

Yes. Paperclip documents Docker as an installation method; use it when you want a containerized deployment and can manage the documented compose file, volumes, ports, secrets, public URL, updates, and backups deliberately.

Is Virtarix operating Paperclip for me?

No. Virtarix provides the VPS infrastructure. You install, configure, secure, update, and operate the software you run on it.