verdaccio Installation Guide Installation Guide

verdaccio is a free and open-source npm registry proxy. Verdaccio provides lightweight private npm proxy registry

Hardware Requirements:

CPU: 1 core minimum

RAM: 512MB minimum

Storage: 10GB for packages

Network: HTTP/HTTPS access

Operating System:

Linux: Any modern distribution (RHEL, Debian, Ubuntu, CentOS, Fedora, Arch, Alpine, openSUSE)

macOS: 10.14+ (Mojave or newer)

Windows: Windows Server 2016+ or Windows 10

FreeBSD: 11.0+

Network Requirements:

Port 4873 (default verdaccio port)

None

Dependencies:

See official documentation for specific requirements

System Access: root or sudo privileges required

This guide supports installation on:

RHEL 8/9 and derivatives (CentOS Stream, Rocky Linux, AlmaLinux)

Debian 11/12

Ubuntu 20.04/22.04/24.04 LTS

Arch Linux (rolling release)

Alpine Linux 3.18+

openSUSE Leap 15.5+ / Tumbleweed

SUSE Linux Enterprise Server (SLES) 15+

macOS 12+ (Monterey and later)

FreeBSD 13+

Windows 10/11/Server 2019+ (where applicable)

bash

# Install EPEL repository if needed
sudo dnf install -y epel-release

# Install verdaccio
sudo dnf install -y verdaccio

# Enable and start service
sudo systemctl enable --now verdaccio

# Configure firewall
sudo firewall-cmd --permanent --add-port=4873/tcp
sudo firewall-cmd --reload

# Verify installation
verdaccio --version

bash

# Update package index
sudo apt update

# Install verdaccio
sudo apt install -y verdaccio

# Enable and start service
sudo systemctl enable --now verdaccio

# Configure firewall
sudo ufw allow 4873

# Verify installation
verdaccio --version

bash

# Install verdaccio
sudo pacman -S verdaccio

# Enable and start service
sudo systemctl enable --now verdaccio

# Verify installation
verdaccio --version

bash

# Install verdaccio
apk add --no-cache verdaccio

# Enable and start service
rc-update add verdaccio default
rc-service verdaccio start

# Verify installation
verdaccio --version

bash

# Install verdaccio
sudo zypper install -y verdaccio

# Enable and start service
sudo systemctl enable --now verdaccio

# Configure firewall
sudo firewall-cmd --permanent --add-port=4873/tcp
sudo firewall-cmd --reload

# Verify installation
verdaccio --version

bash

# Using Homebrew
brew install verdaccio

# Start service
brew services start verdaccio

# Verify installation
verdaccio --version

bash

# Using pkg
pkg install verdaccio

# Enable in rc.conf
echo 'verdaccio_enable="YES"' >> /etc/rc.conf

# Start service
service verdaccio start

# Verify installation
verdaccio --version

bash

# Using Chocolatey
choco install verdaccio

# Or using Scoop
scoop install verdaccio

# Verify installation
verdaccio --version

bash

# Create configuration directory
sudo mkdir -p /etc/verdaccio

# Set up basic configuration
# See official documentation for detailed configuration options

# Test configuration
verdaccio --version

bash

# Enable service
sudo systemctl enable verdaccio

# Start service
sudo systemctl start verdaccio

# Stop service
sudo systemctl stop verdaccio

# Restart service
sudo systemctl restart verdaccio

# Check status
sudo systemctl status verdaccio

# View logs
sudo journalctl -u verdaccio -f

bash

# Enable service
rc-update add verdaccio default

# Start service
rc-service verdaccio start

# Stop service
rc-service verdaccio stop

# Restart service
rc-service verdaccio restart

# Check status
rc-service verdaccio status

bash

# Enable in /etc/rc.conf
echo 'verdaccio_enable="YES"' >> /etc/rc.conf

# Start service
service verdaccio start

# Stop service
service verdaccio stop

# Restart service
service verdaccio restart

# Check status
service verdaccio status

bash

# Using Homebrew services
brew services start verdaccio
brew services stop verdaccio
brew services restart verdaccio

# Check status
brew services list | grep verdaccio

powershell

# Start service
net start verdaccio

# Stop service
net stop verdaccio

# Using PowerShell
Start-Service verdaccio
Stop-Service verdaccio
Restart-Service verdaccio

# Check status
Get-Service verdaccio

See the official documentation for advanced configuration options.

nginx

upstream verdaccio_backend {
    server 127.0.0.1:4873;
}

