aboutsummaryrefslogtreecommitdiffstats
path: root/docs/configuration.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration.md')
-rw-r--r--docs/configuration.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index a53c99d..8dff91b 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,6 +1,6 @@
1# Integration Config 1# Integration Config
2 2
3A [Ferdi](https://ferdium.org) recipe is a node module. In order to learn more about node modules and their configuration check the official [Node.js documentation](https://nodejs.org/api/modules.html) / [npm package.json documentation](https://docs.npmjs.com/files/package.json). 3A [Ferdium](https://ferdium.org) recipe is a node module. In order to learn more about node modules and their configuration check the official [Node.js documentation](https://nodejs.org/api/modules.html) / [npm package.json documentation](https://docs.npmjs.com/files/package.json).
4 4
5## Table of Contents 5## Table of Contents
6 6
@@ -21,7 +21,7 @@ Display name of the service.
21 21
22`string` **version** _mandatory_<br /> 22`string` **version** _mandatory_<br />
23Version number. Will be used for auto updating the integrations. The version number must be in a semver compatible format: eg `1.0.0`. 23Version number. Will be used for auto updating the integrations. The version number must be in a semver compatible format: eg `1.0.0`.
24**important:** the version will be used to figure out if a new recipe update should be deployed to the user. If you make changes to a recipe, **always** increase the version number or Ferdi won't update your recipe. 24**important:** the version will be used to figure out if a new recipe update should be deployed to the user. If you make changes to a recipe, **always** increase the version number or Ferdium won't update your recipe.
25 25
26`string` **license**<br /> 26`string` **license**<br />
27The license of the integration. We prefer MIT, but here is a list of all the available SPDX licenses http://spdx.org/licenses/ 27The license of the integration. We prefer MIT, but here is a list of all the available SPDX licenses http://spdx.org/licenses/
@@ -33,10 +33,10 @@ Link to your Github, Gitlab or Bitbucket public repository. Not used in the appl
33The list of alternate names that this recipe can be called 33The list of alternate names that this recipe can be called
34 34
35`object` **config** _mandatory_<br /> 35`object` **config** _mandatory_<br />
36This is the Ferdi-specific integration config. 36This is the Ferdium-specific integration config.
37 37
38* `string` **serviceURL**<br/> 38* `string` **serviceURL**<br/>
39Defines the URL that should be loaded into the Ferdi webview. 39Defines the URL that should be loaded into the Ferdium webview.
40<br /><br /> 40<br /><br />
41If you want to load a simple URL like `https://www.messenger.com`, you can simply define it via the `serviceURL` parameter. If your service URL is team based, e.g. Slack or HipChat you can use `https://{teamId}.slack.com`. 41If you want to load a simple URL like `https://www.messenger.com`, you can simply define it via the `serviceURL` parameter. If your service URL is team based, e.g. Slack or HipChat you can use `https://{teamId}.slack.com`.
42<br /><br /> 42<br /><br />