2021-10-28 14:55:51 +00:00
|
|
|
---
|
|
|
|
|
title: Plugins
|
|
|
|
|
toc: menu
|
|
|
|
|
nav:
|
|
|
|
|
title: Plugins
|
|
|
|
|
order: 4
|
|
|
|
|
---
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
# Plugins
|
2021-10-28 14:55:51 +00:00
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
## Plugin Manager
|
|
|
|
|
|
|
|
|
|
Development can download, activate, disable, and remove plugins via the command line, which corresponds to
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
```bash
|
2021-10-31 01:44:52 +00:00
|
|
|
## Download plugins, which can be activated quickly with the --enable parameter
|
2021-10-28 14:55:51 +00:00
|
|
|
yarn nocobase pm:download <plugin-name> --enable
|
2021-10-31 01:44:52 +00:00
|
|
|
# Activate the plugin
|
2021-10-28 14:55:51 +00:00
|
|
|
yarn nocobase pm:enable <plugin-name>
|
2021-10-31 01:44:52 +00:00
|
|
|
# Disable the plugin
|
2021-10-28 14:55:51 +00:00
|
|
|
yarn nocobase pm:disable <plugin-name>
|
2021-10-31 01:44:52 +00:00
|
|
|
# Remove the plugin
|
2021-10-28 14:55:51 +00:00
|
|
|
yarn nocobase pm:remove <plugin-name>
|
|
|
|
|
```
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
## List of existing plugins
|
2021-10-28 14:55:51 +00:00
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
### @nocobase/plugin-collections datasheet configuration
|
2021-10-28 14:55:51 +00:00
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Provides an HTTP API for managing data tables and fields
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-permissions
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Permissions module
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-users
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
User module
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-system-settings
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Site information configuration
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-china-region
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Field extension, China region
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-file-manager
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Field extension, attachment field
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-action-logs
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Action logs
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-multi-apps
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Dynamic multi-apps, a simple SaaS
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-export
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Operation extensions, export
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-notifications
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Notifications module (half-baked), only supports emailing for now, no visual interface
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-automations
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Automation (not available at the moment)
|
2021-10-28 14:55:51 +00:00
|
|
|
|
|
|
|
|
### @nocobase/plugin-client
|
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Client-side plugin that provides visual configuration support for nocobase. Dependent plugins are.
|
2021-10-28 14:55:51 +00:00
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
- @nocobase/plugin-collections (required)
|
|
|
|
|
- @nocobase/plugin-permissions (required)
|
|
|
|
|
- @nocobase/plugin-users (required)
|
|
|
|
|
- @nocobase/plugin-system-settings (required)
|
|
|
|
|
- @nocobase/plugin-file-manager (required)
|
|
|
|
|
- @nocobase/plugin-china-region (optional)
|
|
|
|
|
- @nocobase/plugin-action-logs (optional)
|
2021-10-28 14:55:51 +00:00
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
Several components are included.
|
2021-10-28 14:55:51 +00:00
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
- Store client ui-schema on the server side for on-demand dynamic output
|
|
|
|
|
- Store client-side ui-router on the server side for on-demand dynamic output
|
|
|
|
|
- Provide static server support for app dist, allowing configuration of app dist paths
|
|
|
|
|
- Provide initial demo data import support for nocobase installation, configurable via importData
|
|
|
|
|
- Provide visualization support for collections
|
