Skip to content

Commit d10c257

Browse files
committed
Text Quality Review
1 parent 8f40d27 commit d10c257

43 files changed

Lines changed: 111 additions & 91 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Changes are organized by date, with the most recent changes listed first.
8080
- Added clarifying comment to `ORIGINAL_URL`/`NEW_URL` assignments explaining that both variables are kept intentionally for search-replace workflows and may diverge in future modifications.
8181
- Extracted the supported DB charset whitelist (`utf8mb4`, `utf8`, `latin1`) into a `readonly ALLOWED_DB_CHARSETS` array at the top of `scripts/functions/vhost/vhost-import.sh`, making it easier to update supported charsets in the future.
8282
- Replaced the hardcoded `case` statement for charset validation with a loop over `ALLOWED_DB_CHARSETS`, so the error message dynamically reflects the authoritative list.
83-
- Optimised the post-import search-replace step: added `wp db search` pre-checks before each `wp search-replace` call to skip full-table scans when the source URL (`http://` or `https://`) is not present in the database, avoiding unnecessary work on large databases.
83+
- Optimized the post-import search-replace step: added `wp db search` pre-checks before each `wp search-replace` call to skip full-table scans when the source URL (`http://` or `https://`) is not present in the database, avoiding unnecessary work on large databases.
8484
- Fixed the site-verification failure branch to use `IMPORT_FORMAT == "two_file"` instead of `[[ -n "${WP_ARCHIVE_FILE}" ]]` for format detection, consistent with the rest of the script.
8585
- Removed a duplicate WordPress extraction block in `scripts/functions/vhost/vhost-import.sh` that re-ran archive extraction and wp-config path detection after those steps had already completed.
8686
- Prevented a single-zip import failure path where the duplicate block referenced `${WP_ARCHIVE_FILE}` (only populated in the two-file flow), which could trigger an unrecognized archive error.
@@ -101,7 +101,7 @@ Changes are organized by date, with the most recent changes listed first.
101101

102102
### 🔧 PHP AND MARIADB TUNING
103103

104-
- Updated the logic across the codebase to better optimize the server for a variety of configuration scenarios, including low an high memory environments.
104+
- Updated the logic across the codebase to better optimize the server for a variety of configuration scenarios, including low and high memory environments.
105105

106106
## 2026-03-27
107107

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ es.install
6868

6969
### EngineScript Menu
7070

71-
After EngineScript is fully installed, type `es.menu` in console to bring up the EngineScript menu. Choose **1) Domain Configuration Tools**, then select **1) Create New Domain** or **2) Import Domain** to get started adding your first site to the server. If you're moving an existing site into EngineScript, the Import Domain function is fairly robust and should help simplify the process quite a bit.
71+
After EngineScript is fully installed, type `es.menu` at the console to bring up the EngineScript menu. Choose **1) Domain Configuration Tools**, then select **1) Create New Domain** or **2) Import Domain** to get started adding your first site to the server. If you're moving an existing site into EngineScript, the Import Domain function is fairly robust and should help simplify the process quite a bit.
7272

7373
### Cloudflare
7474

