2021-10-28 14:55:51 +00:00
|
|
|
---
|
2021-11-19 07:40:29 +00:00
|
|
|
title: Overview
|
2021-10-28 14:55:51 +00:00
|
|
|
nav:
|
|
|
|
title: Plugins
|
|
|
|
order: 4
|
|
|
|
---
|
|
|
|
|
2021-10-31 01:44:52 +00:00
|
|
|
# Plugins
|
2021-10-28 14:55:51 +00:00
|
|
|
|
2021-11-19 07:40:29 +00:00
|
|
|
## Plugin Manager <Badge>Not Available</Badge>
|
|
|
|
|
|
|
|
<Alert title="Note">
|
|
|
|
It is not yet possible to manage plugins via the CLI, this part is still under design and development.
|
|
|
|
</Alert>
|
2021-10-31 01:44:52 +00:00
|
|
|
|
|
|
|
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-11-19 07:40:29 +00:00
|
|
|
# Download plugins, which can be activated quickly with the --enable argument
|
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-11-19 07:40:29 +00:00
|
|
|
Core plugins
|
|
|
|
|
|
|
|
- [@nocobase/plugin-collections](plugins/collections)
|
|
|
|
Provides an HTTP API for managing data tables and fields
|
|
|
|
- [@nocobase/plugin-permissions](plugins/permissions)
|
|
|
|
Permissions module (server-side)
|
|
|
|
- [@nocobase/plugin-users](plugins/users)
|
|
|
|
User module (server-side)
|
|
|
|
- [@nocobase/plugin-client](plugins/client)
|
|
|
|
Client-side plugin that provides a GUI for the server and connects @nocobase/server to @nocobase/client
|
|
|
|
- [@nocobase/plugin-ui-schema](plugins/ui-schema)
|
|
|
|
Store the Schema of the client SchemaComponent on the server side for on-demand dynamic output
|
|
|
|
- [@nocobase/plugin-ui-router](plugins/ui-router)
|
|
|
|
Client-side routing table, storing client-side route config on the server side for on-demand dynamic output
|
|
|
|
|
|
|
|
Other plugins
|
|
|
|
|
|
|
|
- [@nocobase/plugin-action-logs](plugins/action-logs)
|
|
|
|
Action logs
|
|
|
|
- [@nocobase/plugin-file-manager](plugins/file-manager)
|
|
|
|
File Manager
|
|
|
|
- [@nocobase/plugin-china-region](plugins/china-region)
|
|
|
|
China region, field extensions
|
|
|
|
- [@nocobase/plugin-export](plugins/export)
|
|
|
|
Export plugin
|
|
|
|
- [@nocobase/plugin-system-settings](plugins/system-settings)
|
|
|
|
System information configuration
|
|
|
|
- [@nocobase/plugin-multi-apps](plugins/multi-apps)
|
|
|
|
Dynamic multi-apps, easy SaaS plugin
|
|
|
|
- [@nocobase/plugin-notifications](plugins/notifications)
|
|
|
|
Notifications module (half-finished), only supports emailing for now, no visual interface
|
|
|
|
- [@nocobase/plugin-automations](plugins/automations)
|
|
|
|
Automation module (temporarily unavailable)
|