| Server IP : 167.99.254.82 / Your IP : 216.73.216.188 Web Server : Apache System : Linux host.techisquad.com 5.15.0-190-generic #200-Ubuntu SMP Fri Aug 7 15:06:04 UTC 2026 x86_64 User : pawluxera ( 1011) PHP Version : 8.1.34 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : ON Directory : /usr/share/webmin/virtual-server/ |
Upload File : |
#!/usr/bin/perl
=head1 create-domain.pl
Create a virtual server
This program can be used to create a new top-level, child or alias virtual
server. It is typically called with parameters something like :
virtualmin create-domain \
--domain foo.com --pass smeg --desc "The server for foo" \
--unix --dir --webmin --web --dns --mail --limits-from-plan
This would create a server called foo.com , with the Unix login, home directory,
Webmin login, website, DNS domain and email features enabled, and disk quotas
based on those set in the default plan. If you run this program with the --help
option, you can see all of the other command-line options that it supports. The
most commonly used are those for enabling features for the new server, such as
--mysql and --logrotate.
To create a virtual server with a private IP address, you can use the --ip
option to specify it explicitly. If your Virtualmin is configured to
automatically allocate IP addresses, use the --allocate-ip option instead, to
have a free address chosen from the allocation ranges. If you want to
use a virtual IP that is already active on the system, you must add the
--ip-already command-line option. Or to create a domain with no IPv4 address
at all, use the C<--no-ip> flag - however, this only works if an IPv6 address
is enabled instead.
If your system supports IPv6, Virtualmin can also add a IPv6 address for a
new virtual server with the C<--ip6> flag followed by an address in the correct
format. If you have IPv6 allocation enabled in the server templates, instead
use the C<--allocate-ip6> flag to have Virtualmin select a free address
automatically.
To create a server that is owned by an existing user, use the --parent option,
followed by the name of the virtual server to create under. In this case,
the --pass , --unix , --webmin and --quota options are not needed, as a
user for the new server already exists.
To create an alias of an existing virtual server, use the --alias option,
followed by the domain name of the target server. For alias servers, the
--pass , --unix , --webmin , --dir and --quota options are not needed.
A variation is the --alias-with-mail option, which creates an alias virtual
server that can still have mailboxes and email aliases. Or you can use
C<--alias-with-dns> to create an alias that has it's own independently editable
DNS records.
By default, alias domains serve the same content as their target domain,
but under a different URL. You can instead have the alias redirect clients
to the target URL with the C<--alias-redirect> flag. Or turn this off if
it's enabled by default in the template with C<--no-alias-redirect>.
To create a sub-domain, use the C<--subdom> flag followed by the parent
domain, which the domain being created must be under. The optional
C<--subprefix> flag can be used to set the directory under public_html
of the parent domain for the sub-domains's HTML files.
To create a website's initial page, use the C<--content> parameter, followed by
the path to a file containing the HTML content or the content itself. If no
content is provided, a Virtualmin default website page will be created.
You can specify limits on the number of aliases, sub-servers, mailboxes and
databases for the new domain owner using the --max-aliases, --max-doms,
--max-mailboxes and --max-dbs options. Alternately, you can choose to have
all limits (including quotas) set based on the plan using the
--limits-from-plan command line flag.
If the virtual server has the MySQL or PostgreSQL features enabled, by default
the password for the server's accounts will be the same as its administration
login. However, you can specify a different password with the --mysql-pass or
--postgres-pass flags, each of which are followed by the password to set for
that database type. These options are only available for top-level virtual
servers though.
If your system supports chroot jails with Jailkit, the C<--enable-jail>
flag can be used to force all commands run by the domain to execute in
a jail. Conversely, this can be turned off with the C<--disable-jail> flag.
By default, virtual server creation will be blocked if any warnings are
detected, such as an existing database or SSL certificate conflict. These can
be overridden with the C<--skip-warnings> flag.
If you have configured additional remote (or local) MySQL servers, you can
select which one this domain will use with the C<--mysql-server> flag followed
by a hostname, hostname:port or socket file. Similarly, a remote PostgreSQL
server can be selected with the C<--postgres-server> flag.
By default, the cloud DNS provider chosen in the specified template will be
used. However, you can override this with the C<--cloud-dns> flag followed by
either C<local> to host locally, C<services> to use Cloudmin services, or
the ID of one of the supported providers like C<route53> or C<google>.
Use the C<--acme> flag to request an auto-renewable SSL certificate from
the provider set in the server template, which defaults to Let's
Encrypt. To do the same but skip connectivity checks, use
C<--acme-always> flag instead.
The C<--proxy> parameter can be used to have the website proxy all requests
to another URL, which must follow C<--proxy>.
=cut
package virtual_server;
if (!$module_name) {
$main::no_acl_check++;
$ENV{'WEBMIN_CONFIG'} ||= "/etc/webmin";
$ENV{'WEBMIN_VAR'} ||= "/var/webmin";
if ($0 =~ /^(.*)\/[^\/]+$/) {
chdir($pwd = $1);
}
else {
chop($pwd = `pwd`);
}
$0 = "$pwd/create-domain.pl";
require './virtual-server-lib.pl';
$< == 0 || die "create-domain.pl must be run as root";
}
&licence_status();
@OLDARGV = @ARGV;
&set_all_text_print();
# Build args used by plugins
%plugin_args = ( );
foreach $f (&list_feature_plugins()) {
if (&plugin_defined($f, "feature_args")) {
foreach $a (&plugin_call($f, "feature_args")) {
$a->{'feature'} = $f;
$plugin_args{$a->{'name'}} = $a;
}
}
}
# Parse command-line args
$ip = "default"; # Use default IP by default
$virt = 0;
if ($config{'ip6enabled'} && &supports_ip6()) {
$ip6 = "default"; # Use default IPv6 by default
}
else {
$ip6 = undef; # No IPv6 address by default
}
$virt6 = 0;
$anylimits = 0;
$email = $config{'contact_email'};
# Remote API callers that are not the master admin may only create sub-servers
my $is_master = &master_admin();
while(@ARGV > 0) {
my $a = shift(@ARGV);
if ($a eq "--domain") {
$domain = shift(@ARGV);
}
elsif ($a eq "--desc") {
$owner = shift(@ARGV);
$owner =~ /:/ && &usage($text{'setup_eowner'});
}
elsif ($a eq "--email") {
if ($ARGV[0] !~ /^-/) {
$email = shift(@ARGV);
&extract_address_parts($email) ||
&usage("--email must be followed by a ".
"valid email address");
}
}
elsif ($a eq "--user") {
$user = lc(shift(@ARGV));
}
elsif ($a eq "--group") {
$group = lc(shift(@ARGV));
}
elsif ($a eq "--pass") {
$pass = shift(@ARGV);
}
elsif ($a eq "--passfile") {
# Prevent non-master callers from reading server-side files
$is_master ||
&usage("--passfile is only available to the master ".
"administrator");
$pass = &read_file_contents(shift(@ARGV));
$pass =~ s/\r|\n//g;
}
elsif ($a eq "--mysql-pass") {
$mysqlpass = shift(@ARGV);
}
elsif ($a eq "--postgres-pass") {
$postgrespass = shift(@ARGV);
}
elsif ($a eq "--hashpass") {
$hashpass = 1;
}
elsif ($a eq "--quota") {
$quota = shift(@ARGV);
$quota = 0 if ($quota eq "UNLIMITED");
$anylimits = 1;
}
elsif ($a eq "--uquota") {
$uquota = shift(@ARGV);
$uquota = 0 if ($uquota eq "UNLIMITED");
$anylimits = 1;
}
elsif ($a =~ /^--(\S+)$/ &&
&indexof($1, @features) >= 0) {
$config{$1} || &usage("The $a option cannot be used unless the feature is enabled in the module configuration");
$feature{$1}++;
}
elsif ($a =~ /^--(\S+)$/ &&
&indexof($1, &list_feature_plugins()) >= 0) {
$plugin{$1}++;
}
elsif ($a eq "--default-features") {
$deffeatures = 1;
}
elsif ($a eq "--features-from-template" ||
$a eq "--features-from-plan") {
$planfeatures = 1;
}
elsif ($a eq "--default-ip") {
# Use the global default IPv4 address
$ip = "default";
$virt = 0;
}
elsif ($a eq "--no-ip") {
# IPv4 explicitly turned off
$ip = undef;
$virt = 0;
}
elsif ($a eq "--ip") {
# Specific virtual IPv4 requested
$ip = shift(@ARGV);
$feature{'virt'} = 1; # for dependency checks
$virt = 1;
}
elsif ($a eq "--allocate-ip") {
# Allocate a virtual IPv4
$ip = "allocate"; # will be done later
$virt = 1;
}
elsif ($a eq "--ip-already") {
# Virtual IP is already active on the system
$virtalready = 1;
}
elsif ($a eq "--ip-primary") {
&usage("The --ip-primary flag is no longer needed, as a single SSL website can be created for each shared IP address");
}
elsif ($a eq "--shared-ip") {
$sharedip = shift(@ARGV);
$virt = 0;
}
elsif ($a eq "--parent-ip") {
$parentip = 1;
}
elsif ($a eq "--no-ip6") {
# IPv6 explicitly turned off
$ip6 = undef;
$virt6 = 0;
}
elsif ($a eq "--default-ip6" && &supports_ip6()) {
# IPv6 on default shared address
$ip6 = "default";
$ip6 || &usage("System does not have a default IPv6 address");
$virt6 = 0;
}
elsif ($a eq "--ip6" && &supports_ip6()) {
# IPv6 on specific address
$ip6 = shift(@ARGV);
$virt6 = 1;
}
elsif ($a eq "--ip6-already" && &supports_ip6()) {
# Specific IPv6 address is already active
$virt6already = 1;
}
elsif ($a eq "--allocate-ip6" && &supports_ip6()) {
# IPv6 on allocated address
$ip6 = "allocate";
$virt6 = 1;
}
elsif ($a eq "--shared-ip6") {
# IPv6 on shared address
$ip6 = $sharedip6 = shift(@ARGV);
$virt6 = 0;
&indexof($ip6, &list_shared_ip6s()) >= 0 ||
&usage("$ip6 is not in the shared IP addresses list");
}
elsif ($a eq "--dns-ip") {
$dns_ip = shift(@ARGV);
&check_ipaddress($dns_ip) ||
&usage("--dns-ip must be followed by an IP address");
}
elsif ($a eq "--no-dns-ip") {
$dns_ip = "";
}
elsif ($a eq "--dns-ip6") {
$dns_ip6 = shift(@ARGV);
&check_ip6address($dns_ip6) ||
&usage("--dns-ip6 must be followed by an IPv6 address");
}
elsif ($a eq "--no-dns-ip6") {
$dns_ip6 = "";
}
elsif ($a eq "--mailboxlimit" || $a eq "--max-mailboxes") {
$mailboxlimit = shift(@ARGV);
$anylimits = 1;
}
elsif ($a eq "--dbslimit" || $a eq "--max-dbs") {
$dbslimit = shift(@ARGV);
$anylimits = 1;
}
elsif ($a eq "--domslimit" || $a eq "--max-doms") {
$domslimit = shift(@ARGV);
$anylimits = 1;
}
elsif ($a eq "--aliaslimit" || $a eq "--max-aliases") {
$aliaslimit = shift(@ARGV);
$anylimits = 1;
}
elsif ($a eq "--aliasdomslimit" || $a eq "--max-aliasdoms") {
$aliasdomslimit = shift(@ARGV);
$anylimits = 1;
}
elsif ($a eq "--realdomslimit" || $a eq "--max-realdoms") {
$realdomslimit = shift(@ARGV);
$anylimits = 1;
}
elsif ($a eq "--template") {
# If no template given (as seen by AWBS), use the default
if ($ARGV[0] && $ARGV[0] !~ /^\-\-/) {
$templatename = shift(@ARGV);
foreach $t (&list_templates()) {
if ($t->{'name'} eq $templatename ||
$t->{'id'} eq $templatename) {
$template = $t->{'id'};
}
}
$template eq "" && &usage("Unknown template name");
}
}
elsif ($a eq "--plan") {
$is_master ||
&usage("--plan is only available to the master ".
"administrator");
$planname = shift(@ARGV);
foreach $p (&list_plans()) {
if ($p->{'id'} eq $planname ||
$p->{'name'} eq $planname) {
$planid = $p->{'id'};
}
}
$planid eq "" && &usage("Unknown plan name");
}
elsif ($a eq "--bandwidth") {
$bw = shift(@ARGV);
$anylimits = 1;
}
elsif ($a eq "--limits-from-template" ||
$a eq "--limits-from-plan") {
$tlimit = 1;
}
elsif ($a eq "--prefix" || $a eq "--suffix") {
$prefix = shift(@ARGV);
}
elsif ($a eq "--db") {
$db = shift(@ARGV);
$db =~ /^[a-z0-9\-\_]+$/i || &usage("Invalid database name");
}
elsif ($a eq "--fwdto") {
$fwdto = shift(@ARGV);
$fwdto =~ /^\S+\@\S+$/i || &usage("Invalid forwarding address");
}
elsif ($a eq "--parent") {
$parentdomain = lc(shift(@ARGV));
}
elsif ($a eq "--alias" || $a eq "--alias-with-mail" ||
$a eq "--alias-with-dns") {
$aliasdomain = $parentdomain = lc(shift(@ARGV));
if ($a eq "--alias-with-mail") {
$aliasmail = 1;
}
if ($a eq "--alias-with-dns") {
$aliasdns = 1;
}
}
elsif ($a eq "--subdom" || $a eq "--superdom") {
$subdomain = $parentdomain = lc(shift(@ARGV));
}
elsif ($a eq "--reseller") {
$is_master ||
&usage("--reseller is only available to the master ".
"administrator");
$resel = shift(@ARGV);
}
elsif ($a eq "--content") {
$content = shift(@ARGV);
}
elsif ($a eq "--no-email") {
$nocreationmail = 1;
}
elsif ($a eq "--no-slaves") {
$noslaves = 1;
}
elsif ($a eq "--no-secondaries") {
$nosecondaries = 1;
}
elsif ($a eq "--pre-command") {
$is_master ||
&usage("--pre-command is only available to the master ".
"administrator");
$precommand = shift(@ARGV);
}
elsif ($a eq "--post-command") {
$is_master ||
&usage("--post-command is only available to the master ".
"administrator");
$postcommand = shift(@ARGV);
}
elsif ($a eq "--skip-warnings") {
$skipwarnings = 1;
}
elsif ($a eq "--letsencrypt" || $a eq "--acme") {
$letsencrypt = 1;
}
elsif ($a eq "--letsencrypt-always" || $a eq "--acme-always") {
$letsencrypt = 2;
}
elsif ($a eq "--letsencrypt-never" || $a eq "--acme-never") {
$letsencrypt = 0;
}
elsif ($a eq "--enable-jail") {
$jail = 1;
}
elsif ($a eq "--disable-jail") {
$jail = 0;
}
elsif ($a eq "--mysql-server") {
$myserver = shift(@ARGV);
}
elsif ($a eq "--postgres-server") {
$pgserver = shift(@ARGV);
}
elsif ($a eq "--cloud-dns") {
$clouddns = shift(@ARGV);
}
elsif ($a eq "--cloud-dns-import") {
$clouddns_import = 1;
}
elsif ($a eq "--remote-dns") {
$remotedns = shift(@ARGV);
}
elsif ($a eq "--separate-dns-subdomain") {
$dns_submode = 0;
}
elsif ($a eq "--any-dns-subdomain") {
$dns_subany = 1;
}
elsif ($a eq "--break-ssl-cert") {
$linkcert = 0;
}
elsif ($a eq "--link-ssl-cert") {
$linkcert = 1;
}
elsif ($a eq "--always-link-ssl-cert") {
$linkcert = 2;
}
elsif ($a eq "--generate-ssl-cert") {
$always_ssl = 1;
}
elsif ($a eq "--generate-ssh-key") {
$sshmode = 1;
}
elsif ($a eq "--use-ssh-key") {
$sshmode = 2;
$sshkey = shift(@ARGV);
if ($sshkey =~ /^\//) {
# Only the master administrator can load a key from a
# server-side file
$is_master ||
&usage("--use-ssh-key must be followed by key ".
"data rather than a file");
$sshkey = &read_file_contents($sshkey);
}
$sshkey =~ /\S/ || &usage("--use-ssh-key must be followed by a key file or data");
}
elsif ($a eq "--ssl-redirect") {
$auto_redirect = 1;
}
elsif ($a eq "--no-ssl-redirect") {
$auto_redirect = 0;
}
elsif ($a eq "--append-style") {
$append_style = shift(@ARGV);
my ($as) = grep { $_->[0] eq $append_style ||
$_->[1] eq $append_style }
&list_append_styles();
$as || &usage("Append style $append_style does not exists");
$append_style = $as->[0];
}
elsif ($a eq "--mode") {
$phpmode = shift(@ARGV);
}
elsif ($a eq "--multiline") {
$multiline = 1;
}
elsif ($a eq "--shell") {
$defaultshell = shift(@ARGV);
}
elsif ($a eq "--subprefix") {
$subprefix = shift(@ARGV);
}
elsif ($a eq "--proxy") {
$proxy_pass_mode = 1;
$proxy_pass = shift(@ARGV);
}
elsif ($a eq "--alias-redirect") {
$aliasredir = 1;
}
elsif ($a eq "--no-alias-redirect") {
$aliasredir = 0;
}
elsif ($a eq "--default-cert-owner") {
$default_cert_owner = 1;
}
elsif ($a =~ /^\-\-(.*)$/ && $plugin_args{$1}) {
# Plugin-specific arg
if ($plugin_args{$1}->{'novalue'}) {
$plugin_values{$1} = "";
}
else {
$plugin_values{$1} = shift(@ARGV);
}
}
elsif ($a =~ /^\-\-field\-(\S+)$/) {
# Custom field
$fn = $1;
$fv = shift(@ARGV);
@fields = &list_custom_fields();
($f) = grep { $_->{'name'} eq $fn } @fields;
$f || &usage("Custom field $fn does not exist");
$is_master || $f->{'visible'} == 0 ||
&usage("Custom field $fn cannot be edited by domain owners");
$fields{'field_'.$fn} = $fv;
}
elsif ($a eq "--help") {
&usage();
}
else {
&usage("Unknown parameter $a");
}
}
# Enforce option-specific permissions before looking up global configuration
if (!$is_master) {
defined($jail) &&
&usage("--enable-jail and --disable-jail are only available to ".
"the master administrator");
($myserver || $pgserver) &&
&usage("--mysql-server and --postgres-server are only available ".
"to the master administrator");
($noslaves || $nosecondaries || defined($dns_submode) || $dns_subany) &&
&usage("DNS server placement options are only available to the ".
"master administrator");
(defined($dns_ip) || defined($dns_ip6)) && !&can_dnsip() &&
&usage("You are not allowed to change the DNS IP address");
defined($db) && !&can_edit_databases() &&
&usage("You are not allowed to select the initial database name");
$fwdto && !&can_edit_catchall() &&
&usage("You are not allowed to configure catch-all forwarding");
defined($content) && !&can_edit_html() &&
&usage("You are not allowed to set website content");
($clouddns || $clouddns_import || defined($remotedns)) &&
!&can_edit_dns() &&
&usage("You are not allowed to select the DNS server");
defined($letsencrypt) &&
(!&can_edit_ssl() || !&can_edit_letsencrypt()) &&
&usage("You are not allowed to request an SSL certificate");
(defined($linkcert) || defined($always_ssl) || $default_cert_owner) &&
!&can_edit_ssl() &&
&usage("You are not allowed to configure SSL certificates");
($sshmode || defined($append_style) || defined($defaultshell)) &&
!&can_edit_users() &&
&usage("You are not allowed to configure domain users");
defined($phpmode) && !&can_edit_phpmode() &&
&usage("You are not allowed to select the PHP execution mode");
$proxy_pass_mode && !&can_edit_forward() &&
&usage("You are not allowed to configure proxying");
$proxy_pass_mode && $proxy_pass !~ /^(http|https):\/\/\S+$/ &&
&usage("Proxy URLs must start with http:// or https://");
(defined($auto_redirect) || defined($aliasredir)) &&
!&can_edit_redirect() &&
&usage("You are not allowed to configure redirects");
}
# Non-master callers may only ever create a sub-server, so bail out early
# before any settings that only apply to top-level servers are looked up
if (!$is_master) {
$parentdomain || &usage("Only sub-servers can be created, so the ".
"--parent, --alias or --subdom flag must ".
"be given");
}
if ($template eq "") {
$template = &get_init_template($parentdomain);
}
$tmpl = &get_template($template);
$is_master || &can_use_template($tmpl) || &usage($text{'setup_etmpl'});
$plan = $planid ne '' ? &get_plan($planid) : &get_default_plan();
# Sub-servers always inherit the plan from their parent, and domain owners
# have no plans of their own to default to
$plan || $parentdomain || &usage("Plan does not exist");
$defip = &get_default_ip($resel);
$defip6 = &get_default_ip6($resel);
if ($sharedip) {
if ($sharedip eq $defip) {
$sharedip = undef;
}
else {
&indexof($sharedip, &list_shared_ips()) >= 0 ||
&usage("$sharedip is not in the shared IP addresses list");
}
}
$clouddns && $remotedns &&
&usage("--cloud-dns and --remote-dns are mutually exclusive");
if ($ip eq "allocate") {
# Allocate IPv4 now
$virtalready && &usage("The --ip-already and --allocate-ip options are incompatible");
%racl = $resel ? &get_reseller_acl($resel) : ();
if ($racl{'ranges'}) {
# Allocating from reseller's range
($ip, $netmask) = &free_ip_address(\%racl);
$ip || &usage("Failed to allocate IP address from reseller's ranges!");
}
else {
# Allocating from template
$tmpl->{'ranges'} ne "none" || &usage("The --allocate-ip option cannot be used unless automatic IP allocation is configured in templates - use --ip instead");
($ip, $netmask) = &free_ip_address($tmpl);
$ip || &usage("Failed to allocate IP address from ranges!");
}
}
elsif ($virt) {
# Make sure manual IPv4 specification is allowed
$tmpl->{'ranges'} eq "none" || &usage("The --ip option cannot be used when automatic IP allocation is configured in templates - use --allocate-ip instead");
}
elsif ($ip eq "default" && !$aliasdomain && !$parentip) {
# Alias and parent IPv4 addresses are resolved below
$ip = $defip;
$ip || &usage("No default IP address found");
$virt = 0;
}
if ($ip6 eq "allocate") {
# Allocate an IPv6 address now
$virt6already && &usage("The --ip6-already and --allocate-ip6 options are incompatible");
%racl = $resel ? &get_reseller_acl($resel) : ();
if ($racl{'ranges6'}) {
# Allocating from reseller's range
($ip6, $netmask6) = &free_ip6_address(\%racl);
$ip6 || &usage("Failed to allocate IPv6 address from reseller's ranges!");
}
else {
# Allocating from template
$tmpl->{'ranges6'} ne "none" || &usage("The --allocate-ip6 option cannot be used unless automatic IPv6 allocation is enabled - use --ip6 instead");
($ip6, $netmask6) = &free_ip6_address($tmpl);
$ip6 || &usage("Failed to allocate IPv6 address from ranges!");
}
}
elsif ($virt6) {
# Make sure manual IPv6 specification is allowed
$tmpl->{'ranges6'} eq "none" || &usage("The --ip6 option cannot be used when automatic IPv6 address allocation is enabled - use --allocate-ip6 instead");
}
elsif ($ip6 eq "default") {
# Use default IPv6, which may depend on reseller
$ip6 = $defip6;
$virt6 = 0;
}
if (!defined($ip) && !defined($ip6)) {
# Make sure we have some kind of address
&usage("--no-ip cannot be used if there is no IPv6 enabled");
}
$dns_ip && !$ip && &usage("--dns-ip cannot be used without an IP address");
$dns_ip6 && !$ip6 && &usage("--dns-ip6 cannot be used without an IPv6 address");
# If no limit-related flags are given, assume from plan
if (!$tlimit && !$anylimits) {
$tlimit = 1;
}
# Make sure all needed args are set
$domain || &usage("Missing domain name");
$parentdomain || $pass || &usage("Missing password");
if (!defined($jail) && !$parentdomain) {
$jail = $tmpl->{'ujail'};
}
if ($jail && $parentdomain) {
&usage("--enable-jail can only be used for top-level virtual servers");
}
if (&has_home_quotas() && !$parentdomain) {
$quota ne '' && $uquota ne '' || $tlimit || &usage("No quota specified");
}
if ($parentdomain) {
$feature{'unix'} && &usage("--unix option makes no sense for sub-servers");
}
if ($aliasdomain) {
@af = $aliasmail ? @aliasmail_features : @alias_features;
foreach $f (keys %feature) {
&indexof($f, @af) >= 0 ||
&usage("--$f option makes no sense for alias servers");
}
}
if ($subdomain) {
foreach $f (keys %feature) {
&indexof($f, @opt_subdom_features) >= 0 ||
&usage("--$f option makes no sense for sub-domains");
}
}
# Validate args and work out defaults for those unset
$domain = lc(&parse_domain_name($domain));
if (!$skipwarnings || !$is_master) {
$err = &valid_domain_name($domain);
&usage($err) if ($err);
}
&lock_domain_name($domain);
my $clashed = &domain_name_clash($domain);
&usage($clashed->{'defaulthostdomain'} ?
&text('setup_edomain5', $clashed->{'dom'}) :
$text{'setup_edomain4'})
if ($clashed);
if ($parentdomain) {
$parent = &get_domain_by("dom", $parentdomain);
$parent || &usage("Parent domain does not exist");
$plan = &get_plan($parent->{'plan'}); # Parent overrides any selection
$alias = $parent if ($aliasdomain);
$subdom = $parent if ($subdomain);
if ($parent->{'parent'}) {
# Parent is not actually the top, such as when creating an alias
$parent = &get_domain($parent->{'parent'});
$parent || &usage("No top level parent domain found!");
}
if ($subdomain) {
$domain =~ /^(\S+)\.\Q$subdomain\E$/ ||
&usage("Sub-domain $domain must be under the parent domain $subdomain");
$subprefix ||= $1;
}
}
# Enforce the same restrictions as the user interface for non-master callers,
# who may only ever create a sub-server under a domain that they own
if (!$is_master) {
&can_create_sub_servers() ||
&usage("You are not allowed to create sub-servers");
&can_edit_domain($parent) ||
&usage(&text('remote_ecannotdom', $parentdomain));
# Check the sub-server limit that applies to this parent
my ($dleft, $dreason, $dmax) = &count_domains(
$aliasdomain ? "aliasdoms" : "realdoms");
$dleft == 0 && &usage("You have reached the maximum of $dmax ".
"virtual servers that can be created");
# Check any restriction on the names he can use
my $derr = &allowed_domain_name($parent, $domain);
&usage($derr) if ($derr);
# Only users allowed to select an address may request one
($virt || $sharedip) && !&can_select_ip() &&
&usage($text{'setup_eip'});
($virt6 || $sharedip6) && !&can_select_ip6() &&
&usage($text{'setup_eip6'});
}
# Allow user and group names
if (!$parent) {
if (!$user) {
# Select user automatically
($user, $try1, $try2) = &unixuser_name($domain);
$user || &usage(&text('setup_eauto', $try1, $try2));
}
else {
# Use specified username, and also group
&valid_mailbox_name($user) && &usage($text{'setup_euser2'});
defined(getpwnam($user)) && &usage($text{'setup_euser'});
$group ||= $user;
}
if (!$group) {
# Select group automatically
($group, $gtry1, $gtry2) = &unixgroup_name($domain, $user);
$group || &usage(&text('setup_eauto2', $gtry1, $gtry2));
}
else {
# Use specified group name
&valid_mailbox_name($group) && &usage($text{'setup_egroup2'});
defined(getgrnam($group)) &&
&usage(&text('setup_egroup', $group));
}
}
$owner ||= $domain;
# Work out features, if using automatic mode.
# If the user asked for features from the plan but it doesn't define any,
# fall back to the global defaults.
$tfl = $plan->{'featurelimits'};
if ($planfeatures && $tfl) {
# From limits on selected plan
$tfl eq 'none' && &usage("Selected plan has no features enabled");
%flimits = map { $_, 1 } split(/\s+/, $tfl);
%feature = ( 'virt' => $feature{'virt'} );
%plugin = ( );
foreach my $f (&list_available_features($parent, $alias, $subdom)) {
if ($flimits{$f->{'feature'}} && $f->{'enabled'}) {
if ($f->{'plugin'}) {
$plugin{$f->{'feature'}} = 1;
}
else {
$feature{$f->{'feature'}} = 1;
}
}
}
}
elsif ($deffeatures || $planfeatures && !$tfl) {
# From global configured defaults
%feature = ( 'virt' => $feature{'virt'} );
%plugin = ( );
foreach my $f (&list_available_features($parent, $alias, $subdom)) {
if ($f->{'default'} && $f->{'enabled'}) {
if ($f->{'plugin'}) {
$plugin{$f->{'feature'}} = 1;
}
else {
$feature{$f->{'feature'}} = 1;
}
}
}
}
scalar(keys %feature) || &usage("No virtual server features enabled");
# Only features the owner has been granted can be enabled. This runs after the
# set is final, as it may be rebuilt above from a template or plan.
if (!$is_master) {
foreach my $f (grep { $feature{$_} } keys %feature,
grep { $plugin{$_} } keys %plugin) {
&can_use_feature($f) ||
&usage("You are not allowed to enable the $f feature");
}
}
if (!$parent) {
# Make sure alias, database, etc limits are set properly
!defined($mailboxlimit) || $mailboxlimit =~ /^[1-9]\d*$/ ||
&usage($text{'setup_emailboxlimit'});
!defined($dbslimit) || $dbslimit =~ /^[1-9]\d*$/ ||
&usage($text{'setup_edbslimit'});
!defined($aliaslimit) || $aliaslimit =~ /^[1-9]\d*$/ ||
&usage($text{'setup_ealiaslimit'});
!defined($domslimit) || $domslimit eq "*" ||
$domslimit =~ /^[1-9]\d*$/ ||
&usage($text{'setup_edomslimit'});
!defined($aliasdomslimit) || $aliasdomslimit =~ /^[1-9]\d*$/ ||
&usage($text{'setup_ealiasdomslimit'});
!defined($realdomslimit) || $realdomslimit =~ /^[1-9]\d*$/ ||
&usage($text{'setup_erealdomslimit'});
}
if (!$parent) {
# Validate username
&require_useradmin();
$uerr = &useradmin::check_username_restrictions($user);
if ($uerr) {
&usage(&text('setup_eusername', $user, $uerr));
}
$user =~ /^[^\t :]+$/ || &usage($text{'setup_euser2'});
&indexof($user, @banned_usernames) < 0 ||
&usage(&text('setup_eroot', 'root'));
}
# Validate quotas
if (&has_home_quotas() && !$parent && !$tlimit) {
$quota =~ /^\d+$/ || &usage($text{'setup_equota'});
$uquota =~ /^\d+$/ || &usage($text{'setup_euquota'});
}
# Validate reseller
if (defined($resel)) {
# Set on the command line
$parent && &usage("Reseller cannot be set for sub-servers");
@resels = &list_resellers();
($rinfo) = grep { $_->{'name'} eq $resel } @resels;
$rinfo || &usage("Reseller $resel not found");
}
elsif ($parent) {
$resel = $parent->{'reseller'};
}
if (!$alias) {
if ($virt) {
# Validate virtual IP address
&check_ipaddress($ip) || &usage($text{'setup_eip'});
$clash = &check_virt_clash($ip);
if ($virtalready) {
# Make sure IP is already active
$clash || &usage(&text('setup_evirtclash2'));
if ($virtalready == 1) {
# Don't allow clash with another domain
my $already = &get_domain_by("ip", $ip);
$already && &usage(&text('setup_evirtclash4',
$already->{'dom'}));
}
else {
# The system's PRIMARY ip is being used by
# this domain, so we can host a single SSL
# virtual host on it.
}
}
else {
# Make sure the IP isn't assigned yet
$clash && &usage(&text('setup_evirtclash'));
}
}
elsif ($parentip) {
# IP comes from parent domain
$parent || &usage("The --parent-ip flag cannot be used for ".
"top-level servers");
$ip = $parent->{'ip'};
$ip6 = $parent->{'ip6'} if (!$virt6);
}
if ($virt6) {
# Validate virtual IPv6 address
&check_ip6address($ip6) || &usage($text{'setup_eip6'});
$clash = &check_virt6_clash($ip6);
if ($virt6already) {
# Make sure it is already active
$clash || &usage(&text('setup_evirt6clash2'));
}
else {
# Make sure the IP isn't assigned yet
$clash && &usage(&text('setup_evirt6clash', $ip6));
}
}
}
else {
# IP comes from alias target
$ip = $alias->{'ip'};
$ip6 = $alias->{'ip6'};
}
if ($parent) {
# User and group IDs come from parent
$gid = $parent->{'gid'};
$ugid = $parent->{'ugid'};
$user = $parent->{'user'};
$group = $parent->{'group'};
$uid = $parent->{'uid'};
}
else {
# IDs are allocated later
$uid = $ugid = $gid = undef;
}
# Get remote MySQL or PostgreSQL server
if ($myserver) {
my $mm = &get_remote_mysql_module($myserver);
$mm || &usage("No remote MySQL server named $myserver was found");
$mm->{'config'}->{'virtualmin_provision'} &&
&usage("Remote MySQL server $myserver is for use only by ".
"Cloudmin Services provisioned domains");
$mysql_module = $mm->{'minfo'}->{'dir'};
}
if ($pgserver) {
my $mm = &get_remote_postgres_module($pgserver);
$mm || &usage("No remote PostgreSQL server named $pgserver was found");
$postgres_module = $mm->{'minfo'}->{'dir'};
}
# Validate the cloud DNS provider
if ($clouddns) {
if ($clouddns eq "services") {
$config{'provision_dns'} ||
&usage("Cloudmin Services for DNS is not enabled");
}
elsif ($clouddns ne "local") {
my @clouds = &list_dns_clouds();
my @cnames = map { $_->{'name'} } @clouds;
&indexof($clouddns, @cnames) >= 0 ||
&usage("Valid cloud DNS providers are : ".
join(" ", @cnames));
my ($cloud) = grep { $_->{'name'} eq $clouddns } @clouds;
$is_master || &can_dns_cloud($cloud) ||
&usage("You are not allowed to use DNS provider $clouddns");
}
}
# Validate the remote DNS server
if ($remotedns) {
defined(&list_remote_dns) ||
&usage("Remote DNS servers are not supported");
($r) = grep { $_->{'host'} eq $remotedns } &list_remote_dns();
$r || &usage("Remote DNS server $remotedns not found");
$r->{'slave'} && &usage("Remote DNS server $remotedns is not a master");
}
# Validate PHP mode
if ($phpmode) {
my @supp = &supported_php_modes();
&indexof($phpmode, @supp) >= 0 ||
&usage("The selected PHP execution mode cannot be used");
}
# Work out prefix if needed, and check it
$prefix ||= &compute_prefix($domain, $group, $parent, 1);
$prefix =~ /^[a-z0-9\.\-]+$/i || &usage($text{'setup_eprefix'});
$pclash = &get_domain_by("prefix", $prefix);
$pclash && &usage(&text('setup_eprefix3', $prefix, $pclash->{'dom'}));
# Build up domain object
%dom = ( 'id', &domain_id(),
'dom', $domain,
'user', $user,
'group', $group,
'ugroup', $group,
'uid', $uid,
'gid', $gid,
'ugid', $gid,
'owner', $owner,
'email', $parent ? $parent->{'email'} : $email,
'ip', $virt ? $ip :
$alias ? $ip :
$parentip ? $parent->{'ip'} :
$sharedip ? $sharedip :
!defined($ip) ? undef : $defip,
'netmask', $netmask,
'dns_ip', !$ip ? undef :
defined($dns_ip) ? $dns_ip :
$alias ? $alias->{'dns_ip'} :
$virt ? undef : &get_dns_ip($resel, 4),
'dns_ip6', !$ip6 ? undef :
defined($dns_ip6) ? $dns_ip6 :
$alias ? $alias->{'dns_ip6'} :
$virt6 ? undef : &get_dns_ip($resel, 6),
'virt', $virt,
'virtalready', $virtalready,
'ip6', $parentip ? $parent->{'ip6'} : $ip6,
'netmask6', $netmask6,
'virt6', $virt6,
'virt6already', $virt6already,
$parent ? ( 'pass', $parent->{'pass'} )
: ( 'pass', $pass,
'quota', $quota,
'uquota', $uquota ),
'alias', $alias ? $alias->{'id'} : undef,
'aliasmail', $aliasmail,
'aliasdns', $aliasdns,
'subdom', $subdom ? $subdom->{'id'} : undef,
'source', 'create-domain.pl',
'template', $template,
'plan', $plan->{'id'},
'parent', $parent ? $parent->{'id'} : "",
$parent ? ( )
: ( 'mailboxlimit', $mailboxlimit,
'dbslimit', $dbslimit,
'aliaslimit', $aliaslimit,
'domslimit', $domslimit,
'aliasdomslimit', $aliasdomslimit,
'realdomslimit', $realdomslimit,
'bw_limit', $bw eq 'NONE' ? undef : $bw ),
'prefix', $prefix,
'reseller', $resel,
'nocreationmail', $nocreationmail,
'noslaves', $noslaves,
'nosecondaries', $nosecondaries,
'default_cert_owner', $default_cert_owner,
'subprefix', $subprefix,
'hashpass', $hashpass,
'auto_letsencrypt', $letsencrypt,
'jail', $jail,
'mysql_module', $mysql_module,
'postgres_module', $postgres_module,
'default_php_mode', $phpmode,
'dns_cloud', $clouddns,
'dns_cloud_import', $clouddns_import,
'dns_remote', $remotedns,
'proxy_pass_mode', $proxy_pass_mode,
'proxy_pass', $proxy_pass,
'aliasredir', $aliasredir,
);
$dom{'dns_submode'} = $dns_submode if (defined($dns_submode));
$dom{'dns_subany'} = $dns_subany if (defined($dns_subany));
$dom{'nolink_certs'} = 1 if ($linkcert eq '0');
$dom{'link_certs'} = $linkcert if ($linkcert == 1 || $linkcert == 2);
$dom{'always_ssl'} = $always_ssl if (defined($always_ssl));
$dom{'append_style'} = $append_style if (defined($append_style));
$dom{'defaultshell'} = $defaultshell if (defined($defaultshell));
foreach $f (keys %fields) {
$dom{$f} = $fields{$f};
}
if (!$parent) {
if ($tlimit) {
&set_limits_from_plan(\%dom, $plan);
}
&set_capabilities_from_plan(\%dom, $plan);
}
$dom{'emailto'} = $parent ? $parent->{'emailto'} :
$dom{'email'} ? $dom{'email'} :
$dom{'user'} =~ /\@/ ? $dom{'user'} :
$dom{'mail'} ? $dom{'user'}.'@'.$dom{'dom'} :
$dom{'user'}.'@'.&get_system_hostname();
foreach $f (@features) {
$dom{$f} = $feature{$f} ? 1 : 0;
}
foreach $f (&list_feature_plugins()) {
$dom{$f} = $plugin{$f} ? 1 : 0;
}
$dom{'db'} = $db || &database_name(\%dom);
&set_featurelimits_from_plan(\%dom, $plan);
&set_chained_features(\%dom, undef);
&set_provision_features(\%dom);
&generate_domain_password_hashes(\%dom, 1);
# Check SSL redirect flag
if ($auto_redirect) {
&domain_has_ssl(\%dom) || &usage("The --ssl-redirect flag cannot be ".
"used unless SSL is enabled");
$dom{'auto_redirect'} = 1;
}
# Work out home directory
$dom{'home'} = &server_home_directory(\%dom, $parent);
if (defined($mysqlpass) && $config{'mysql'}) {
$dom{'parent'} && &usage("The --mysql-pass flag can only be used for top-level virtual servers");
&set_mysql_pass(\%dom, $mysqlpass);
}
if (defined($postgrespass) && $config{'postgres'}) {
$dom{'parent'} && &usage("The --postgres-pass flag can only be used for top-level virtual servers");
&set_postgres_pass(\%dom, $postgrespass);
}
&complete_domain(\%dom);
# Set plugin-defined command line args
foreach $f (&list_feature_plugins()) {
if ($dom{$f}) {
$err = &plugin_call($f, "feature_args_parse",
\%dom, \%plugin_values);
&usage($err) if ($err);
}
}
# Check for various clashes
$derr = &virtual_server_depends(\%dom);
&usage($derr) if ($derr);
$cerr = &virtual_server_clashes(\%dom);
&usage($cerr) if ($cerr);
# Check if features are not forbidden
if (!$skipwarnings || !$is_master) {
foreach my $ff (&forbidden_domain_features(\%dom, 1)) {
if ($dom{$ff}) {
my $msg = &text('setup_efeatforbidhostdef', $ff);
$msg .= " unless the --skip-warnings flag is given"
if ($is_master);
&usage($msg);
}
}
}
# Check for warnings, unless overriding
@warns = &virtual_server_warnings(\%dom);
if (@warns) {
print "The following possible problems were detected :\n\n";
foreach $w (@warns) {
print " ",&html_tags_to_text($w),"\n";
}
if (!$skipwarnings) {
print "\n";
print "The virtual server will not be created unless the --skip-warnings flag is given.\n";
exit(5);
}
else {
print "\n";
print "Warnings have been bypassed with the --skip-warnings flag\n";
}
}
# Check if over quota
if ($parent) {
my $err = &check_domain_over_quota($parent);
if ($err) {
print &text('setup_overquota', $err),"\n";
exit(6);
}
}
# Content can come from template
if (!defined($content)) {
my $content_web_tmpl = $tmpl->{'content_web'};
my $content_web_tmpl_html_file = $tmpl->{'content_web_html'};
# Default HTML page
if ($content_web_tmpl == 2) {
$content = "";
}
# Want to set content to the given from file
elsif (!$content_web_tmpl && $virtualmin_pro &&
-r $content_web_tmpl_html_file) {
$content = &read_file_contents($content_web_tmpl_html_file);
}
}
# Do it
print "Beginning server creation ..\n\n";
&lock_domain(\%dom);
$config{'pre_command'} = $precommand if ($precommand);
$config{'post_command'} = $postcommand if ($postcommand);
$err = &create_virtual_server(\%dom, $parent,
$parent ? $parent->{'user'} : undef,
0, 1, $parent ? undef : $pass, $content);
&unlock_domain(\%dom);
if ($err) {
print "$err\n";
exit(1);
}
if ($fwdto) {
&$first_print(&text('setup_fwding', $fwdto));
&create_domain_forward(\%dom, $fwdto);
&$second_print($text{'setup_done'});
}
if ($sshmode == 1) {
# Generate and use a key
&$first_print($text{'setup_sshkey1'});
($sshkey, $err) = &create_domain_ssh_key(\%dom);
if (!$err) {
$err = &save_domain_ssh_pubkey(\%dom, $sshkey);
}
if ($err) {
&$second_print(&text('setup_esshkey', $err));
}
else {
&$second_print($text{'setup_done'});
}
}
elsif ($sshmode == 2) {
# Just use an existing key
&$first_print($text{'setup_sshkey2'});
$sshkey =~ s/\r|\n/ /g;
$err = &save_domain_ssh_pubkey(\%dom, $sshkey);
if ($err) {
&$second_print(&text('setup_esshkey', $err));
}
else {
&$second_print($text{'setup_done'});
}
}
&run_post_actions();
&virtualmin_api_log(\@OLDARGV, \%dom, $dom{'hashpass'} ? [ "pass" ] : [ ]);
&unlock_domain_name($domain);
print "All done!\n";
sub usage
{
print $_[0],"\n\n" if ($_[0]);
print "Adds a new Virtualmin virtual server, with the settings and features\n";
print "specified on the command line.\n";
print "\n";
print "virtualmin create-domain --domain domain.name\n";
print " --pass \"password-for-new-domain\" |\n";
print " --passfile password-file\n";
print " [--hashpass]\n";
print " [--parent domain.name | --alias domain.name |\n";
print " --alias-with-mail domain.name |\n";
print " --alias-with-dns domain.name |\n";
print " --superdom domain.name]\n";
print " [--desc description-for-domain]\n";
print " [--email contact-email]\n";
print " [--user new-unix-user]\n";
print " [--group new-unix-group]\n";
foreach $f (@features) {
print " [--$f]\n" if ($config{$f});
}
foreach $f (&list_feature_plugins()) {
print " [--$f]\n";
}
print " [--default-features] | [--features-from-plan]\n";
print " [--default-ip |\n";
print " --no-ip |\n";
print " --shared-ip existing.ip.address |\n";
print " --allocate-ip |\n";
print " --ip virtual.ip.address]\n";
print " [--ip-already]\n";
if (&supports_ip6()) {
print " [--default-ip6 |\n";
print " --no-ip6 |\n";
print " --shared-ip6 existing.ip.address |\n";
print " --allocate-ip6 |\n";
print " --ip6 virtual.ip.address]\n";
print " [--ip6-already]\n";
}
print " [--dns-ip address | --no-dns-ip]\n";
print " [--dns-ip6 address | --no-dns-ip6]\n";
print " [--max-doms domains|*]\n";
print " [--max-aliasdoms domains]\n";
print " [--max-realdoms domains]\n";
print " [--max-mailboxes boxes]\n";
print " [--max-dbs databases]\n";
print " [--max-aliases aliases]\n";
if (&has_home_quotas()) {
print " [--quota quota-for-domain|UNLIMITED]\n";
print " [--uquota quota-for-unix-user|UNLIMITED]\n";
}
if ($config{'bw_active'}) {
print " [--bandwidth bytes]\n";
}
print " [--template \"name\"]\n";
print " [--plan \"name\"]\n";
print " [--limits-from-plan]\n";
print " [--suffix username-prefix]\n";
print " [--db database-name]\n";
print " [--fwdto email-address]\n";
print " [--reseller name]\n";
if ($virtualmin_pro) {
print " [--content text|filename]\n";
}
if ($config{'mysql'}) {
print " [--mysql-pass password]\n";
}
if ($config{'postgres'}) {
print " [--postgres-pass password]\n";
}
foreach $f (&list_feature_plugins()) {
if (&plugin_defined($f, "feature_args")) {
foreach $a (&plugin_call($f, "feature_args")) {
print " [--$a->{'name'}";
if (!$a->{'novalue'}) {
print " $a->{'value'}";
}
print "]\n";
}
}
}
print " [--skip-warnings]\n";
print " [--acme]\n";
print " [--acme-always]\n";
print " [--acme-never]\n";
print " [--field-name value]*\n";
print " [--enable-jail | --disable-jail]\n";
print " [--mysql-server hostname]\n";
print " [--postgres-server hostname]\n";
print " [--cloud-dns provider|\"services\"|\"local\"]\n";
print " [--separate-dns-subdomain |\n";
print " --any-dns-subdomain]\n";
print " [--break-ssl-cert | --link-ssl-cert]\n";
print " [--ssl-redirect]\n";
print " [--generate-ssl-cert]\n";
print " [--generate-ssh-key | --use-ssh-key file|data]\n";
print " [--append-style format]\n";
print " [--shell command]\n";
print " [--subprefix directory]\n";
print " [--proxy url]\n";
print " [--alias-redirect | --no-alias-redirect]\n";
print " [--ssl-redirect | --no-ssl-redirect]\n";
exit(1);
}