GoAdmio

conf

Rebuild Apache/Nginx virtual hosts, PHP-FPM pools, and SSL for all accounts, or the web configuration of one domain

On this page: Overview · Quick start · Syntax · Options · Output · Examples · Troubleshooting · Details · See also


Overview

/go/conf regenerates the web server configuration from GoAdmio's database. It has two main modes.

One domain (conf <domain>) rewrites that account's Apache and Nginx virtual host and its PHP-FPM pool, then reloads the services.

Full rebuild (conf with no domain) deletes every generated virtual host and rebuilds them all. It:

A third mode, --schedule, queues one full rebuild to run in 3 minutes.

[!WARNING] --force deletes everything in /etc/letsencrypt/ (all certificates, renewal settings, and the Let's Encrypt account) and then requests new certificates. If issuing fails, or --skip ssl is used, sites are left without HTTPS. See --force.

[!WARNING] Only the first argument is checked for a domain. conf --force example.com is not a one-domain rebuild. It is a full forced rebuild of the whole server. Always put the domain first.


Quick start

# Rebuild the web configuration of one account
/go/conf example.com

# Rebuild everything
/go/conf

Syntax

# One domain
/go/conf <domain> [--force]

# Full rebuild
/go/conf [--force] [--installwebserver] [--limit] [--skip ssl] [--skip mailssl]

# Queue a full rebuild in 3 minutes
/go/conf --schedule
Form Behavior
/go/conf <domain> Used when the first argument contains a dot. Rebuilds only that account, then exits. Nothing happens if /home/<domain>/www doesn't exist.
/go/conf [options] Full rebuild of every account and subdomain.
/go/conf --schedule Queues /go/conf with at, unless a queued /go/ job whose command contains conf already exists. The queued run uses no options.

If you run the command without root privileges, it restarts itself through sudo. Every run is appended to /var/log/go/conf.log.

Options are detected anywhere in the argument list.


Options

All options are optional.

Option Applies to Effect
--force Full rebuild (also runs ws first in one-domain mode) See --force.
--installwebserver Full rebuild Installs the web server packages before rebuilding. See Installing the web servers.
--limit Full rebuild Passed unchanged to installssl, ssl, and mailssl. See those commands for what it does.
--skip ssl Full rebuild Skips the ssl all step. Does not skip the per-subdomain step. See Subdomains.
--skip mailssl Full rebuild Skips the mailssl step.
--schedule Full rebuild Queues a rebuild in 3 minutes instead of running one now.

--force

With --force, the command:

  1. Runs ws first, to correct which web server (Apache or Nginx) GoAdmio is set to use.
  2. Deletes every PHP-FPM pool file in every PHP version, except www.conf.
  3. Deletes everything in /etc/letsencrypt/.
  4. Runs installssl, then ssl all (unless --skip ssl is given) to issue certificates again.

Without --force, only the pool files of accounts whose /home/<domain> folder is gone are deleted, and existing certificates are kept.


Output

Progress is printed in sections. Each section ends with a . line.

Message Meaning
Deleting <file> Pool... A PHP-FPM pool file for an account that no longer exists is being removed.
Domains Configuration... Start of the account loop.
[<n>/<total>] Configuration completed for <domain> (<php version>) The account's virtual hosts and pool were rebuilt.
[<n>/<total>] Configuration completed for <domain> (<php version>). FPM Diabled (INSCURE) Same, and the account has PHP-FPM turned off.
Sub-Domains Configuration... Start of the subdomain loop.
[<n>/<total>] Configuration completed for <subdomain> (<php version>) The subdomain was processed.
Creating GoAdmio PHP-FPM Pool... The pool for the GoAdmio panel is rebuilt.
Installing Missing SSL Certificates... Shown without --force and without --skip ssl, before ssl all runs.
Restarting Web Server and PHP-FPM... Final step.

Accounts that are not in the Site table, or that have no www folder, are skipped without a message. The total in [<n>/<total>] counts every folder in /home with a dot in its name, so it can differ from the number of accounts processed.

Exit status

Mode Exit status
One domain Always 1, even on success.
--schedule Always 1.
Full rebuild 0 when it reaches the end.

Examples

# One account
/go/conf example.com
# Full rebuild, no certificate requests
/go/conf --skip ssl --skip mailssl
# Install Apache and Nginx packages, then rebuild
/go/conf --installwebserver
# Queue a rebuild in 3 minutes
/go/conf --schedule
# Full rebuild that also resets all certificates and pools
/go/conf --force

Troubleshooting

Symptom Likely cause Fix
conf <domain> prints nothing /home/<domain>/www doesn't exist. Check the domain and that the account has a www folder.
conf --force <domain> rebuilt the whole server Only the first argument is read as a domain. Put the domain first: conf <domain> --force. Then check certificates with checkssl.
An account is missing from the output It isn't in the Site table, or it has no www folder. Check the account with create or recover.
Sites show the default page or no HTTPS after the run The run was interrupted, or certificate requests failed. Run /go/conf again. Then run ssl all if certificates are still missing.
Many certificates fail after --force Let's Encrypt rate limits can block reissuing many certificates at once. Wait, then run ssl all again. Avoid --force unless you need it.
No certificates after --force --skip ssl Certificates were deleted and the ssl all step was skipped. Run ssl all.
FPM Diabled (INSCURE) for an account PHP-FPM is turned off for that account. See disablefpm. No action if intended. Otherwise turn PHP-FPM back on for the account.
Deleting <file> Pool... The pool belongs to an account whose /home/<domain> folder no longer exists. Expected after an account is deleted.
--schedule queued nothing An at job whose command contains conf is already queued. Check with atq.
A /go.conf file appeared in / The operating system in os.db is not RHEL-family or Debian/Ubuntu, so the virtual host folder was empty. Run conf only on supported systems. Delete the file.
The web server does not start after the run Invalid generated configuration. Run checkapache or checknginx, then web.
The run takes a long time Every account and subdomain is rebuilt in turn, and certificates are requested one by one. Run it from a persistent session, such as screen or tmux.

Details

What a full rebuild does

flowchart TD
    A["conf"] --> B{"First argument has a dot?"}
    B -- "Yes" --> C["apache, nginx, php-fpm for that domain, then reload"]
    B -- "No" --> S{"--schedule?"}
    S -- "Yes" --> Q["Queue one conf run in 3 minutes"]
    S -- "No" --> I["Install web servers if --installwebserver"]
    I --> W["Delete all virtual host files"]
    W --> P["Delete PHP-FPM pools: all with --force, orphans otherwise"]
    P --> L["With --force: delete /etc/letsencrypt"]
    L --> D["Rebuild every account: vhost and pool"]
    D --> U["Rebuild every subdomain"]
    U --> G["Rebuild the GoAdmio panel pool"]
    G --> SSL["ssl all and mailssl, unless skipped"]
    SSL --> H["Remove stray .htaccess files"]
    H --> R["Restart web server and PHP-FPM"]
  1. Appends the call to /var/log/go/conf.log.
  2. With --force, runs ws to correct the web server setting.
  3. Reads the operating system from /usr/local/goadmio/linux/os.db and the web server from /usr/local/goadmio/linux/ws.db.
  4. With --schedule, queues a run and stops.
  5. With --installwebserver, installs the web server packages.
  6. Deletes all files in the Apache virtual host folder (/etc/httpd/vhost/ or /etc/apache2/vhost/) and in /etc/nginx/vhost/. Creates the Apache log folder if it is missing.
  7. Writes an empty go.conf into the Apache virtual host folder.
  8. Deletes PHP-FPM pool files: all except www.conf with --force, otherwise only pools of accounts whose /home/<domain> folder is gone (www.conf and go.conf are always kept).
  9. With --force, deletes everything in /etc/letsencrypt/.
  10. Creates the system user go with a random password if it doesn't exist.
  11. For every account in /home that is in the Site table and has a www folder:
    1. Creates its system user with adduser if missing.
    2. Rebuilds its virtual host with apache and nginx.
    3. Rebuilds its pool with php-fpm.
  12. Runs go to rebuild the GoAdmio panel's own web configuration.
  13. Rebuilds every subdomain (see Subdomains).
  14. Rebuilds the GoAdmio panel's PHP-FPM pool.
  15. Requests certificates (see SSL).
  16. Runs mailssl unless --skip mailssl is given.
  17. Deletes /home/.htaccess and /home/*/.htaccess. These files sit outside the website folders and are invalid there.
  18. Restarts the web server and PHP-FPM with restart.

All virtual host files are deleted before they are regenerated, so while a full rebuild runs, only the accounts already processed have a virtual host. Let it finish. If it was interrupted, run it again.

Subdomains

For each subdomain in the subdomain database:

Situation Action
No certificate at /etc/letsencrypt/live/<subdomain>/cert.pem Runs ssl <subdomain>.
Certificate exists Rebuilds its virtual host with apache-subdomain and nginx-subdomain.

The ssl call for a subdomain without a certificate happens even when --skip ssl is given. After --force, every subdomain falls in this case, because all certificates were deleted.

SSL

Mode Steps
With --force installssl, then ssl all (unless --skip ssl).
Without --force ssl all only (unless --skip ssl), which requests the missing certificates.

Installing the web servers

--installwebserver runs before anything is deleted.

System Packages installed
AlmaLinux, Rocky, CentOS, Red Hat, Fedora httpd, nginx, mod_fcgid
Debian, Ubuntu apache2, nginx

Files and services used

Item Purpose
/var/log/go/conf.log Log of every run and its arguments.
/var/lib/sqlite/site.db Accounts, PHP versions, and FPM setting.
/var/lib/sqlite/subdomain.db Subdomains and their PHP versions.
/usr/local/goadmio/linux/os.db, ws.db Operating system and active web server.
/etc/httpd/vhost/ or /etc/apache2/vhost/, /etc/nginx/vhost/ Generated virtual hosts.
/etc/opt/remi/*/php-fpm.d/ or /etc/php/*/fpm/pool.d/ PHP-FPM pools.
/etc/letsencrypt/ Certificates. Deleted with --force.
/usr/local/goadmio/tmp/pool.db, conf-subdomain.db Temporary lists used during the run.

See also

Command Description
apache Convert a GoAdmio server from Nginx to Apache (with a domain, rebuilds that domain's Apache vhost)
nginx Convert a GoAdmio server from Apache to Nginx (with a domain, rebuilds that domain's Nginx vhost)
default Restore the default Apache/Nginx vhost for a domain
reload Reload PHP-FPM and the active web server
restart Restart all PHP-FPM pools and the active web server
web Restart or reload the active web server
checkapache Validate the Apache configuration
checknginx Validate the Nginx configuration and remove vhosts with no site directory
ssl Install an SSL certificate for a domain in GoAdmio
installssl Install Let's Encrypt SSL on GoAdmio
mailssl Install SSL certificates for SMTP and IMAP
checkssl Audit SSL certificates for all hosted domains, renew those close to expiry, and send expiry alerts
multiphp Manage PHP versions per domain
disablefpm Disable PHP-FPM per-domain pools and switch to mod_php (Apache only)
php-fpm Create the PHP-FPM pool for an account (used internally)
ws Correct which web server GoAdmio uses (used internally)