You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/en/Decentralized_message_board_development/3.Implement_your_own_message_service.md
+32
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,38 @@ Development phase: Complete the front-end and service-side development under the
37
37
Publishing stage: Package the file resources required by the front-end and service-side, depending on the configuration of cyfs.config.json.
38
38
Installation and running phases: DEC Service starts, runs and terminates on OOD, depending on the configuration of service_package.cfg.
39
39
40
+
### cyfs.config.json
41
+
42
+
1. config_version: the version number of the configuration file
43
+
2. app_name: The name entered in `cyfs create -n` is also the name of the app. The app names of the same owner cannot be the same. Support non-ASCII characters such as Chinese, the name will be displayed on the app store and app management interface
44
+
3. version: Indicates the `current version` of the App. When cyfs deploy is executed, the current version of the App will be packaged and deployed. After deployment, the third digit of the version will be automatically incremented by one as the new current version
45
+
4. description: The description of the App. Each time it is deployed, the description text filled in here will be updated to the App object and displayed on the App Store.
46
+
5. icon: App icon, only supports cyfs link. Update every time you deploy, display on the App Store and App Admin UI
47
+
6. service: Configure Dec App Service related packaging and running configuration, the details are as follows
48
+
- pack: Indicates which directories need to be packaged when packaging the Service
49
+
- type: Specifies the type of service, currently supports "node" and "rust"
50
+
When specified as "node", the package directory of the service, the cyfs directory, and the package.json file will be copied to the ${dist}/service/${target} directory
51
+
When it is specified as "rust", only the package directory of the service is copied to ${dist}/service, and the compilation of the service needs to be manually performed by the user in advance
52
+
- dist_targets: Specifies which platforms the service supports. The default is the same as the platforms supported by ood. If the Dec App is installed on a platform that is supported by OOD but not supported by service, an installation failure error will be returned
53
+
- app_config: configure the run configuration of the service. You can configure a different run configuration for each platform by adding the [target_name]:[config_path] field. The default default indicates the default configuration used when there is no corresponding configuration for the platform
54
+
7. web: Configure the relevant packaging and runtime configuration of the Dec App Web section, as detailed below
55
+
- folder: The root directory for configuring the Dec App Web section
56
+
- entry: The file name of the configurable web home page, the current configuration modification is invalid, the home page file name must be index.html
57
+
8. dist: The name of the packaging temporary directory, the default is "dist". If the default value conflicts with other local directories, it can be changed to other non-conflicting directory names
58
+
9. owner_config: owner configuration file
59
+
10. ext_info: Other configurations unrelated to App deployment, installation, and running, generally related to App display. Details are as follows
60
+
- medias: Configure the media information related to the app, which is currently used in the DecApp details page of the app store
61
+
11. app_id: The app id calculated from owner id and app_name, cannot be modified by yourself. Anywhere in your code you need to use the Dec App Id, you need to use the ID shown here.
62
+
63
+
### service_package.cfg
64
+
65
+
1. id: identification
66
+
2. version: version number
67
+
3. install: install script
68
+
4. start: start the script
69
+
5. stop: stop the script
70
+
6. status: run the status query script
71
+
40
72
## file structure
41
73
42
74
In the project root directory, there are 4 folders and 11 files:
0 commit comments