diff --git a/docs/configuration/application.md b/docs/configuration/application.md index 48890680c..8fe845f7c 100644 --- a/docs/configuration/application.md +++ b/docs/configuration/application.md @@ -39,7 +39,7 @@ Defaults to `"[application.url]/micropub"`. A [MongoDB connection string](https://www.mongodb.com/docs/manual/reference/connection-string/). Used by features that require a database. > [!WARNING] -> This value may contain private information such as a username and password. It’s recommended that you store this value in an environment (or configuration) variable which can only be seen by you and the application. +> This value may contain private information such as a username and password. Store this value in an environment variable which can only be seen by you and the application. To use a specifically named database, include this in your path (the default database name is `indiekit`). For example, `mongodb://mongodb0.example.com:27017/custom-name`. diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 632a8b0ea..eff113b9c 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -26,7 +26,7 @@ Indiekit’s configuration file uses the following top-level properties: - and finally, each plug-in may accept its own configuration options, and these should be provided under a key with the plug-in’s name. > [!WARNING] - > Plug-ins may include options that require private information such as passwords or API keys to be given. It’s recommended that you store these values in environment (or configuration) variables which can only be seen by you and the application. + > Plug-ins may include options that require private information such as passwords or API keys to be given. Store these values in environment variables which can only be seen by you and the application. ## Example diff --git a/docs/development.md b/docs/development.md index af862a27d..13a02780f 100644 --- a/docs/development.md +++ b/docs/development.md @@ -84,7 +84,7 @@ Indiekit performs create, read, update and delete (CRUD) operations on files tha To use a GitHub repository as a content store, first create a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). -If you create a [fine-grained personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens), give it **Read and write** access to **Contents**, and set a reasonable expiration (e.g. 90 days). +If creating a [fine-grained personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens), ensure that permissions for your repository include **Read** access to **Metadata** and **Read and write** access to **Contents**. You should also set a reasonable expiration (e.g. 90 days). Add the following details to your `.env` file: diff --git a/docs/get-started.md b/docs/get-started.md index b2596acf7..969a5633d 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -108,7 +108,7 @@ If your host doesn’t manage starting and restarting a Node.js server, a proces ### 3. Add environment variables -Before you can use Indiekit, some extra configuration values that only you and your server can see need to be set. Look on your host for environment (or configuration) variables, and add the following values: +Before you can use Indiekit, some extra configuration values that only you and your server can see need to be set. Look on your host for environment variables, and add the following values: #### `SECRET`