From 7fa8d5b7b22546098e55746ce92ea07adca7caec Mon Sep 17 00:00:00 2001
From: tschettervictor <85497460+tschettervictor@users.noreply.github.com>
Date: Mon, 14 Oct 2024 11:29:22 -0600
Subject: [PATCH] Create README.md

---
 wordpress/README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 wordpress/README.md

diff --git a/wordpress/README.md b/wordpress/README.md
new file mode 100644
index 0000000..0728833
--- /dev/null
+++ b/wordpress/README.md
@@ -0,0 +1,72 @@
+# Wordpress
+https://wordpress.com
+
+### Command to fetch script
+```
+fetch https://raw.githubusercontent.com/tschettervictor/bsd-apps/main/wordpress/wordpress-install.sh
+```
+
+Don't forget to
+```
+chmod +x wordpress-install.sh
+```
+
+## Notes
+- when initially setting up wordpress, make sure to access the page using the hostname you plan to use with your site
+- this scirpt generates some cookie tokens, but uses base64 to do it. If you want super secure tokens, see https://api.wordpress.org/secret-key/1.1/salt/ and add them to `/usr/local/www/wordpress/wp-config.sh`
+
+## Variables
+These are the variables that are available to change along with their defaults and a description of what they do. Other variables should be left at default unless you have a good reason to change them.
+
+HOST_NAME
+- sets the hostname to use for the webserver
+- must be set to your FQDN ie: my.domain.com
+
+MARIADB_VERSION
+- mariadb version to use (currently defaults to 106)
+
+PHP_VERSION
+- php version to use (currently defaults to 83)
+
+### Cerificate Configuration
+
+Caddy is a webserver that can do automatic TLS and HTTPS for you. You should enable one AND ONLY ONE of the following 4 CERT configurations to tell the script how you want Caddy to work. Unless you are going to put you installation behind a reverse proxy, you should not ever choose NO_CERT.
+
+NO_CERT
+- no certificate, http access only
+
+STANDALONE_CERT
+- fully working cert, must own a domain, and have ports 80 and 443 forwarded to your jail
+
+SELFSIGNED_CERT
+- generates a self-signed cert for use with https
+
+DNS_CERT 
+- DNS validated cert, https access
+- must be used together with CERT_EMAIL DNS_TOKEN and DNS_PLUGIN
+- must own a domain that allows DNS validation
+- will generate a DNS validated cert
+
+DNS_PLUGIN
+- set this to a supported DNS plugin, see caddy docs for details
+- only used with DNS_CERT
+
+DNS_TOKEN
+- must have "Zone / Zone / Read" and "Zone / DNS / Edit" permissions on the domain you are using with Caddy
+- only used with DNS_CERT 
+
+CERT_EMAIL
+- your email to receive cert expiry
+- used with DNS_CERT and STANDALONE_CERT
+
+If you do use any type of certificate with a domain, Caddy will obtain a staging certificate to not excede rate limits. Once you have confirmed things are working, run the script at `/root/remove-staging.sh` to acquire a valid certificate.
+
+All of the above variables should be changed to fit your environment.
+
+## Mount points (should be mounted outside the jail)
+- `/var/db/mysql` - database directory
+- `/usr/local/www/wordpress` - web directory
+- reinstalls have not been tested yet
+  
+## Jail Properties
+- none