@@ -103,7 +103,7 @@ For more information, see [This is Brotli from Origin](https://blog.cloudflare.c
103103

104104
1. In WordPress, go to Settings >> Nginx Helper
105105
2. Check Enable Purge.
106-
3. Select "nginx Fastcgi cache" for Caching Method
106+
3. Select "nginx FastCGI cache" for Caching Method
107107
4. Select "Using a GET request to PURGE/url (Default option)" for Purging Method.
108108
5. Check all of the boxes under Purging Conditions.
109109
6. Save Changes.
@@ -146,8 +146,8 @@ Want to support EngineScript? [Sponsor this project](https://github.com/sponsors
146146

147147
|Command|Function|
148148
|-|-|
149-
|**`es.backup`** |Runs the backup script to backup all domains locally and *optionally* in the cloud|
150-
|**`es.cache`** |Clear FastCGI Cache, OpCache, and Redis *(server-wide)*|
149+
|**`es.backup`** |Runs the backup script to back up all domains locally and *optionally* in the cloud|
150+
|**`es.cache`** |Clears FastCGI Cache, OpCache, and Redis *(server-wide)*|
151151
|**`es.config`** |Opens the configuration file in Nano|
152152
|**`es.debug`** |Displays debug information for EngineScript|
153153
|**`es.help`** |Displays EngineScript commands and locations|

config/etc/nginx/globals/cloudflare.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CloudFlare IP addresses
1+
# Cloudflare IP addresses
22
# This file is automatically adjusted during install and via a cron job that runs periodically.
33

44
# IPv4

config/etc/nginx/globals/fcgi-cached.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
location / {
33
try_files $uri $uri/ /index.php?$args;
44

5-
# HTTP Reponse Headers
5+
# HTTP Response Headers
66
include /etc/nginx/globals/response-headers.conf;
77
}

config/etc/nginx/globals/php-fpm.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ if ($skip_cache = 0 ) {
2121
set $es_session "";
2222
}
2323

24-
# HTTP Reponse Headers
24+
# HTTP Response Headers
2525
include /etc/nginx/globals/response-headers.conf;
2626

2727
# Pass upstream 103 Early Hints only for eligible clients.

config/etc/sysctl.d/60-enginescript.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ net.ipv4.icmp_echo_ignore_all = 0
160160
# Ignore ICMP broadcast requests
161161
net.ipv4.icmp_echo_ignore_broadcasts = 1
162162

163-
# Enable bad error message Protection
163+
# Enable bad error message protection
164164
net.ipv4.icmp_ignore_bogus_error_responses = 1
165165

166166
# Allowed local port range

config/home/enginescript-install-options.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
## EngineScript Install Debug Mode ##
2121
# Prompts the user to continue or exit after each portion of the install script has run.
2222
# Debug mode will print any errors that each install script encounters.
23-
# Regardless of whether debug mode is enabled, EngineScript will generate a complete log of the script errors will be located at touch /var/log/EngineScript/install-error-log.log
24-
# Run command es.debug to generate a complete server and error log. This is useful when submitting a GitHub issue.
23+
# Regardless of whether debug mode is enabled, EngineScript will generate a complete error log at /var/log/EngineScript/install-error-log.log
24+
# Run the es.debug command to generate a complete server and error log. This is useful when submitting a GitHub issue.
2525
DEBUG_INSTALL=0
2626

2727
## Admin Subdomain (Recommended) ##
@@ -57,13 +57,13 @@ INSTALL_EXPANDED_PHP=0
5757
## PHP Version Override ##
5858
# Leave empty to use the default PHP version (currently 8.5)
5959
# Set to "8.4" or "8.3" to install an older version instead
60-
# This affects all PHP installation, configuration, and service management
60+
# This affects all PHP installation, configuration, and service management.
6161
# You can also switch versions at any time via: es.menu > Update Software > Switch PHP Version
6262
PHP_VERSION_OVERRIDE=""
6363

6464
## Automatic Lossless Image Optimization ##
6565
# Automatically perform lossless compression on all images on each domain.
66-
# This script will remember which files have previously been compressed on the server, but will not be able to know if this was performed on a site from another server.
66+
# This script remembers which files have previously been compressed on the server, but it cannot know if compression was performed on another server.
6767
# Do not enable this feature if you have an image compression plugin or do lossless compression on images prior to uploading them to your site.
6868
AUTOMATIC_LOSSLESS_IMAGE_OPTIMIZATION=0
6969

@@ -77,7 +77,7 @@ INSTALL_ENGINESCRIPT_PLUGINS=1
7777
## Install Extra WordPress Plugins ##
7878
# When enabled, EngineScript will install additional recommended WordPress plugins during site creation:
7979
# action-scheduler, autodescription, performance-lab, php-compatibility-checker, theme-check, wp-crontrol, wp-mail-smtp
80-
# These are optional but recommended for enhanced functionality, debugging, and development
80+
# These are optional but recommended for enhanced functionality, debugging, and development.
8181
# Note: Core plugins (flush-opcache, mariadb-health-checks, nginx-helper, redis-cache) are always installed
8282
INSTALL_EXTRA_WP_PLUGINS=1
8383

@@ -87,9 +87,9 @@ INSTALL_EXTRA_WP_PLUGINS=1
8787
SHOW_ENGINESCRIPT_HEADER=0
8888

8989
## Nginx Unsafe File Blocking ##
90-
# Blocks access to potentially unsafe file types and locations in FastCGI cache
90+
# Blocks access to potentially unsafe file types and locations in FastCGI cache.
9191
# When enabled, blocks: .env, .log, .ini, wp-config.php, composer.json, backup files, etc.
92-
# Disable if you need to access these files through the web (not recommended for security)
92+
# Disable if you need to access these files through the web (not recommended for security).
9393
NGINX_BLOCK_UNSAFE_FILES=0
9494

9595
## Experimental: zlib Alternative for Nginx (Optional) ##
@@ -102,7 +102,7 @@ NGINX_BLOCK_UNSAFE_FILES=0
102102
# "zlib-ng" = zlib-ng (C, high-performance drop-in with --zlib-compat mode)
103103
# "zlib-rs" = zlib-rs (Rust-based, requires cargo/rustc toolchain on the server)
104104
#
105-
# WARNING: These are experimental options. If Nginx fails to compile, set back to "".
105+
# WARNING: These are experimental options. If Nginx fails to compile, set this back to "".
106106
ZLIB_IMPLEMENTATION=""
107107

108108
## DigitalOcean Remote Console ##
@@ -131,8 +131,8 @@ INSTALL_DIGITALOCEAN_METRICS_AGENT=0
131131
ENGINESCRIPT_AUTO_UPDATE=1
132132

133133
# EngineScript Emergency Updates (Recommended)
134-
# Recommended if you allow EngineScript to auto-update. In the event that a change is pushed live that breaks servers, this emergency-only script will run to attempt a self-heal.
135-
# This script runs hourly, but will not contain any code unless there is a code issue that warrants emergency measures be taken.
134+
# Recommended if you allow EngineScript to auto-update. If a live change breaks servers, this emergency-only script will attempt a self-heal.
135+
# This script runs hourly, but will not contain any code unless there is a code issue that requires emergency measures.
136136
ENGINESCRIPT_AUTO_EMERGENCY_UPDATES=1
137137

138138
# EngineScript Test Mode

config/var/www/admin/control-panel/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,15 +201,15 @@ <h3><i class="fas fa-terminal"></i> EngineScript Commands</h3>
201201
<div class="commands-grid">
202202
<div class="command-item">
203203
<code>es.backup</code>
204-
<p>Backup all domains locally and optionally to cloud</p>
204+
<p>Back up all domains locally and optionally to the cloud</p>
205205
</div>
206206
<div class="command-item">
207207
<code>es.cache</code>
208-
<p>Clear FastCGI Cache, OpCache, and Redis (server-wide)</p>
208+
<p>Clear FastCGI cache, OpCache, and Redis (server-wide)</p>
209209
</div>
210210
<div class="command-item">
211211
<code>es.config</code>
212-
<p>Open configuration file in Nano</p>
212+
<p>Open the configuration file in Nano</p>
213213
</div>
214214
<div class="command-item">
215215
<code>es.debug</code>

config/var/www/wordpress/wp-config.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
define( 'IMAGE_EDIT_OVERWRITE', true );
9393
define( 'MEDIA_TRASH', true );
9494
define( 'WP_POST_REVISIONS', 2 ); // Can also be set to false
95-
define( 'ALLOW_UNFILTERED_UPLOADS', false ); // Allows admins to upload files that would WordPress would normally filter by default such as .CSV and .TXT.
95+
define( 'ALLOW_UNFILTERED_UPLOADS', false ); // Allows admins to upload files that WordPress would normally filter by default, such as .CSV and .TXT.
9696

9797
/* Jetpack Brute Force Attack Protection */
9898
// https://jetpack.com/support/protect/
@@ -127,7 +127,7 @@
127127
//define( 'WP_SENTRY_ENV', 'production' );
128128

129129
/* Compression */
130-
// Leave these disabled unless you absolutely need them for whatever reason. This is done with Nginx and Cloudflare.
130+
// Leave these disabled unless you absolutely need them. This is handled by Nginx and Cloudflare.
131131
//define( 'COMPRESS_CSS', true );
132132
//define( 'COMPRESS_SCRIPTS', true );
133133
//define( 'ENFORCE_GZIP', true );
@@ -156,7 +156,7 @@
156156
define( 'RECOVERY_MODE_EMAIL', 'SEDWPRECOVERYEMAIL' ); // When any site visitor attempts loading your site and encounters a fatal error, WordPress will send an email outlining the error details.
157157
define( 'SAVEQUERIES', false ); // https://codex.wordpress.org/Editing_wp-config.php#Save_queries_for_analysis
158158
define( 'SCRIPT_DEBUG', false ); // Use dev versions of core JS and CSS files (only needed if you are modifying these core files)
159-
define( 'WP_ALLOW_REPAIR', false ); // https://SEDURL/wp-admin/maint/repair.php - Disable once you're done. Anyone can trigger this.
159+
define( 'WP_ALLOW_REPAIR', false ); // https://SEDURL/wp-admin/maint/repair.php - Disable this when you're done. Anyone can trigger this.
160160
define( 'WP_DEBUG_DISPLAY', false ); // Displays logs within browser on site. Not for production environments.
161161
define( 'WP_DEBUG_LOG', '/var/log/domains/SEDURL/SEDURL-wp-error.log' ); // Only writes log if WP_DEBUG is set to true.
162162
//define( 'WP_DISABLE_FATAL_ERROR_HANDLER', false ); // Disable the fatal error handler

scripts/functions/alias/alias-help.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ fi
3232
# Newlines within the double-quoted string are preserved by printf.
3333
printf "${BOLD}EngineScript Commands:${NORMAL}
3434
--------------------------------
35-
es.backup - Runs the backup script to backup all domains locally and optionally in the cloud
36-
es.cache - Clear FastCGI Cache, OpCache, and Redis (server-wide)
35+
es.backup - Runs the backup script to back up all domains locally and optionally in the cloud
36+
es.cache - Clears FastCGI Cache, OpCache, and Redis (server-wide)
3737
es.config - Opens the configuration file in Nano
3838
es.debug - Displays debug information for EngineScript
3939
es.help - Displays EngineScript commands and locations

0 commit comments

Comments
 (0)