ambiser
/
strapi-plugin-config-sync
mirror of https://github.com/boazpoolman/strapi-plugin-config-sync
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

pull/4/head
Boaz Poolman 2021-03-25 22:23:35 +01:00
parent 3466ac2e06
commit 85b08b5d2c
1 changed files with 23 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -23,6 +23,8 @@ Use `npm` or `yarn` to install and build the plugin.
Add the export path to the `watchIgnoreFiles` list in `config/server.js`. Add the export path to the `watchIgnoreFiles` list in `config/server.js`.
This way your app won't reload when you export the config in development. This way your app won't reload when you export the config in development.
##### `config/server.js`:
admin: { admin: {
auth: { auth: {
... ...
@ -33,42 +35,29 @@ This way your app won't reload when you export the config in development.
}, },
## Configuration ## Settings
Some settings for the plugin are able to be modified by creating a file `extensions/config-sync/config/config.json` and changing the following settings: Some settings for the plugin are able to be modified by creating a file `extensions/config-sync/config/config.json` and overwriting the default settings.
#### `destination` #### Default settings:
{
"destination": "extensions/config-sync/files/",
"minify": false,
"importOnBootstrap": false,
"include": [
"core-store",
"role-permissions",
"webhooks"
],
"exclude": []
}
The path for reading and writing the config JSON files. | Property | Default | Description |
| -------- | ------- | ----------- |
> `required:` NO | `type:` string | `default:` extensions/config-sync/files/ | destination | extensions/config-sync/files/ | The path for reading and writing the config JSON files. |
| minify | false | Setting to minify the JSON that's being exported. It defaults to false for better readability in git commits. |
#### `minify` | importOnBootstrap | false | Allows you to let the config be imported automaticly when strapi is bootstrapping (on `yarn start`). This setting should only be used in production, and should be handled very carefully as it can unintendedly overwrite the changes in your database. PLEASE USE WITH CARE. |
| include | ["core-store", "role-permissions", "webhooks"] | Configs you want to include. Allowed values: `core-store`, `role-permissions`, `webhooks`. |
Setting to minify the JSON that's being exported. It defaults to false for better readability in git commits. | exclude | [] | You might not want all your database config exported and managed in git. This settings allows you to add an array of config names which should not be tracked by the config-sync plugin. *Currently not working* |
> `required:` NO | `type:` bool | `default:` false
#### `importOnBootstrap`
Allows you to let the config be imported automaticly when strapi is bootstrapping (on `yarn start`). This setting should only be used in production, and should be handled very carefully as it can unintendedly overwrite the changes in your database.
PLEASE USE WITH CARE.
> `required:` NO | `type:` bool | `default:` false
#### `include`
Configs you want to include. Allowed values: `core-store`, `role-permissions`, `webhooks`. By default these are all enabled.
> `required:` NO | `type:` array | `default:` ["core-store", "role-permissions", "webhooks"]
#### `exclude`
You might not want all your database config exported and managed in git. This settings allows you to add an array of config names which should not be tracked by the config-sync plugin.
*Currently not working*
> `required:` NO | `type:` array | `default:` []
## Naming convention ## Naming convention
All the config files written in the file destination have the same naming convention. It goes as follows: All the config files written in the file destination have the same naming convention. It goes as follows: