Skip to content

Commit

Permalink
Update instructions, env, and startup for Heimdall
Browse files Browse the repository at this point in the history
Include updated env vars for Matrix usage.
  • Loading branch information
Shadowfiend committed Aug 16, 2022
1 parent 75e071d commit bc7dca3
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ available, etc!
[hubot]: http://hubot.github.com
[generator-hubot]: https://github.com/github/generator-hubot

Heimdall is the name of the Hubot we run in production.
Heimdall can be summoned by name (`@Heimdall`) or via his alias (`\`).
Valkyrie is the name of the Hubot we run in production.
Valkyrie can be summoned by name (`@Valkyrie`) or via her alias (`\`).

## Running Locally

Valkyrie is the name of the Hubot we run when working locally on Hubot.
Valkyrie can be summoned by name (`@Valkyrie`) or via her alias (`?`).
Heimdall is the name of the Hubot we run when working locally on Hubot.
Heimdall can be summoned by name (`@Heimdall`) or via his alias (`?`).

This allows us to run both production and development Hubots at the same time
using the Flowdock adapter, and clearly differeniate which robot we are calling.
Expand All @@ -38,23 +38,23 @@ Install npm if you don't already have it:
brew install npm
```

You can start Valkyrie locally by running:
You can start Heimdall locally by running:

```
$ bin/valkyrie
$ bin/heimdall
```

You'll see some start up output (it can get pretty verbose - `npm i` is run at
this time) and a prompt:

`valkyrie>`
`heimdall>`

Then you can interact with Valkyrie. If you don't know where to start, try
Then you can interact with Heimdall. If you don't know where to start, try
typing `?help`:

```
valkyrie> ?help
valkyrie> Shell: I can do a lot of things! Which would you like to know more about? You can say:
heimdall> ?help
heimdall> Shell: I can do a lot of things! Which would you like to know more about? You can say:
```

(followed by a list of available commands)
Expand All @@ -70,7 +70,7 @@ Add the following to the "configurations" list in your VS Code's `launch.json`:
{
"type": "node",
"request": "launch",
"name": "Launch Valkyrie Shell Adapter",
"name": "Launch Heimdall Shell Adapter",
"program": "${workspaceFolder}/node_modules/hubot/bin/hubot.js",
"args": ["--alias", "?", "--name", "valkyrie"],
"runtimeArgs": ["-r", "coffeescript/register"],
Expand All @@ -79,7 +79,7 @@ Add the following to the "configurations" list in your VS Code's `launch.json`:
{
"type": "node",
"request": "launch",
"name": "Launch Valkyrie Flowdock Adapter",
"name": "Launch Heimdall Flowdock Adapter",
"program": "${workspaceFolder}/node_modules/hubot/bin/hubot.js",
"args": ["--alias", "?", "--name", "valkyrie", "-a", "reload-flowdock"],
"runtimeArgs": ["-r", "coffeescript/register"],
Expand All @@ -88,7 +88,7 @@ Add the following to the "configurations" list in your VS Code's `launch.json`:
```

You can then select either "Launch Valkyrie Shell Adapter" or "Launch Valkyrie
You can then select either "Launch Heimdall Shell Adapter" or "Launch Heimdall
Flowdock Adapter" (see [section on Adpaters](#adapters)) from the "Run" menu of
the debugging pane.

Expand Down
1 change: 1 addition & 0 deletions bin/heimdall
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ set -e

npm install
export PATH="node_modules/.bin:node_modules/hubot/node_modules/.bin:$PATH"
export HUBOT_MATRIX_USER="@heimdall:thesis.co"

exec node_modules/.bin/hubot --alias "?" --name "heimdall" "$@"
2 changes: 1 addition & 1 deletion env-var.list
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
HUBOT_MATRIX_PASSWORD=$HUBOT_MATRIX_PASSWORD
HUBOT_HOST=$HUBOT_HOST
GITHUB_CLIENT_ID=$GITHUB_CLIENT_ID
GITHUB_CLIENT_SECRET=$GITHUB_CLIENT_SECRET
HUBOT_FLOWDOCK_API_TOKEN=$HUBOT_FLOWDOCK_API_TOKEN
ZOOM_API_KEY=$ZOOM_API_KEY
ZOOM_API_SECRET=$ZOOM_API_SECRET
RELEASE_NOTIFICATION_ROOM=$RELEASE_NOTIFICATION_ROOM
Expand Down

0 comments on commit bc7dca3

Please sign in to comment.