server {
    listen 80;
    server_name verdaccio.example.com;
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name verdaccio.example.com;

    ssl_certificate /etc/ssl/certs/verdaccio.example.com.crt;
    ssl_certificate_key /etc/ssl/private/verdaccio.example.com.key;

    location / {
        proxy_pass http://verdaccio_backend;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

apache

<VirtualHost *:80>
    ServerName verdaccio.example.com
    Redirect permanent / https://verdaccio.example.com/
</VirtualHost>

<VirtualHost *:443>
    ServerName verdaccio.example.com
    
    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/verdaccio.example.com.crt
    SSLCertificateKeyFile /etc/ssl/private/verdaccio.example.com.key
    
    ProxyRequests Off
    ProxyPreserveHost On
    
    ProxyPass / http://127.0.0.1:4873/
    ProxyPassReverse / http://127.0.0.1:4873/
</VirtualHost>

haproxy

frontend verdaccio_frontend
    bind *:80
    bind *:443 ssl crt /etc/ssl/certs/verdaccio.pem
    redirect scheme https if !{ ssl_fc }
    default_backend verdaccio_backend

backend verdaccio_backend
    balance roundrobin
    server verdaccio1 127.0.0.1:4873 check

bash

# Set appropriate permissions
sudo chown -R verdaccio:verdaccio /etc/verdaccio
sudo chmod 750 /etc/verdaccio

# Configure firewall
sudo firewall-cmd --permanent --add-port=4873/tcp
sudo firewall-cmd --reload

# Enable SELinux policies (if applicable)
sudo setsebool -P httpd_can_network_connect on

See official documentation for database configuration requirements.

bash

# Basic system tuning
echo 'net.core.somaxconn = 65535' | sudo tee -a /etc/sysctl.conf
echo 'net.ipv4.tcp_max_syn_backlog = 65535' | sudo tee -a /etc/sysctl.conf
sudo sysctl -p

bash

# Check service status
sudo systemctl status verdaccio

# View logs
sudo journalctl -u verdaccio -f

# Monitor resource usage
top -p $(pgrep verdaccio)

bash

#!/bin/bash
# Basic backup script
BACKUP_DIR="/backup/verdaccio"
DATE=$(date +%Y%m%d_%H%M%S)

mkdir -p "$BACKUP_DIR"
tar -czf "$BACKUP_DIR/verdaccio-backup-$DATE.tar.gz" /etc/verdaccio /var/lib/verdaccio

echo "Backup completed: $BACKUP_DIR/verdaccio-backup-$DATE.tar.gz"

bash

# Stop service
sudo systemctl stop verdaccio

# Restore from backup
tar -xzf /backup/verdaccio/verdaccio-backup-*.tar.gz -C /

# Start service
sudo systemctl start verdaccio

1. Service won't start:

bash

# Check logs
sudo journalctl -u verdaccio -n 100
sudo tail -f /var/log/verdaccio/verdaccio.log

# Check configuration
verdaccio --version

# Check permissions
ls -la /etc/verdaccio

2. Connection issues:

bash

# Check if service is listening
sudo ss -tlnp | grep 4873

# Test connectivity
telnet localhost 4873

# Check firewall
sudo firewall-cmd --list-all

3. Performance issues:

bash

# Check resource usage
top -p $(pgrep verdaccio)

# Check disk I/O
iotop -p $(pgrep verdaccio)

# Check connections
ss -an | grep 4873

yaml

version: '3.8'
services:
  verdaccio:
    image: verdaccio:latest
    ports:
      - "4873:4873"
    volumes:
      - ./config:/etc/verdaccio
      - ./data:/var/lib/verdaccio
    restart: unless-stopped

Maintenance

bash

# RHEL/CentOS/Rocky/AlmaLinux
sudo dnf update verdaccio

# Debian/Ubuntu
sudo apt update && sudo apt upgrade verdaccio

# Arch Linux
sudo pacman -Syu verdaccio

# Alpine Linux
apk update && apk upgrade verdaccio

# openSUSE
sudo zypper update verdaccio

# FreeBSD
pkg update && pkg upgrade verdaccio

# Always backup before updates
tar -czf /backup/verdaccio-pre-update-$(date +%Y%m%d).tar.gz /etc/verdaccio

# Restart after updates
sudo systemctl restart verdaccio

Regular Maintenance

bash

# Log rotation
sudo logrotate -f /etc/logrotate.d/verdaccio

# Clean old logs
find /var/log/verdaccio -name "*.log" -mtime +30 -delete

# Check disk usage
du -sh /var/lib/verdaccio

Official Documentation: https://docs.verdaccio.org/

GitHub Repository: https://github.com/verdaccio/verdaccio

Community Forum: https://forum.verdaccio.org/

Best Practices Guide: https://docs.verdaccio.org/best-practices

---

Note: This guide is part of the HowToMgr collection. Always refer to official documentation for the most up-to-date information.

1. Prerequisites

2. Supported Operating Systems

3. Installation

RHEL/CentOS/Rocky Linux/AlmaLinux

Debian/Ubuntu

Arch Linux

Alpine Linux

openSUSE/SLES

macOS

FreeBSD

Windows

Initial Configuration

Basic Configuration

5. Service Management

systemd (RHEL, Debian, Ubuntu, Arch, openSUSE)

OpenRC (Alpine Linux)

rc.d (FreeBSD)

launchd (macOS)

Windows Service Manager

Advanced Configuration

Reverse Proxy Setup

nginx Configuration

Apache Configuration

HAProxy Configuration

Security Configuration

Basic Security Setup

Database Setup

Performance Optimization

System Tuning

Monitoring

Basic Monitoring

9. Backup and Restore

Backup Script

Restore Procedure

6. Troubleshooting

Common Issues

Integration Examples

Docker Compose Example

Maintenance

Update Procedures

Regular Maintenance

Additional Resources

Related Package repositories Guides

aptly Installation Guide

pulp Installation Guide

pypiserver Installation Guide