Skip to content

Slack bot who lives in my basement, written in NodeJS

Notifications You must be signed in to change notification settings

DallasEpperson/orion-bot

Repository files navigation

Orion

Orion is a Slack bot who lives in my basement. He is extendable via plugins, making it easy to add new features.

Setup

  • Have a working Node.js environment
  • Have a slack workspace
  • Set up a Real-Time Messaging API in Slack (possibly called Custom Integrations / Bots depending on lunar cycle)
  • Take note of API Token

Installing

  • Clone the repo
  • npm install
  • Copy example.env to .env and replace Signing Secret, Bot Token, and App Token.
  • Find any plugins/*/*.exampleconfig.json files and fix accordingly.
  • node app.js

Usage

Orion will respond when he is @mentioned, or to any direct messages.

Plugins

  • Dark Sky - Adds Dark Sky weather forecasting to Orion
  • Public IP - Adds ability for Orion to report its public IP address
  • QRZ.com - Adds ability to query amateur radio callsign info
  • URL - Adds ability to query for known URLs
  • weeWX - Adds ability to pull current and past weather information from weeWX into Orion

Running on system startup (as a service)

Linux

  • Modify orion-bot.service to point to your particular paths
  • Copy orion-bot.service to /etc/systemd/system/orion-bot.service
  • Start via systemctl start orion-bot
  • Enable run on startup via systemctl enable orion-bot
  • See output logs via tail -f /var/log/syslog

About

Slack bot who lives in my basement, written in NodeJS

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published