lubiland

heimdall

Archived

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.

Go to file

Peery 6d28c7d0ad Added short bot credentials setup guide Wrote a step-by-step guide for bot credentials in README.md Also added a comment to explain the auto join being commented out.		7 years ago
.gitignore	initial config support	7 years ago
LICENSE.md	add license file	7 years ago
README.md	Added short bot credentials setup guide	7 years ago
config.sample.yaml	initial config support	7 years ago
index.js	Added short bot credentials setup guide	7 years ago
package.json	re-add js-yaml, cause lub messed up	7 years ago
rebuild.sh	add placeholder notice to rebuild.sh	7 years ago

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

Create or get access to a matrix account to use as the bot.
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.
Copy config.sample.yaml and name the copy config.yaml.
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.