Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(flags): add first stage of documentation
- Loading branch information
Niklas Kiefer
committed
Feb 13, 2019
1 parent
625bebb
commit bced176
Showing
3 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Flags :flags: | ||
|
||
Flags allow to disable several features inside the application. | ||
|
||
## Available flags | ||
|
||
Following flags are available: | ||
|
||
- `disable-plugins`: Disabling use of plugins | ||
- `disable-adjust-origin`: Disabling automatic adjustments to origin coordinates | ||
- `disable-cmmn`: Disabling `CMMN-Editor` | ||
- `disable-dmn`: Disabling `DMN-Editor` | ||
|
||
All flags are _not_ set per default. | ||
|
||
## Use a configuration file | ||
|
||
One way to use flags persistently is to create a `flags.json` configuration file inside your user directory. Just modify the configuration file inside your local `{APP_DIRECTORY}/resources` or `{USER_DATA_DIRECTORY}/resources` location. | ||
|
||
### BPMN-only mode example | ||
|
||
One example of using the flags is the BPMN-only mode. To disable the `CMMN-` and `DMN-Editor`, simply modify the `flags.json` configuration file with | ||
|
||
```js | ||
{ | ||
"disable-cmmn": true, | ||
"disable-dmn": true | ||
} | ||
``` | ||
|
||
![BPMN only mode](./bpmn-only.png) | ||
|
||
## Use the CLI | ||
|
||
Another way to enable feature toggles is simply using them while starting the application via command line on Windows and Linux. E.g. in the case of disabling the `DMN-Editor`, add the following argument to the start command: | ||
|
||
```sh | ||
$ camunda-modeler --disable-dmn | ||
``` |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.