lubiland
/
heimdall
Archived
1
0
Fork 0
Code Issues 14 Pull Requests Releases Wiki Activity
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
51 Commits
2 Branches
0 Tags
85 KiB
JavaScript 100%
 
Go to file
Peery df4a12fb90 Fixed handling of non-command messages - fixes 
Added if's when the regex for command detection returns null and notify
the caller via either a failed promise or a null return.
projects implement modular commands - fixes
.gitignore initial config support
LICENSE.md add license file
README.md Added short bot credentials setup guide
commands.js Fixed handling of non-command messages - fixes
config.sample.yaml create matrix config subsection
index.js Fixed handling of non-command messages - fixes
package.json initial ssh support - closes
rebuild.sh add placeholder notice to rebuild.sh
remoteExec.js make config global with global.config

README.md

Heimdall

Description

Heimdall is a matrix bot supposed to control and manage services and containers by simple text commands. It is a convenience tool for the own self-hosting empire.

Setup the bot credentials

  1. Create or get access to a matrix account to use as the bot.
  2. Acquire the access token and user id. You can do this in riot by going into the settings and scrolling down to the very end.
  3. Copy config.sample.yaml and name the copy config.yaml.
  4. Replace the placeholder values with your own:
    • Replace the baseurl value with the base url of your home server (e.g. https://example.org).
    • Replace the access token with your own.
    • Replace the user id with your own.