|
@@ -1,16 +1,12 @@
|
|
|
# WIP
|
|
|
|
|
|
-This project contains two files:
|
|
|
+`acme-cpanel.sh` reads in a list of domains from one or more files. These files may only contain domains and empty lines (see `domains.txt` for example format).
|
|
|
|
|
|
-`acme-cpanel-webroot.sh` (for webroot challenges)
|
|
|
-
|
|
|
-`acme-cpanel-dns.sh` (for dns challenges, legacy script)
|
|
|
-
|
|
|
-Both of these scripts read in a list of domains from one or more files. These files may only contain domains and empty lines (see `domains.txt`).
|
|
|
+"*www.*" subdomains will be added automatically (do not add them to the domains file list).
|
|
|
|
|
|
## Notes
|
|
|
|
|
|
-`acme-cpanel-webroot.sh` may require the following additions to .htaccess so that challenges are not automatically redirected to https:
|
|
|
+The `--method webroot` may require the following additions to .htaccess so that challenges are not automatically redirected to https:
|
|
|
|
|
|
```text
|
|
|
RewriteCond %{REQUEST_FILENAME} !-f
|
|
@@ -23,32 +19,33 @@ Command-line (Linux):
|
|
|
|
|
|
* Move script to user home directory on the server: `scp ./* username@ip:port:~`
|
|
|
* Login to server: `ssh user@ip -p port`
|
|
|
-* Make script executable: `chmod +x $HOME/acme-cpanel-webroot.s`
|
|
|
-* Run script (ex. `$HOME/acme-cpanel-webroot.sh -s multisites`)
|
|
|
+* Make script executable: `chmod +x $HOME/acme-cpanel.sh`
|
|
|
+* Run script (ex. `$HOME/acme-cpanel.sh -s multisites`)
|
|
|
* Follow prompts to enter credentials, issue certificates, and deploy them
|
|
|
* Double-check that the acme cron job is enabled: `crontab -l`
|
|
|
|
|
|
cPanel:
|
|
|
|
|
|
* Use File Manager to upload files to the home directory (/home/username/)
|
|
|
-* You may need to make file executable in Terminal: `chmod +x $HOME/acme-cpanel-webroot.sh`
|
|
|
-* Use Terminal to run the script (ex. `$HOME/acme-cpanel-webroot.sh -s multisites`)
|
|
|
+* You may need to make file executable in Terminal: `chmod +x $HOME/acme-cpanel.sh`
|
|
|
+* Use Terminal to run the script (ex. `$HOME/acme-cpanel.sh -s multisites`)
|
|
|
* Follow prompts to enter credentials, issue certificates, and deploy them
|
|
|
* Use Cron Jobs app to double-check that the acme cron job is present
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
-### `./acme-cpanel-webroot.sh [OPTIONS] [FILES...]`
|
|
|
+### `./acme-cpanel.sh [OPTIONS] [FILES...]`
|
|
|
|
|
|
#### Options
|
|
|
|
|
|
```text
|
|
|
+--method, -m webroot,dns
|
|
|
+ Choose the authentication method (default: dns)
|
|
|
--email, -e EMAIL
|
|
|
E-mail not be notified of certificate renewal failures
|
|
|
---keep-grouping, -k
|
|
|
- Issue multidomain certificates based on grouping by input file
|
|
|
+--group-by-file, -g
|
|
|
+ Issue multidomain certificates for all domains with the same webroot, grouped by input file
|
|
|
The first domain in each file will be used to determine the shared webroot
|
|
|
- Default: issue certificates by independent domain
|
|
|
--sites-dir, -s DIR
|
|
|
Load domain list files from this directory
|
|
|
--force, -f
|
|
@@ -59,18 +56,14 @@ cPanel:
|
|
|
|
|
|
#### Examples
|
|
|
|
|
|
-`./acme-cpanel-webroot.sh --force`
|
|
|
-
|
|
|
-Load sites from domains.txt, issue and deploy certificates
|
|
|
-
|
|
|
-`./acme-cpanel-webroot.sh --force -s multisites`
|
|
|
+`./acme-cpanel.sh --force`
|
|
|
|
|
|
-Load sites from multisites directory, issue and deploy certificates
|
|
|
+Load sites from domains.txt, issue and deploy certificates using the webroot method
|
|
|
|
|
|
-`./acme-cpanel-webroot.sh --force -k multisites/flatwhitedesign.pw multisites/greengingerdesign.pw`
|
|
|
+`./acme-cpanel.sh --method dns --force -s multisites`
|
|
|
|
|
|
-Load sites from multisites directory, issue and deploy multidomain certificates based on the grouping in the file.
|
|
|
+Load sites from multisites directory, issue and deploy certificates using the dns method
|
|
|
|
|
|
-### `./acme_cpanel_dns.sh`
|
|
|
+`./acme-cpanel.sh --force -g multisites/flatwhitedesign.pw multisites/greengingerdesign.pw`
|
|
|
|
|
|
-This is a legacy script that takes no arguments. By default it will read all domain lists in a top-level "multisites" directory.
|
|
|
+Load sites from multisites directory, issue and deploy multidomain certificates with same webroot based on the grouping in the file using the webroot method
|