Strapi Plugin Config Sync

Overview

The Config Sync plugin for Strapi allows users to export and import configuration data, such as admin roles, user roles, admin settings, and I18n locales. This data can be easily tracked and migrated across different environments, ensuring that the code relies on consistent data. The plugin provides a command line interface (CLI) and a graphical user interface (GUI) for syncing the configuration.

Features

• 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 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

Installation

1. Install the plugin in your Strapi project.
2. Add the export path to the watchIgnoreFiles list in the config/admin.js file.
3. Rebuild the admin UI and restart Strapi.

To start tracking config changes, make the first export to the /config/sync directory using either the CLI or the Strapi admin panel.

Summary

The Config Sync plugin for Strapi provides a convenient solution for exporting and importing configuration data in order to maintain consistency across environments. With support for partial sync, custom types, and exclusion, it offers flexibility in managing the sync process. By utilizing the CLI and GUI, users can easily track and inspect changes in the configuration.