You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
lub d1f8fcd28e initial permission supprt - fixes #10 7 vuotta sitten
projects implement room joins - closes #14 7 vuotta sitten
.gitignore initial config support 7 vuotta sitten
LICENSE.md add license file 7 vuotta sitten
README.md Added short bot credentials setup guide 7 vuotta sitten
commands.js Fixed handling of non-command messages - fixes #17 7 vuotta sitten
config.sample.yaml add databse to config.sample.yaml 7 vuotta sitten
dbtools.js initial permission supprt - fixes #10 7 vuotta sitten
index.js initial permission supprt - fixes #10 7 vuotta sitten
package.json add sqlite3 dependency 7 vuotta sitten
permissions.js initial permission supprt - fixes #10 7 vuotta sitten
remoteExec.js make config global with global.config 7 vuotta sitten

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.