Skip to content

Commit d1245fa

Browse files
committed
Update install helper text
1 parent 608e521 commit d1245fa

1 file changed

Lines changed: 2 additions & 21 deletions

File tree

util/install.js

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,11 @@ exports.validate = function(response) {
2020
dashboardLink = 'https://console.aws.amazon.com/console/home';
2121
}
2222

23-
// @TODO: update text
2423
if (!hasSQL && !hasSqliteS3) {
2524
let message = "<p>It appears that the required environment variables for the WordPress database aren't setup.</p>"
2625
+ "<p>If you don't have a database solution selected yet, there are a few options.</p>"
27-
+ "<p>WordPress usually runs with a MySQL or MariaDB database. That means hosting a database that runs 24/7.</p>"
28-
+ "<p>ServerlessWP now supports SQLite combined with S3 as a truly serverless database alternative. Combining SQLite with the recent ability to conditionally write to S3-compatible object storage allows for a zero maintenance and low cost data layer for ServerlessWP.</p>"
29-
+ "<p>Two trade-offs exist using SQLite and S3 for ServerlessWP: some plugins may not be completely compatible with SQLite and requests might fail if simultaneous requests change the database (within milliseconds of each other).</p>"
30-
+ "<p>So you'll need to create an S3 bucket or a MySQL/MariaDB database.</p>"
31-
+ `<p>Then you'll need to populate the environment variables for your site at Vercel or Netlify (<a href="${dashboardLink}">dashboard</a>)</p>`
32-
+ "<p>The required variables for <strong>SQLite and S3</strong> are:</p>"
33-
+ `<pre><code>
34-
SQLITE_S3_BUCKET
35-
SQLITE_S3_API_KEY
36-
SQLITE_S3_API_SECRET
37-
SQLITE_S3_REGION
38-
SQLITE_S3_ENDPOINT (optional: use with Cloudflare R2 for example)
39-
</code></pre>`
40-
+ "<p>The required variables for <strong>MySQL or MariaDB</strong> are:</p>"
41-
+ `<pre><code>
42-
DATABASE
43-
USERNAME
44-
PASSWORD
45-
HOST
46-
</code></pre>`
26+
+ "<p>Head over to the <a href='https://github.com/mitchmac/ServerlessWP?tab=readme-ov-file#3-update-the-environment-variables'>readme</a> to pick a data option and setup environment variables.</p>"
27+
+ `<p>You'll need to populate the environment variables for your site at Vercel or Netlify (<a href="${dashboardLink}">dashboard</a>)</p>`
4728
+ '<p>Then <strong>remember to redeploy your site at Vercel or Netlify</strong> for the environment variables to be updated for the site.</p>';
4829

4930
return {

0 commit comments

Comments
 (0)