CloudPanel Commands cheatsheet

clpctl user:add \
    --userName='john.doe' \
    --email='[email protected]' \
    --firstName='John' \
    --lastName='Doe' \
    --password='!password!' \
    --role='admin' \
    --timezone='UTC' \
    --status='1'

# Delete User
clpctl user:delete --userName='john.doe'

# List Users
clpctl user:list

# Reset Password
clpctl user:reset:password \
    --userName='stefan' \
    --password='stefan87'

# Disable MFA
clpctl user:disable:mfa --userName='stefan'

# Node.js Site
clpctl site:add:nodejs \
    --domainName=www.domain.com \
    --nodejsVersion=16 \
    --appPort=3000 \
    --siteUser=user \
    --siteUserPassword='password'

# Static HTML Site
clpctl site:add:static \
    --domainName=www.domain.com \
    --siteUser=user \
    --siteUserPassword='password'

# Python Site
clpctl site:add:python \
    --domainName=www.domain.com \
    --pythonVersion=3.9 \
    --appPort=8080 \
    --siteUser=user \
    --siteUserPassword='password'

# PHP Site
clpctl site:add:php \
    --domainName=www.domain.com \
    --phpVersion=8.1 \
    --vhostTemplate='Generic' \
    --siteUser=user \
    --siteUserPassword='password'

# Reverse Proxy
clpctl site:add:reverse-proxy \
    --domainName=www.domain.com \
    --reverseProxyUrl='http://8.8.8.8' \
    --siteUser='user' \
    --siteUserPassword='password'

# Delete Site
clpctl site:delete --domainName=www.domain.com

# Install Certificate
clpctl site:install:certificate \
    --domainName=www.domain.com \
    --privateKey=/path/to/private.key \
    --certificate=/path/to/certificate.crt \
    --certificateChain=/path/to/chain.crt

# Show Master Credentials
clpctl db:show:master-credentials

# Add Database
clpctl db:add \
    --domainName=www.domain.com \
    --databaseName=dbname \
    --databaseUserName=user \
    --databaseUserPassword='password'

# Export Database
clpctl db:export \
    --databaseName=dbname \
    --file=dump.sql

# Import Database
clpctl db:import \
    --databaseName=dbname \
    --file=dump.sql

# Delete Database
clpctl db:delete --databaseName=dbname

# Backup Databases
clpctl db:backup \
    --ignoreDatabases='db1,db2' \
    --retentionPeriod=7

# Install Certificate
clpctl lets-encrypt:install:certificate \
    --domainName=www.domain.com

# With Alternative Names
clpctl lets-encrypt:install:certificate \
    --domainName=www.domain.com \
    --subjectAlternativeName=domain1.com,www.domain1.com

# Renew Certificates
clpctl lets-encrypt:renew:certificates

# Renew Custom Domain
clpctl lets-encrypt:renew:custom-domain:certificate

# Basic Auth
clpctl cloudpanel:enable:basic-auth \
    --userName='user' \
    --password='password'

clpctl cloudpanel:disable:basic-auth

# Release Channel
clpctl cloudpanel:set:release-channel --channel='stable'
clpctl cloudpanel:set:release-channel --channel='test'

# Delete Sites
clpctl cloudpanel:delete:sites

# Config Values
clpctl app:get:config-value 'cloud'
clpctl app:get:config-value 'release_channel'

# Check Cloudpanel Version
apt list --installed | grep cloudpanel

# Reset Permissions
clpctl system:permissions:reset \
    --path=. \
    --directories=770 \
    --files=660

# Clean Monitoring Data
clpctl monitoring:data:clean

# Create Remote Backup
clpctl remote-backup:create

# AWS
clpctl aws:image:create --frequency=3

# DigitalOcean
clpctl do:snapshot:create --frequency=3

# Google Cloud
clpctl gce:snapshot:create --frequency=3

# Vultr
clpctl vultr:snapshot:create --frequency=3

# Import Templates
clpctl vhost-templates:import
clpctl vhost-templates:import --delay=true

# List Templates
clpctl vhost-templates:list

# Add Template
clpctl vhost-template:add \
    --name='My Application' \
    --file=/tmp/template.tpl

# Delete Template
clpctl vhost-template:delete --name='My Application'

# View Template
clpctl vhost-template:view --name='My Application'