Knowledgebase

 Automated Installation

Recommended system specifications A freshly installed supported OS At least 1 GiB RAM (full...

 backup-domain

Backup one or more virtual servers This program is analogous to the Backup Virtual Servers page...

 change-password

Changes the password of some Virtualmin user Designed to be called from Usermin’s Change...

 check-config

Run the Virtualmin config check This program checks your system’s Virtualmin configuration,...

 check-connectivity

Checks the external accessibility of virtual servers This command will run various tests to...

 clone-domain

Duplicates an existing virtual server with a new name This command will duplicate an existing...

 Command Line API

Virtualmin includes a powerful virtualmin command-line script, that can be run from the Unix...

 Configuring Multiple PHP Versions

Virtualmin allows the selection of different PHP versions and execution modes for each domain....

 Configuring Multiple PHP Versions

Virtualmin allows the selection of different PHP versions and execution modes for each domain....

 Configuring Nginx as Default Webserver

Overview Nginx is a high-performance web server known for its speed and efficiency, particularly...

 Configuring Nginx as Default Webserver

Overview Nginx is a high-performance web server known for its speed and efficiency, particularly...

 create-admin

Creates an extra administrator for a virtual server This command creates a new administrator...

 create-alias

Create a new mail alias This command can be used to add a new email alias to a virtual server. It...

 create-database

Creates a database for a virtual server This command creates a new MySQL/MariaDB or PostgreSQL...

 create-domain

Create a virtual server This program can be used to create a new top-level, child or alias...

 create-login-link

Generates a link that can be used to login to Virtualmin This command can be used to login to...

 create-plan

Creates a new account plan for use with virtual servers This command allows you to create a new...

 create-protected-directory

Adds protection to a directory owned by some virtual server This command sets up protection for a...

 create-protected-user

Add a user to some protected directory This command adds a user to a protected directory,...

 create-proxy

Adds a per-directory proxy to some domain A proxy maps some URL on a virtual server to another...

 create-redirect

Adds a web redirect or alias to some domain A redirect maps some URL path like /foo to either a...

 create-reseller

Create one reseller account This command adds a single reseller account to your Virtualmin...

 create-simple-alias

Adds a mail alias to some domain, with simple parameters This command allows aliases using...

 create-template

Creates a template for use by new domains This command can be used to create a new virtual server...

 create-user

Create a mail, FTP or database user This program adds a new user to an existing virtual server....

 delete-admin

Deletes an extra administrator from a virtual server This command removes one extra administrator...

 delete-alias

Delete a mail alias This program simply removes a single mail alias from a virtual server. It...

 delete-database

Deletes one database To remove a single database from a virtual server and delete all of its...

 delete-domain

Delete one or more virtual servers To delete one or many servers (and all of their sub-servers...

 delete-php-directory

Remove any custom version of PHP for some directory If a specific version of PHP has been...

 delete-protected-directory

Removes protection from a directory owned by some virtual server This command turns off...

 delete-protected-user

Removes a user from some protected directory This command removes a user from a protected...

 delete-proxy

Removes a proxy balancer from some domain This command deletes one proxy path from the virtual...

 delete-redirect

Removes a web redirect or alias from some domain This command deletes one redirect from the...

 delete-script

Un-install one script from a virtual server This program completely removes a third-party script...

 delete-user

Delete a mail, FTP or database user This command deletes one mail, FTP or database user from a...

 Disable automatic SSL website creation

By default, Virtualmin creates an SSL website record in the webserver configuration and...

 Disable automatic SSL website creation

By default, Virtualmin creates an SSL website record in the webserver configuration and...

 disable-domain

Temporarily disable a virtual server When a server is disabled, it will become temporarily...

 disable-feature

Turn off some features for a virtual server This program is very similar to enable-feature, and...

 disable-limit

Removes access to some feature or edit capability for some virtual servers This command can be...

 disable-writelogs

Disable logging via program This command is the opposite enable-writelogs. The domains that it...

 disconnect-database

Removes a database from the control of a virtual server This command removes access to a database...

 Domain Registration

Virtualmin provides a plugin to automate domain registration, streamlining the process of setting...

 Domain Registration

Virtualmin provides a plugin to automate domain registration, streamlining the process of setting...

 DomainKeys Identified Mail

DomainKeys Identified Mail (DKIM) is a standard that enhances email security by enabling the...

 DomainKeys Identified Mail

DomainKeys Identified Mail (DKIM) is a standard that enhances email security by enabling the...

 enable-domain

Re-enable one virtual server This program reverses the disable process done by disable-domain ,...

 enable-feature

Turn on some features for a virtual server To enable features for one or more servers from the...

 enable-limit

Grants access to some feature or edit capability for some virtual servers This command can be...

 enable-writelogs

Enable logging via program By default, Virtualmin configures Apache to log to files in each...

 Exploring Backup Structure

This tutorial helps Virtualmin users understand what’s inside a Virtualmin backup file,...

 FAQ

FAQ Installation Should I pre-install Webmin before I run virtualmin-install.sh script? No....

 FAQ

FAQ Installation Should I pre-install Webmin before I run virtualmin-install.sh script? No....

 fix-domain-permissions

Set correct permissions on a domain’s home directory This command ensures that the ownership and...

 fix-domain-quota

Set the Unix quotas for some domains to match the Virtualmin configuration This command can be...

 generate-cert

Generate a new self-signed cert or CSR for a virtual server A self-signed certificate is one that...

 generate-letsencrypt-cert

Requests and installs a Let’s Encrypt cert for a virtual server The server must be specified with...

 get-dns

Output all DNS records for a domain For virtual servers with DNS enabled, this command provides...

 get-logs

Output webserver logs for a domain Given a domain name with the --domain flag, this command...

 get-ssl

Output SSL certificate information for a domain Given a domain name with the --domain flag, this...

 Hold and Forward Backup Mail Server

A secondary MX (Mail Exchange) server acts as a backup for handling emails if the primary mail...

 Hold and Forward Backup Mail Server

A secondary MX (Mail Exchange) server acts as a backup for handling emails if the primary mail...

 How to Add an SSL Certificate

This guide streamlines the process of adding SSL certificates, whether free or commercial, to...

 How to Add an SSL Certificate

This guide streamlines the process of adding SSL certificates, whether free or commercial, to...

 How to Backup and Restore Virtual Servers

This tutorial provides detailed guidance on creating and restoring backups for virtual servers in...

 How to Change User Password

This tutorial provides a straightforward method for changing the password of a SSH, FTP, mailbox,...

 How to Change User Password

This tutorial provides a straightforward method for changing the password of a SSH, FTP, mailbox,...

 How to Change Virtual Server Owner’s Password

This tutorial provides a concise guide on changing the password of a virtual server owner in...

 How to Change Virtual Server Owner’s Password

This tutorial provides a concise guide on changing the password of a virtual server owner in...

 How to Configure a Catch-All Alias Account

A catch-all email address is used to receive or reject emails sent to invalid addresses within...

 How to Configure a Catch-All Alias Account

A catch-all email address is used to receive or reject emails sent to invalid addresses within...

 How to Configure a Catch-All Email Account

Learn how to configure a catch-all email account in Virtualmin, designed to receive all emails...

 How to Configure a Catch-All Email Account

Learn how to configure a catch-all email account in Virtualmin, designed to receive all emails...

 How to Configure Cloudflare DNS

For users looking to integrate Cloudflare with Virtualmin Pro, the process is straightforward and...

 How to Configure Cloudflare DNS

For users looking to integrate Cloudflare with Virtualmin Pro, the process is straightforward and...

 How to Configure LDAP

This documentation explains how Virtualmin can be setup to store users and mail aliases in an...

 How to Configure Secondary DNS

This guide provides administrators with a quick overview of setting up automatic DNS secondary...

 How to Configure Secondary DNS

This guide provides administrators with a quick overview of setting up automatic DNS secondary...

 How to Create a New Database

This guide provides a straightforward approach to creating a new MySQL/MariaDB or PostgreSQL...

 How to Create a New Database

This guide provides a straightforward approach to creating a new MySQL/MariaDB or PostgreSQL...

 How to Create an Auto-Responder

This tutorial demonstrates how to set up an email auto-responder in Virtualmin, a useful tool for...

 How to Create an Auto-Responder

This tutorial demonstrates how to set up an email auto-responder in Virtualmin, a useful tool for...

 How to Create an Email Account

This tutorial provides a straightforward guide on creating an email account in Virtualmin, which...

 How to Create an Email Account

This tutorial provides a straightforward guide on creating an email account in Virtualmin, which...

 How to Create an FTP Account

This guide offers a straightforward approach to creating an FTP account for a virtual server in...

 How to Create an FTP Account

This guide offers a straightforward approach to creating an FTP account for a virtual server in...

 How to Create Virtual Servers

This quick guide details the process of creating new virtual servers....

 How to Create Virtual Servers

This quick guide details the process of creating new virtual servers....

 How to Install Scripts

This tutorial guides you through the process of using Virtualmin’s script installer to add web...

 How to Install Scripts

This tutorial guides you through the process of using Virtualmin’s script installer to add web...

 How to Log In to Virtualmin

This guide provides step-by-step instructions on how to log into the Virtualmin control panel....

 How to Log In to Virtualmin

This guide provides step-by-step instructions on how to log into the Virtualmin control panel....

 How to Manage URL Redirects

This guide provides a comprehensive overview of setting up URL redirects in Virtualmin. Perfect...

 How to Manage URL Redirects

This guide provides a comprehensive overview of setting up URL redirects in Virtualmin. Perfect...

 How to Migrate to a New Server

Migrating your Virtualmin installation to a new server involves several steps, such as backups...

 How to Navigate in Virtualmin

This tutorial covers the basics of navigating Virtualmin, designed for a range of user roles from...

 How to Navigate in Virtualmin

This tutorial covers the basics of navigating Virtualmin, designed for a range of user roles from...

 How to Password Protect a Directory

This guide explains how to password-protect a directory within your website using Virtualmin,...

 How to Password Protect a Directory

This guide explains how to password-protect a directory within your website using Virtualmin,...

 How to Setup Email Forwarding

This guide outlines the process of setting up email forwarding in Virtualmin, enabling you to...

 How to Setup Email Forwarding

This guide outlines the process of setting up email forwarding in Virtualmin, enabling you to...

 How to View Website Access and Error Logs

This guide simplifies the process of viewing website access and error logs in Virtualmin. How to...

 How to View Website Access and Error Logs

This guide simplifies the process of viewing website access and error logs in Virtualmin. How to...

 IMAP/POP3 and SMTP Authentication

Virtualmin automates the configuration of Dovecot for IMAP/POP3 services and configures Cyrus...

 IMAP/POP3 and SMTP Authentication

Virtualmin automates the configuration of Dovecot for IMAP/POP3 services and configures Cyrus...

 import-database

Adds an existing database to a virtual server This command finds a MySQL/MariaDB or PostgreSQL...

 install-cert

Replace the SSL certificate or private key for a virtual server This command is typically used to...

 install-script

Install one third-party script This program performs the actual upgrade or install of a script...

 install-service-cert

Copy the cert and key from a virtual server to some other service The domain to copy the cert...

 list-admins

Lists administrators belonging to a virtual server This program simply displays a list of extra...

 list-aliases

List aliases for a virtual server This program displays a list of mail aliases that exist in the...

 list-available-shells

List all shells for use with domain owners and mailboxes When run with no flags, this command...

 list-backup-logs

Outputs a list of backups that have been run This command by default outputs logs of all backups...

 list-bandwidth

Shows bandwidth usage for some domain over a date range This command is useful for dumping...

 list-certs

Output the certificates for some or all virtual servers The virtual servers to list can be...

 list-certs-expiry

Output the certificates expiry date for matching or all existing virtual servers This program can...

 list-config-revisions

List configuration file revisions from Git This command lists revisions of configuration files...

 list-custom

List custom fields for virtual servers When this command is run with no parameters, it will...

 list-databases

Lists databases for some virtual server This program simply displays a list of MySQL/MariaDB and...

 list-domains

Lists all virtual servers This program does not modify the system, but instead simply outputs a...

 list-features

Lists features available when creating a domain This command outputs information about Virtualmin...

 list-mailbox

Dump inbox email for one user This program is primarily for debugging and testing. It finds the...

 list-php-directories

List all directories in which a specific version of PHP has been activated By default this...

 list-php-ini

Show PHP variables for some or all domains This command can be used to list the value of a PHP...

 list-php-versions

Lists the available PHP versions on this system This command simply outputs a table of the...

 list-plans

List available account plans for new domains The command simply outputs a list of available plans...

 list-ports

Lists TCP ports associated with some virtual server This command lists all TCP ports in use by or...

 list-protected-directories

Lists protected directories owned by some virtual server This command outputs a table of all...

 list-protected-users

Lists users in some protected directory This command outputs a table of all users with access to...

 list-proxies

Lists web proxy balancers in some domain This command lists all the proxies configured for some...

 list-redirects

Lists web redirects and aliases in some domain This command lists all the aliases configured for...

 list-scheduled-backups

Outputs a list of scheduled backups By default, this program displays a table of all scheduled...

 list-scripts

Display script installed into some virtual server The virtual servers to display scripts for can...

 list-service-certs

Output a virtual server’s certificates used by other services The only required flag is --domain,...

 list-simple-aliases

Lists mail aliases in a simple format for some domain This program is similar to list-aliases,...

 list-templates

List available templates for new domains The command simply outputs a list of available templates...

 list-users

List users in a virtual server To get a list of users associated with some virtual server, this...

 Managing Databases

This tutorial outlines the process for managing databases within Virtualmin. How to manage your...

 Managing Databases

This tutorial outlines the process for managing databases within Virtualmin. How to manage your...

 Manual Installation

Unlike the Automated Virtualmin installation, to make use of this installation type, your OS does...

 migrate-domain

Imports a virtual server from some other product Virtualmin has the capability to import servers...

 modify-admin

Updates an extra administrator for a virtual server This program can be used to change the...

 modify-custom

Modify custom fields for a virtual server This program updates the value of one or more fields...

 modify-database-hosts

Adds or removes an allowed MySQL host for some or all domains This command can change the remote...

 modify-database-pass

Changes the MySQL/MariaDB or PostgreSQL password for some domain This command changes the...

 modify-database-user

Changes the MySQL/MariaDB or PostgreSQL login for some domain This command changes the username...

 modify-dns

Change DNS settings for virtual servers This program updates DNS-related options for one or more...

 modify-domain

Change parameters of a virtual server This command can be used to modify various settings for an...

 modify-limits

Changes the owner limits for some virtual server This command allows you to change various limits...

 modify-mail

Change mail-related settings for some domains This command can be used to configure BCC of...

 modify-php-ini

Changes PHP variables for some or all domains This command can be used to change the value of a...

 modify-plan

Modifies an existing account plan for use with virtual servers This command allows you to modify...

 modify-proxy

Changes a proxy balancer from some domain This command updates one proxy path from the virtual...

 modify-reseller

Modify attributes for an existing reseller This command can be used to change the details of a...

 modify-resources

Changes resource limits for some virtual servers This program allows you to change limits on...

 modify-spam

Change spam filtering and delivery settings for a virtual server This command can be used to...

 modify-user

Change attributes of a mail, FTP or database user After a user has been created from the command...

 modify-users

Modify attributes of some or all users for some or all virtual servers This command can be used...

 modify-web

Change a virtual server’s web configuration This script can update the PHP and web forwarding...

 move-domain

Change the owner of a virtual server This command can be used to move a sub-server from one...

 notify-domains

Send email to some or all virtual server owners This command can be used to send a text format...

 PHP Execution Modes

Virtualmin offers a robust application deployment stack for PHP, supporting multiple PHP...

 PHP Execution Modes

Virtualmin offers a robust application deployment stack for PHP, supporting multiple PHP...

 Podman

Podman is a Virtualmin plugin for deploying and managing application containers per virtual...

 Pre and Post Domain Modification Scripts

Virtualmin allows the use of custom scripts (Shell, Perl, Python and etc.) to automate tasks...

 Pre and Post Domain Modification Scripts

Virtualmin allows the use of custom scripts (Shell, Perl, Python and etc.) to automate tasks...

 Professional Features

Virtualmin GPL is already an extremely powerful and flexible virtual hosting control panel, so...

 Remote API

Virtualmin offers both a command-line API and an HTTP-based remote API for extensive server...

 rename-domain

Change the domain name, home directory or username of a virtual server This command is typically...

 Replication and Shared Storage

In situations where a single system isn’t sufficient for hosting a website due to high traffic or...

 resend-email

Re-send the signup email for a domain This command re-sends the initial sign-up email to a...

 reset-feature

Reset some virtual server feature back to it’s default This command resets the configuration for...

 reset-pass

Resets the password for some or all users in some or all virtual servers This command can be used...

 restart-server

Restarts one of the servers managed by Virtualmin This command stops and re-starts one of the...

 restore-domain

Restore one or more virtual servers To restore a Virtualmin backup from the command line, you...

 run-all-webalizer

Run Webalizer reports for all virtual servers This is designed to be called from Cron, instead of...

 run-api-command

Executes another API command over multiple servers Some Virtualmin API commands can only run on a...

 Running Database on a Remote System

For busy web hosts looking to optimize their resources, offloading the database server to a...

 Running Database on a Remote System

For busy web hosts looking to optimize their resources, offloading the database server to a...

 search-maillogs

Searches mail server and procmail logs This is the command-line equivant of the Search Mail Logs...

 Sender Dependent Outgoing IP Address

In a standard setup, your mail server uses the system’s default IP address for SMTP connections,...

 Sender Dependent Outgoing IP Address

In a standard setup, your mail server uses the system’s default IP address for SMTP connections,...

 set-dkim

Enable or disable DKIM for all domains To enable DKIM signing of outdoing emails, run this...

 set-global-feature

Turns on or off some Virtualmin feature or plugin globally This command is the equivalent of the...

 set-php-directory

Set the version of PHP to run in some directory If more than one version of PHP is installed on...

 set-spam

Change the spam and virus scanners for all domains By default, Virtualmin uses the stand-alone...

 Setting Up Roundcube as Default Webmail

Configure Roundcube as default webmail To use Roundcube instead of Usermin: Install Roundcube:...

 Setting Up Roundcube as Default Webmail

Configure Roundcube as default webmail To use Roundcube instead of Usermin: Install Roundcube:...

 Spam and Virus Scanning

Virtualmin allows you to enable spam and virus scanning for email on a per-virtual-server basis,...

 Spam and Virus Scanning

Virtualmin allows you to enable spam and virus scanning for email on a per-virtual-server basis,...

 start-stop-script

Stops, starts or restarts the server process for some script This command can be used to start,...

 syncmx-domain

Updates allowed relay addresses in one or more domains This command can be used to bring the...

 Template Variables

This page lists many of the template variables that you can use in email messages to domain...

 transfer-domain

Move a virtual server to another system This command copies or moves a virtual server to another...

 Troubleshooting DNS

This guide addresses a common questions and issues in Virtualmin related to DNS configuration....

 Troubleshooting DNS

This guide addresses a common questions and issues in Virtualmin related to DNS configuration....

 Troubleshooting Emails

Email functionality in Virtualmin involves various components, making it a complex system. Key...

 Troubleshooting Emails

Email functionality in Virtualmin involves various components, making it a complex system. Key...

 Troubleshooting Websites

Web server configuration Troubleshooting web server issues involves checking various elements,...

 Troubleshooting Websites

Web server configuration Troubleshooting web server issues involves checking various elements,...

 unalias-domain

Convert an alias domain into a sub-server This command can be used to convert an alias server...

 Understanding Virtual Server and Account Types

Understanding the different virtual server and account types in Virtualmin is essential for...

 Understanding Virtual Server and Account Types

Understanding the different virtual server and account types in Virtualmin is essential for...

 unsub-domain

Convert a sub-domain into a sub-server This command can be used to convert a sub-domain into a...

 Uploading and Editing Website Data

Document root directory The HTML content and PHP applications for your website are typically...

 Uploading and Editing Website Data

Document root directory The HTML content and PHP applications for your website are typically...

 validate-domains

Check the configuration of virtual servers This program can be used to generate a report on...

 Website Default Page

After setting up a virtual server in Virtualmin, a default landing page is automatically...

 Website Default Page

After setting up a virtual server in Virtualmin, a default landing page is automatically...

 WP Workbench

WP Workbench is a specially crafted Virtualmin plugin that simplifies WordPress management. It...