For system administrators

Installation instructions

npm is the recommended installation method if there isn’t documentation for your specific distribution listed below. The pump.io project strongly recommends that users avoid source-based installs.

• Prerequisites
• Installation channels
• Generic npm-based install
• Generic source-based install
• About Docker images

Configuration details

• Configuration value reference
• Configuration via CLI flags
• Configuration via environment variables
• Configuration via JSON configuration files

• Running the daemon
• Set NODE_ENV for better performance

• Using Certbot and Let’s Encrypt for HTTPS in pump.io
• Self-signed certs and CACert non-support in pump.io

• Using a web server proxy

Upgrade instructions

• 1.x to 2.x
  • For npm-based installs
  • For source-based installs
  • Migrating plugins
• 2.x to 3.x
  • For npm-based installs
  • For source-based installs
  • Migrating to datadir
• 3.x to 4.x
  • For npm-based installs
  • For source-based installs
  • Migrating plugins
• 4.x to 5.x
  • For npm-based installs
  • For source-based installs
  • Upgrading Node.js
  • Adjusting appendFooter
  • Dealing with systemd changes

Routine maintenance

• Viewing pump.io logs
  • Installing the Bunyan CLI
  • Viewing your logs
  • Filtering logs
• Using the upstream pump.io systemd unit
• Using zero-downtime restarts
• Migrating hosts

See also the Sysadmin FAQ.