Getting Started
Updated 789 Days AgoPublic

Pre-setup

  1. Create a directory for the bot: mkdir phabulous.
  2. Create a configuration file config/main.yml using the one on the repository as a template. We will be replacing parts of it in this guide.

Obtain a Conduit token

NOTE: It's usually a good idea to have a separate bot user for Phabulous. You can create one at: https://such.phabricator.wow/people/new/bot/ (Replace with your install's URL). When doing this, make sure the bot has enough permissions to view all required objects.
  1. Go to https://such.phabricator.wow/settings/panel/apitokens/ (replace with your install's actual URL).
  2. Click generate token and copy it.
  3. Set the conduit.token key on the configuration file.

Obtain a Slack API token

  1. Pick a username for your bot (usually phabulous).
  2. Go to https://replaceme.slack.com/services/new/bot and create the bot user:
  3. Set a profile picture (like this one: F5115)
  4. Replace the slack.username and slack.token keys on the configuration file with the bot's username and token.

Installing

  1. Download the latest stable release for your OS from the releases page and save it in the root of the directory created above.
  2. Start the server: ./phabulous serve.
  3. If everything is working fine, add an entry to your Phabricator's config to call Phabulous' event webhook. The URL should be the address and port of the server you are running the bot in. Example for bot running in the same server as Phabricator:
//...
"feed.http-hooks": [
    "http://localhost:8085/v1/feed/receive"
]
//...

Post-setup

  • After starting the bot, invite the bot to channels where you want it to be active and listening for commands.
  • Perform an action to confirm that Phabricator is forwarding feed events to Phabulous.
  • Keep customizing main.yml to meet your needs.
Last Author
etcinit
Projects
None
Subscribers
None