Skip to content

Commit

Permalink
πŸ“ docs: update README of configuration options object
Browse files Browse the repository at this point in the history
  • Loading branch information
david-vaclavek committed Oct 11, 2023
1 parent 44131bc commit 7b9a07a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,23 @@ npx @localazy/strapi-plugin

Note: Localazy plugin requires an updated Webpack configuration of your Strapi project. Follow the instructions in the console output during the installation process. Steps are also available in the [Install plugin via NPM](https://localazy.com/docs/strapi/strapi-plugin-introduction-installation#install-plugin-via-npm) section of the Localazy Docs.

## Configuration

Additional configuration object may be provided in the `plugins.js` file. The following options are available:

```js
localazy: {
config: {
/**
* both options may help guard against DoS attacks
* if `populateMaxDepth` < 5; the Localazy Strapi Plugin may not work as expected
*/
populateDefaultDepth?: number, // default is 5
populateMaxDepth?: number, // default is 10
},
},
```

## Additional Resources

- Localazy Docs: [Introduction to Strapi](https://localazy.com/docs/strapi/strapi-plugin-introduction-installation)
Expand Down

0 comments on commit 7b9a07a

Please sign in to comment.