Update docs, remove hard coded matrix_domain

This commit is contained in:
Yannick Goossens 2021-03-15 13:04:31 +01:00
parent 7d6bf446a3
commit bfe0ca6cf8

View file

@ -42,23 +42,23 @@ matrix_bot_go_neb_enabled: true
# You need at least 1 client. # You need at least 1 client.
matrix_bot_go_neb_clients: matrix_bot_go_neb_clients:
- UserID: "@goneb:localhost" - UserID: "@goneb:{{ matrix_domain }}"
AccessToken: "MDASDASJDIASDJASDAFGFRGER" AccessToken: "MDASDASJDIASDJASDAFGFRGER"
DeviceID: "DEVICE1" DeviceID: "DEVICE1"
HomeserverURL: "{{ matrix_homeserver_container_url }}" HomeserverURL: "{{ matrix_homeserver_container_url }}"
Sync: true Sync: true
AutoJoinRooms: true AutoJoinRooms: true
DisplayName: "Go-NEB!" DisplayName: "Go-NEB!"
AcceptVerificationFromUsers: [":localhost:8008"] AcceptVerificationFromUsers: [":{{ matrix_domain }}"]
- UserID: "@another_goneb:localhost" - UserID: "@another_goneb:{{ matrix_domain }}"
AccessToken: "MDASDASJDIASDJASDAFGFRGER" AccessToken: "MDASDASJDIASDJASDAFGFRGER"
DeviceID: "DEVICE2" DeviceID: "DEVICE2"
HomeserverURL: "{{ matrix_homeserver_container_url }}" HomeserverURL: "{{ matrix_homeserver_container_url }}"
Sync: false Sync: false
AutoJoinRooms: false AutoJoinRooms: false
DisplayName: "Go-NEB!" DisplayName: "Go-NEB!"
AcceptVerificationFromUsers: ["^@admin:localhost:8008$"] AcceptVerificationFromUsers: ["^@admin:{{ matrix_domain }}"]
# Optional, for use with the github_cmd, github_webhooks or jira services # Optional, for use with the github_cmd, github_webhooks or jira services
matrix_bot_go_neb_realms: matrix_bot_go_neb_realms:
@ -70,7 +70,7 @@ matrix_bot_go_neb_realms:
matrix_bot_go_neb_sessions: matrix_bot_go_neb_sessions:
- SessionID: "your_github_session" - SessionID: "your_github_session"
RealmID: "github_realm" RealmID: "github_realm"
UserID: "@YOUR_USER_ID:localhost" # This needs to be the username of the person that's allowed to use the !github commands UserID: "@YOUR_USER_ID:{{ matrix_domain }}" # This needs to be the username of the person that's allowed to use the !github commands
Config: Config:
# Populate these fields by generating a "Personal Access Token" on github.com # Populate these fields by generating a "Personal Access Token" on github.com
AccessToken: "YOUR_GITHUB_ACCESS_TOKEN" AccessToken: "YOUR_GITHUB_ACCESS_TOKEN"
@ -84,13 +84,13 @@ matrix_bot_go_neb_sessions:
matrix_bot_go_neb_services: matrix_bot_go_neb_services:
- ID: "echo_service" - ID: "echo_service"
Type: "echo" Type: "echo"
UserID: "@goneb:localhost" UserID: "@goneb:{{ matrix_domain }}"
Config: {} Config: {}
# Can be obtained from https://developers.giphy.com/dashboard/ # Can be obtained from https://developers.giphy.com/dashboard/
- ID: "giphy_service" - ID: "giphy_service"
Type: "giphy" Type: "giphy"
UserID: "@goneb:localhost" # requires a Syncing client UserID: "@goneb:{{ matrix_domain }}" # requires a Syncing client
Config: Config:
api_key: "qwg4672vsuyfsfe" api_key: "qwg4672vsuyfsfe"
use_downsized: false use_downsized: false
@ -98,7 +98,7 @@ matrix_bot_go_neb_services:
# This service has been dead for over a year :/ # This service has been dead for over a year :/
- ID: "guggy_service" - ID: "guggy_service"
Type: "guggy" Type: "guggy"
UserID: "@goneb:localhost" # requires a Syncing client UserID: "@goneb:{{ matrix_domain }}" # requires a Syncing client
Config: Config:
api_key: "2356saaqfhgfe" api_key: "2356saaqfhgfe"
@ -108,31 +108,32 @@ matrix_bot_go_neb_services:
# 'Search the entire web' and 'Image search' enabled for best results # 'Search the entire web' and 'Image search' enabled for best results
- ID: "google_service" - ID: "google_service"
Type: "google" Type: "google"
UserID: "@goneb:localhost" # requires a Syncing client UserID: "@goneb:{{ matrix_domain }}" # requires a Syncing client
Config: Config:
api_key: "AIzaSyA4FD39m9" api_key: "AIzaSyA4FD39m9"
cx: "AIASDFWSRRtrtr" cx: "AIASDFWSRRtrtr"
# Get a key via https://api.imgur.com/oauth2/addclient # Get a key via https://api.imgur.com/oauth2/addclient
# Select "oauth2 without callback url" and use the clientid as api_key value # Select "oauth2 without callback url"
- ID: "imgur_service" - ID: "imgur_service"
Type: "imgur" Type: "imgur"
UserID: "@imgur:localhost" # requires a Syncing client UserID: "@imgur:{{ matrix_domain }}" # requires a Syncing client
Config: Config:
api_key: "AIzaSyA4FD39m9" client_id: "AIzaSyA4FD39m9"
client_secret: "AIzaSyA4FD39m9"
- ID: "wikipedia_service" - ID: "wikipedia_service"
Type: "wikipedia" Type: "wikipedia"
UserID: "@goneb:localhost" # requires a Syncing client UserID: "@goneb:{{ matrix_domain }}" # requires a Syncing client
Config: Config:
- ID: "rss_service" - ID: "rss_service"
Type: "rssbot" Type: "rssbot"
UserID: "@another_goneb:localhost" UserID: "@another_goneb:{{ matrix_domain }}"
Config: Config:
feeds: feeds:
"http://lorem-rss.herokuapp.com/feed?unit=second&interval=60": "http://lorem-rss.herokuapp.com/feed?unit=second&interval=60":
rooms: ["!qmElAGdFYCHoCJuaNt:localhost"] rooms: ["!qmElAGdFYCHoCJuaNt:{{ matrix_domain }}"]
must_include: must_include:
author: author:
- author1 - author1
@ -146,17 +147,17 @@ matrix_bot_go_neb_services:
- ID: "github_cmd_service" - ID: "github_cmd_service"
Type: "github" Type: "github"
UserID: "@goneb:localhost" # requires a Syncing client UserID: "@goneb:{{ matrix_domain }}" # requires a Syncing client
Config: Config:
RealmID: "github_realm" RealmID: "github_realm"
# Make sure your BASE_URL can be accessed by Github! # Make sure your BASE_URL can be accessed by Github!
- ID: "github_webhook_service" - ID: "github_webhook_service"
Type: "github-webhook" Type: "github-webhook"
UserID: "@another_goneb:localhost" UserID: "@another_goneb:{{ matrix_domain }}"
Config: Config:
RealmID: "github_realm" RealmID: "github_realm"
ClientUserID: "@YOUR_USER_ID:localhost" # needs to be an authenticated user so Go-NEB can create webhooks. Check the UserID field in the github_realm in matrix_bot_go_neb_sessions. ClientUserID: "@YOUR_USER_ID:{{ matrix_domain }}" # needs to be an authenticated user so Go-NEB can create webhooks. Check the UserID field in the github_realm in matrix_bot_go_neb_sessions.
Rooms: Rooms:
"!someroom:id": "!someroom:id":
Repos: Repos:
@ -173,7 +174,7 @@ matrix_bot_go_neb_services:
- ID: "slackapi_service" - ID: "slackapi_service"
Type: "slackapi" Type: "slackapi"
UserID: "@slackapi:localhost" UserID: "@slackapi:{{ matrix_domain }}"
Config: Config:
Hooks: Hooks:
"hook1": "hook1":
@ -182,7 +183,7 @@ matrix_bot_go_neb_services:
- ID: "alertmanager_service" - ID: "alertmanager_service"
Type: "alertmanager" Type: "alertmanager"
UserID: "@alertmanager:localhost" UserID: "@alertmanager:{{ matrix_domain }}"
Config: Config:
# This is for information purposes only. It should point to Go-NEB path as follows: # This is for information purposes only. It should point to Go-NEB path as follows:
# `/services/hooks/<base64 encoded service ID>` # `/services/hooks/<base64 encoded service ID>`