-
Notifications
You must be signed in to change notification settings - Fork 1
/
Module.yaml
47 lines (47 loc) · 2.7 KB
/
Module.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
displayName: 'Telegram' # Display name for the module that will be displayed in the UI.
moduleName: 'telegram' # Module name that will be used to reference the module, and uniquely identify the module and their versions.
description: 'Send an alert or a notification to your Telegram.' # Module description that will be displayed in the UI.
versionName: 'v1.0.0' # Module version name that will be used to reference the module version, and uniquely identify the module version with a common name.
isPublic: true # Boolean value that indicates if the module is Public or Private.
categories: # Array of category that will be used to group the module in the UI.
- 'Alert'
type: 'Output' # Module type (Input, Processing, Output) that will be used to group the module in the UI.
image:
name: 'weevenetwork/telegram' # Image name from the docker registry.
tag: 'v1.0.0' # Image tag from the docker registry.
homepage: 'https://hub.docker.com/r/weevenetwork/telegram' # Image homepage from the docker registry.
repository: 'https://github.com/weeve-modules/telegram' # Repository URL to source code.
envs: # Array of environment variables that will be used to configure the module. Also used to show related fields on the UI.
- name: Token # name of the field to be displayed on the UI.
key: TOKEN # key to set in the environment variables.
description: Your Telegram bot token. # Description/helper text for the field.
value: 'Telegram_Bot_Token' # Value to be set in the environment variables.
type: 'text' # Type of the field. Possible values are: ['text', 'select', 'boolean', 'date', 'time', 'dateTime-local', 'number', 'multiple', 'CSV', 'file']
options: []
dependencies: [] # List of dependencies for the field. This field is only displayed if all the dependencies are met. If
- name: Chat ID
key: CHAT_ID
description: Your chat with the bot ID.
value: '1234567890'
type: 'text'
options: []
dependencies: []
- name: Message Label
key: MESSAGE_LABEL
description: Label in incoming data that holds the message to be sent.
value: 'alertMessage'
type: 'text'
options: []
dependencies: []
ports: []
envPorts: []
mounts: []
envMounts: []
devices: []
envDevices: []
tags: # Array of tags.
- 'Python'
- 'Output'
- 'Telegram'
- 'Bot'
icon: 'https://icons-020-demo.s3.eu-central-1.amazonaws.com/mi_telegram_output.png' # Icon URL that will be displayed in the UI.