imubot/docs/adapters/campfire.md

A simple helpful bot.

---
permalink: /docs/adapters/campfire/index.html
layout: docs
---

[Campfire](http://campfirenow.com/) is a web based chat application built by
[37signals](http://37signals.com). The Campfire adapter is one of the original
adapters in Mubot.

## Getting Started

You will need a Campfire account to start, which you can
[sign up for free](https://signup.37signals.com/campfire/free/signup/new).

Next, you will need to create a user on your Campfire account for your Mubot,
then give it access so it can join to your rooms. You will need to create a room
if you haven't already.

Mubot defaults to using its [shell](/docs/adapters/shell.md), so to use Campfire instead, you
can run mubot with `-a campfire`:

    % bin/mubot -a campfire

If you are deploying to Heroku or using foreman, you need to make
sure the mubot is called with `-a campfire` in the `Procfile`:

    web: bin/mubot -a campfire -n Mubot

## Configuring

The adapter requires the following environment variables.

* `MUBOT_CAMPFIRE_ACCOUNT`
* `MUBOT_CAMPFIRE_TOKEN`
* `MUBOT_CAMPFIRE_ROOMS`

### Campfire API Token

This can be found by logging in with your mubot's account click the **My Info**
link and make a note of the API token.

### Campfire Room IDs

If you join the rooms you want your mubot to join will see notice a numerical
ID for the room in the URL. Make a note of each ID for the rooms you want your
mubot to join.

### Campfire Account

This is simply the first part of the domain you visit for your Campfire
account. For example if your Campfire was at `mubot.campfirenow.com` your
subdomain is `mubot`. Make a note of the subdomain.

### Configuring the variables on Heroku

    % heroku config:set MUBOT_CAMPFIRE_TOKEN="..."

    % heroku config:set MUBOT_CAMPFIRE_ROOMS="123,321"

    % heroku config:set MUBOT_CAMPFIRE_ACCOUNT="..."

### Configuring the variables on UNIX

    % export MUBOT_CAMPFIRE_TOKEN="..."

    % export MUBOT_CAMPFIRE_ROOMS="123,321"

    % export MUBOT_CAMPFIRE_ACCOUNT="..."

### Configuring the variables on Windows

Using PowerShell:

    setx MUBOT_CAMPFIRE_TOKEN "..." /m

    setx MUBOT_CAMPFIRE_ROOMS "123,321" /m

    setx MUBOT_CAMPFIRE_ACCOUNT "..." /m