|
@@ -9,20 +9,35 @@ and
|
|
|
[Socket.io's slack page](http://socket.io/slack/).
|
|
|
|
|
|
[](https://heroku.com/deploy)
|
|
|
+[](https://azuredeploy.net/)
|
|
|
|
|
|
-## Setting
|
|
|
-fill out `config.js` as your infomation.
|
|
|
+## Settings
|
|
|
|
|
|
-* `community`: your community or team name to display on join page.
|
|
|
-* `slackUrl` : your slack team url (ex: socketio.slack.com)
|
|
|
-* `slacktoken` : access token of slack.
|
|
|
- You can generate it in <https://api.slack.com/web#auth>.
|
|
|
- **You should generate the token in admin user, not owner.**
|
|
|
- If you generate the token in owner user, `missing_scope` error will be occurred.
|
|
|
-* `inviteToken`: an optional security measure - if it is set, then that token will be required to get invited.
|
|
|
-* `locale`: application language (currently `en`, `de`, `es`, `fr`, `pt`, `pt-BR`, `zh-CN`, `zh-TW`, `ja` and `ko` available).
|
|
|
+##### Local
|
|
|
|
|
|
- You can test your token via curl:
|
|
|
+Create a file in the root called `.env` with the following key/value pairs. `.env`
|
|
|
+files are added to the `.gitignore`.
|
|
|
+
|
|
|
+- `COMMUNITY_NAME` : Your community or team name to display on join page.
|
|
|
+- `SLACK_URL` : Your slack team url (ex: socketio.slack.com)
|
|
|
+- `SLACK_TOKEN` : Your access token for slack.
|
|
|
+ - You can generate it in <https://api.slack.com/web#auth>.
|
|
|
+ **You should generate the token as an admin user, not owner.**
|
|
|
+ If you generate the token in owner user, a `missing_scope` error may occur.
|
|
|
+- `INVITE_TOKEN`: An optional security measure - if it is set, then that token will be required to get invited.
|
|
|
+- `LOCALE`: Application language (currently `en`, `de`, `es`, `fr`, `pt`, `zh-CN`, `zh-TW`, `ja` and `ko` available).
|
|
|
+
|
|
|
+**Sample**
|
|
|
+
|
|
|
+```
|
|
|
+COMMUNITY_NAME=socketio
|
|
|
+SLACK_URL=socketio.slack.com
|
|
|
+SLACK_TOKEN=ffsdf-5411524512154-16875416847864648976-45641654654654654-444334f43b34566f
|
|
|
+INVITE_TOKEN=abcdefg
|
|
|
+LOCAL=en
|
|
|
+```
|
|
|
+
|
|
|
+You can test your token via curl:
|
|
|
|
|
|
```shell
|
|
|
curl -X POST 'https://YOUR-SLACK-TEAM.slack.com/api/users.admin.invite' \
|
|
@@ -30,6 +45,10 @@ fill out `config.js` as your infomation.
|
|
|
--compressed
|
|
|
```
|
|
|
|
|
|
+##### Heroku / Azure
|
|
|
+
|
|
|
+Add the application settings that are defined above for the local `.env` file.
|
|
|
+
|
|
|
## Run
|
|
|
[Node.js](http://nodejs.org/) is required.
|
|
|
|
|
@@ -37,7 +56,7 @@ fill out `config.js` as your infomation.
|
|
|
$ git clone git@github.com:outsideris/slack-invite-automation.git
|
|
|
$ cd slack-invite-automation
|
|
|
$ npm install
|
|
|
-$ bin/www
|
|
|
+$ npm start
|
|
|
```
|
|
|
|
|
|
You can access <http://localhost:3000> on your web browser.
|