Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork40
♻️ CLI & GUI for continuous migration of config data across environments
License
pluginpal/strapi-plugin-config-sync
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
This plugin is a multi-purpose tool to manage your Strapi database records through JSON files. Mostly used to version controlconfig data for automated deployment, automated tests and data sharing for collaboration purposes.
- CLI -
config-sync
CLI for syncing the config from the command line - GUI - Settings page for syncing the config in Strapi admin
- Partial sync - Import or export only specific portions of config
- Custom types - Include your custom collection types in the sync process
- Import on bootstrap - Easy automated deployment with
importOnBootstrap
- Exclusion - Exclude single config entries or all entries of a given type
- Diff viewer - A git-style diff viewer to inspect the config changes
Read the Getting Started tutorial or follow the steps below:
# using yarnyarn add strapi-plugin-config-sync# using npmnpm install strapi-plugin-config-sync --save
Add the export path to thewatchIgnoreFiles
list in theconfig/admin.js
file.This way your app won't reload when you export the config in development.
module.exports = ({ env }) => ({ // ... watchIgnoreFiles: [ '**/config/sync/**', ],});
After successful installation you have to rebuild the admin UI so it'll include this plugin. To rebuild and restart Strapi run:
# using yarnyarn buildyarn develop# using npmnpm run buildnpm run develop
TheConfig Sync plugin should now appear in theSettings section of your Strapi app.
To start tracking your config changes you have to make the first export. This will dump all your configuration data to the/config/sync
directory. You can export either throughthe CLI orStrapi admin panel
Enjoy 🎉
See our dedicatedrepository for all of PluginPal's documentation, or view the Config Sync documentation live:
Feel free to fork and make a pull request of this plugin. All the input is welcome!
Give a star if this project helped you.
- For general help using Strapi, please refer tothe official Strapi documentation.
- For support with this plugin you can DM me in the Strapi Discordchannel.
About
♻️ CLI & GUI for continuous migration of config data across environments
Topics
Resources
License
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.