Skip to content

Commit

Permalink
docs: content tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
paulrobertlloyd committed Nov 17, 2024
1 parent 4dab718 commit 716ab71
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down

0 comments on commit 716ab71

Please sign in to comment.