From 05d8127b9b5493b5d168cf5b269dd42aaa4d0424 Mon Sep 17 00:00:00 2001 From: derrickmehaffy Date: Tue, 30 Nov 2021 10:33:42 -0700 Subject: [PATCH] Fix provider config examples for v4 Signed-off-by: Derrick Mehaffy --- packages/providers/email-amazon-ses/README.md | 20 +++++++------ packages/providers/email-mailgun/README.md | 20 +++++++------ packages/providers/email-nodemailer/README.md | 28 +++++++++++-------- packages/providers/email-sendgrid/README.md | 16 ++++++----- packages/providers/email-sendmail/README.md | 10 ++++--- packages/providers/upload-aws-s3/README.md | 16 ++++++----- .../providers/upload-cloudinary/README.md | 20 +++++++------ packages/providers/upload-local/README.md | 22 +++++++++------ packages/providers/upload-rackspace/README.md | 14 ++++++---- 9 files changed, 95 insertions(+), 71 deletions(-) diff --git a/packages/providers/email-amazon-ses/README.md b/packages/providers/email-amazon-ses/README.md index 0384ded8eb..5a5fbae988 100644 --- a/packages/providers/email-amazon-ses/README.md +++ b/packages/providers/email-amazon-ses/README.md @@ -44,15 +44,17 @@ npm install strapi-provider-email-amazon-ses --save module.exports = ({ env }) => ({ // ... email: { - provider: 'amazon-ses', - providerOptions: { - key: env('AWS_SES_KEY'), - secret: env('AWS_SES_SECRET'), - amazon: 'https://email.us-east-1.amazonaws.com', - }, - settings: { - defaultFrom: 'myemail@protonmail.com', - defaultReplyTo: 'myemail@protonmail.com', + config: { + provider: 'amazon-ses', + providerOptions: { + key: env('AWS_SES_KEY'), + secret: env('AWS_SES_SECRET'), + amazon: 'https://email.us-east-1.amazonaws.com', + }, + settings: { + defaultFrom: 'myemail@protonmail.com', + defaultReplyTo: 'myemail@protonmail.com', + }, }, }, // ... diff --git a/packages/providers/email-mailgun/README.md b/packages/providers/email-mailgun/README.md index dd0b0286f7..6bd7bcedc6 100644 --- a/packages/providers/email-mailgun/README.md +++ b/packages/providers/email-mailgun/README.md @@ -44,15 +44,17 @@ npm install strapi-provider-email-mailgun --save module.exports = ({ env }) => ({ // ... email: { - provider: 'mailgun', - providerOptions: { - apiKey: env('MAILGUN_API_KEY'), - domain: env('MAILGUN_DOMAIN'), //Required if you have an account with multiple domains - host: env('MAILGUN_HOST', 'api.mailgun.net'), //Optional. If domain region is Europe use 'api.eu.mailgun.net' - }, - settings: { - defaultFrom: 'myemail@protonmail.com', - defaultReplyTo: 'myemail@protonmail.com', + config: { + provider: 'mailgun', + providerOptions: { + apiKey: env('MAILGUN_API_KEY'), + domain: env('MAILGUN_DOMAIN'), //Required if you have an account with multiple domains + host: env('MAILGUN_HOST', 'api.mailgun.net'), //Optional. If domain region is Europe use 'api.eu.mailgun.net' + }, + settings: { + defaultFrom: 'myemail@protonmail.com', + defaultReplyTo: 'myemail@protonmail.com', + }, }, }, // ... diff --git a/packages/providers/email-nodemailer/README.md b/packages/providers/email-nodemailer/README.md index 124c611a9a..62b8548ea5 100644 --- a/packages/providers/email-nodemailer/README.md +++ b/packages/providers/email-nodemailer/README.md @@ -30,22 +30,26 @@ npm install strapi-provider-email-nodemailer --save ```js module.exports = ({ env }) => ({ + // ... email: { - provider: 'nodemailer', - providerOptions: { - host: env('SMTP_HOST', 'smtp.example.com'), - port: env('SMTP_PORT', 587), - auth: { - user: env('SMTP_USERNAME'), - pass: env('SMTP_PASSWORD'), + config: { + provider: 'nodemailer', + providerOptions: { + host: env('SMTP_HOST', 'smtp.example.com'), + port: env('SMTP_PORT', 587), + auth: { + user: env('SMTP_USERNAME'), + pass: env('SMTP_PASSWORD'), + }, + // ... any custom nodemailer options + }, + settings: { + defaultFrom: 'hello@example.com', + defaultReplyTo: 'hello@example.com', }, - // ... any custom nodemailer options - }, - settings: { - defaultFrom: 'hello@example.com', - defaultReplyTo: 'hello@example.com', }, }, + // ... }); ``` diff --git a/packages/providers/email-sendgrid/README.md b/packages/providers/email-sendgrid/README.md index 2c6d5bb035..9c7072f222 100644 --- a/packages/providers/email-sendgrid/README.md +++ b/packages/providers/email-sendgrid/README.md @@ -45,13 +45,15 @@ npm install strapi-provider-email-sendgrid --save module.exports = ({ env }) => ({ // ... email: { - provider: 'sendgrid', - providerOptions: { - apiKey: env('SENDGRID_API_KEY'), - }, - settings: { - defaultFrom: 'myemail@protonmail.com', - defaultReplyTo: 'myemail@protonmail.com', + config: { + provider: 'sendgrid', + providerOptions: { + apiKey: env('SENDGRID_API_KEY'), + }, + settings: { + defaultFrom: 'myemail@protonmail.com', + defaultReplyTo: 'myemail@protonmail.com', + }, }, }, // ... diff --git a/packages/providers/email-sendmail/README.md b/packages/providers/email-sendmail/README.md index 0423bef966..804dbfe13f 100644 --- a/packages/providers/email-sendmail/README.md +++ b/packages/providers/email-sendmail/README.md @@ -45,10 +45,12 @@ npm install strapi-provider-email-sendmail --save module.exports = ({ env }) => ({ // ... email: { - provider: 'sendmail', - settings: { - defaultFrom: 'myemail@protonmail.com', - defaultReplyTo: 'myemail@protonmail.com', + config: { + provider: 'sendmail', + settings: { + defaultFrom: 'myemail@protonmail.com', + defaultReplyTo: 'myemail@protonmail.com', + }, }, }, // ... diff --git a/packages/providers/upload-aws-s3/README.md b/packages/providers/upload-aws-s3/README.md index 0dad4fee60..112dd379ea 100644 --- a/packages/providers/upload-aws-s3/README.md +++ b/packages/providers/upload-aws-s3/README.md @@ -14,13 +14,15 @@ See the [using a provider](https://docs.strapi.io/developer-docs/latest/plugins/ module.exports = ({ env }) => ({ // ... upload: { - provider: 'aws-s3', - providerOptions: { - accessKeyId: env('AWS_ACCESS_KEY_ID'), - secretAccessKey: env('AWS_ACCESS_SECRET'), - region: env('AWS_REGION'), - params: { - Bucket: env('AWS_BUCKET'), + config: { + provider: 'aws-s3', + providerOptions: { + accessKeyId: env('AWS_ACCESS_KEY_ID'), + secretAccessKey: env('AWS_ACCESS_SECRET'), + region: env('AWS_REGION'), + params: { + Bucket: env('AWS_BUCKET'), + }, }, }, }, diff --git a/packages/providers/upload-cloudinary/README.md b/packages/providers/upload-cloudinary/README.md index e787ec000f..877e229082 100644 --- a/packages/providers/upload-cloudinary/README.md +++ b/packages/providers/upload-cloudinary/README.md @@ -16,15 +16,17 @@ See the [using a provider](https://docs.strapi.io/developer-docs/latest/plugins/ module.exports = ({ env }) => ({ // ... upload: { - provider: 'cloudinary', - providerOptions: { - cloud_name: env('CLOUDINARY_NAME'), - api_key: env('CLOUDINARY_KEY'), - api_secret: env('CLOUDINARY_SECRET'), - }, - actionOptions: { - upload: {}, - delete: {}, + config: { + provider: 'cloudinary', + providerOptions: { + cloud_name: env('CLOUDINARY_NAME'), + api_key: env('CLOUDINARY_KEY'), + api_secret: env('CLOUDINARY_SECRET'), + }, + actionOptions: { + upload: {}, + delete: {}, + }, }, }, // ... diff --git a/packages/providers/upload-local/README.md b/packages/providers/upload-local/README.md index 5da44d12dc..d4a3b28c5a 100644 --- a/packages/providers/upload-local/README.md +++ b/packages/providers/upload-local/README.md @@ -6,15 +6,21 @@ This provider has only one parameter: `sizeLimit`. **Example** -`./extensions/upload/config/settings.json` +`./config/plugins.js` -```json -{ - "provider": "local", - "providerOptions": { - "sizeLimit": 100000 - } -} +```js +module.exports = ({ env }) => ({ + // ... + upload: { + config: { + provider: 'local', + providerOptions: { + sizeLimit: 100000, + }, + }, + }, + // ... +}); ``` The `sizeLimit` parameter must be a number. Be aware that the unit is in bytes, and the default is 1000000. When setting this value high, you should make sure to also configure the body parser middleware `maxFileSize` so the file can be sent and processed. Read more [here](https://docs.strapi.io/developer-docs/latest/plugins/upload.html#configuration) diff --git a/packages/providers/upload-rackspace/README.md b/packages/providers/upload-rackspace/README.md index bd4740c8a7..e646728d56 100644 --- a/packages/providers/upload-rackspace/README.md +++ b/packages/providers/upload-rackspace/README.md @@ -14,12 +14,14 @@ See the [using a provider](https://docs.strapi.io/developer-docs/latest/plugins/ module.exports = ({ env }) => ({ // ... upload: { - provider: 'rackspace', - providerOptions: { - username: env('RACKSPACE_USERNAME'), - apiKey: env('RACKSPACE_KEY'), - region: env('RACKSPACE_REGION'), - container: env('RACKSPACE_CONTAINER'), + config: { + provider: 'rackspace', + providerOptions: { + username: env('RACKSPACE_USERNAME'), + apiKey: env('RACKSPACE_KEY'), + region: env('RACKSPACE_REGION'), + container: env('RACKSPACE_CONTAINER'), + }, }, }, // ...