Knowledgebase

 Auto User Switch in Shell Navigation

Overview This feature is designed for environments where the root user navigates through...

 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-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...

 Cloud Storage Providers

Virtualmin supports various cloud storage providers for backing up your virtual servers. Here’s...

 Command Line API

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

 Configuring Nginx as Default Webserver

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

 Contributing Translations

About translation files A complete list of supported languages and language codes can be found in...

 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-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-reseller

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

 create-rs-container

Creates a new empty Rackspace container This command creates a new container (directory) on...

 create-simple-alias

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

 create-user

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

 delete-domain

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

 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-rs-container

Deletes an existing Rackspace container This command deletes a container (directory) from...

 delete-rs-file

Deletes a single file from a Rackspace container This command deletes a file from Rackspace’s...

 delete-user

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

 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...

 download-rs-file

Downloads a single file from a Rackspace container This command downloads a file to your...

 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...

 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....

 generate-cert

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

 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 Backup and Restore Virtual Servers

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

 How to Change Theme

This guide will take you through the steps to change the interface theme in Virtualmin. Setting a...

 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 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 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 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 FTP Account

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

 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 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 Password Protect a Directory

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

 How to Setup Cron Jobs

This tutorial provides a straightforward method for setting up a cron job in Virtualmin. Cron is...

 How to Setup Email Forwarding

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

 How to Use File Manager

This tutorial guides you through the use of the web-based HTML file manager within Virtualmin,...

 How to Use System Statistics

This tutorial provides guidance on utilizing the System Statistics feature in Virtualmin Pro,...

 How to Use Upload and Download Module

This tutorial walks you through using the Upload and Download module, which is a convenient tool...

 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...

 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-certs

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

 list-domains

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

 list-mailbox

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

 list-php-ini

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

 list-protected-users

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

 list-resellers

List existing resellers When run with no parameters, this program simply displays a...

 list-rs-containers

Lists all containers owned by a Rackspace account This command queries Rackspace’s cloud files...

 list-rs-files

Lists all files in a container owned by a Rackspace account This command queries Rackspace’s...

 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-simple-aliases

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

 list-users

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

 Low Memory

A default installation of Virtualmin is optimized for performance rather than minimal memory...

 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-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-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-resources

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

 modify-scheduled-backup

Change some attributes of a scheduled backup This command can be used to change some attributes...

 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...

 OS Support

Virtualmin runs on top of Webmin. Webmin works on almost every UNIX-like OS, so with some manual...

 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...

 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...

 restore-domain

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

 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...

 search-maillogs

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

 set-global-feature

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

 set-mysql-pass

Change the root MySQL password, even if the current password is unknown This command can be used...

 Setting Up Roundcube as Default Webmail

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

 setup-repos

Setup Virtualmin repositories This command sets up or repairs Virtualmin software repositories....

 Spam and Virus Scanning

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

 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...

 test-imap

Checks if IMAP login to some server works This is a tool for testing IMAP servers. It takes...

 test-pop3

Checks if POP3 login to some server works This is a tool for testing POP3 servers. It takes...

 test-smtp

Checks if the mail server can RCPT to some address This command is debugging tool for mailboxes...

 transfer-domain

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

 Troubleshooting Databases

Handling memory issues and preventing crashes This troubleshoot aims to provide practical steps...

 Troubleshooting Emails

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

 Troubleshooting Installation

Most installation problems are related to having third party repositories enabled, attempting to...

 Troubleshooting Repositories

Having your Virtualmin repositories configured correctly is essential to receive the latest...

 Troubleshooting Websites

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

 Understanding Virtual Server and Account Types

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

 upload-rs-file

Uploads a single file to a Rackspace container This command uploads a file from your Virtualmin...

 Uploading and Editing Website Data

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

 WP Workbench

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