digideskio / SlackEngine

Easy to use Slack Inviter running on Google App Engine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SlackEngine

Enable public access to your Slack server!

This is a (partial) clone of slackin for Google App Engine.

It provides

  • A landing page you can point users to fill in their emails and receive an invite
  • A free https://.appspot.com domain name!

Why App Engine?

Most slack inviters require you to run a server 24/7 to work. However, most users will visit the app once and never come back to it!

With App Engine, you can run your slack inviter with the App Engine free tier and never worry about it again! If your community starts to recieve a lot of traffic, App Engine will automatically scale to handle the load as well.

Slackin is my favorite slack inviter, but won't run on App Engine without using custom runtimes. So SlackEngine was born!

How to use

Setup

  • Install the App Engine SDK for PHP if you don't have it.
  • Visit the Google Developers Console, and create a new project.
  • Visit reCAPTCHA, and register your website.
  • Install reCAPTCHA library with Composer
    • run composer install
  • Edit app.yaml
    • Replace <PROJECT-ID> with the project ID you just created
  • Edit constants.php
    • Replace <YOUR-SUBDOMAIN> with your team's slack subdomain (i.e If your slack is myteam.slack.com, your subdomain is 'myteam').
    • Replace <YOUR-API-TOKEN> with your slack API 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 should create a dedicated @slackin-inviter user (or similar), mark that user an admin, and use a token from that dedicated admin user.
      • Replace <YOUR-reCAPTCHA-SECRET> with your reCAPTCHA secret
      • Replace <YOUR-reCAPTCHA-SITEKEY> with your reCAPTCHA site key
      • Replace <YOUR-NOTE> with a small note you want to display
  • Launch your app:
    • Run appcfg.py update app.yaml .

Credits

  • The look and feel is heavily inspired by slackin
  • The decision to use PHP was inspired by this gist

License

All code is licenced under Apache v2

Note: This is not an official Google product.

About

Easy to use Slack Inviter running on Google App Engine

License:Apache License 2.0


Languages

Language:PHP 84.0%Language:CSS 16.0%