Skip to content
Public Slack organizations made easy
JavaScript CSS Makefile
Branch: master
Clone or download
Pull request Compare This branch is 185 commits behind rauchg:master.
Latest commit 04927df Sep 21, 2015
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Add openshift support Aug 20, 2015
lib Merge pull request rauchg#61 from Graham42/bug/relative_paths Sep 21, 2015
test Merge remote-tracking branch 'upstream/master' into not-ok May 7, 2015
.gitignore initial release Jan 26, 2015
.npmignore initial release Jan 26, 2015
Dockerfile
History.md Release 0.5.1 Jun 23, 2015
Makefile Makefile now builds changed files in lib Jul 24, 2015
Procfile Move make from Procfile to postinstall Jul 24, 2015
Readme.md Merge pull request rauchg#88 from balupton/feature-openshift Sep 21, 2015
app.json use SLACK_CHANNELS instead of SLACK_CHANNEL on Heroku Jul 8, 2015
package.json

Readme.md

slackin

A little server that enables public access to a Slack server. Like Freenode, but on Slack.

It provides

  • A landing page you can point users to fill in their emails and receive an invite (https://slack.yourdomain.com)
  • An <iframe> badge to embed on any website that shows connected users in realtime with socket.io.
  • A SVG badge that works well from static mediums (like GitHub README pages)

Read more about the motivations and history behind Slackin.

How to use

Server

Heroku

Deploy

OpenShift

Follow these instructions.

Custom

Install it and launch it on your server:

$ npm install -g slackin
$ slackin "your-slack-subdomain" "your-slack-token"

You can find your API token at api.slack.com/web – note that the user you use to generate the token must be an admin. You need to create a dedicated @slackin-inviter user (or similar), mark that user an admin, and use a token from that dedicated admin user.

The available options are:

Usage: slackin [options] <slack-subdomain> <api-token>

Options:

  -h, --help               output usage information
  -V, --version            output the version number
  -p, --port <port>        Port to listen on [$PORT or 3000]
  -c, --channels [<chan>]  One or more comma-separated channel names to allow single-channel guests [$SLACK_CHANNELS]
  -i, --interval <int>     How frequently (ms) to poll Slack [$SLACK_INTERVAL or 1000]
  -s, --silent             Do not print out warns or errors

Important: if you use Slackin in single-channel mode, you'll only be able to invite as many external accounts as paying members you have times 5. If you are not getting invite emails, this might be the reason. Workaround: sign up for a free org, and set up Slackin to point to it (all channels will be visible).

Realtime Badge

<script async defer src="https://slack.yourdomain.com/slackin.js"></script>

or for the large version, append ?large:

<script async defer src="https://slack.yourdomain.com/slackin.js?large"></script>

SVG

<img src="https://slack.yourdomain.com/badge.svg">

Done in Markdown this looks like:

[![Slack Status](https://slack.yourdomain.com/badge.svg)](https://yourdomain.com)

Landing page

Point to https://slack.yourdomain.com.

Note: the image for the logo of the landing page is retrieved from the Slack API. If your organization doesn't have one configured, it won't be shown.

API

Requiring slackin as a module will return a Function that creates a HTTP.Server instance that you can manipulate.

require('slackin')({
  token: 'yourtoken', // required
  interval: 1000,
  org: 'your-slack-subdomain', // required
  channels: 'channel,channel,...' // for single channel mode
  silent: false // suppresses warnings
}).listen(3000);

This will show response times from Slack and how many online users you have on the console.

By default logging is enabled.

Developing

Slackin's server side code is written in ES6. It uses babel to transpile the ES6 code to a format node understands. After cloning Slackin, you should install the prerequisite node libraries with npm:

$ npm install

After the libraries install, the postinstall script will run make to invoke babel on the source. It is important to run make manually after updating any files in lib/ to update the versions in node/.

Credits

  • The SVG badge generation was taken from the excellent shields project.
  • The button CSS is based on github-buttons.

License

MIT

You can’t perform that action at this time.