How to set up authentication with hubot #655
Conversation
I made a post on my blog, it seems like something that should be in the docs. http://jjasghar.github.io/blog/2014/02/19/getting-authentication-with-hubot-using-auth-dot-coffee/
|
+1 I see that you're good at using hubot and helped providing documentation. Can you also add a documentation on how to use something like oauth from oauth.coffee? |
|
I haven't played with oauth.coffee yet, so i'll take a look :) |
|
@kewubenduben To make sure i'm looking at the correct thing: |
|
@jjasghar, correct. Lots of scripts that uses oauth but never have been a proper documentation on how to make use of it. |
|
I'll give it a shot, thanks for the heads up! 👍 |
|
Thanks for putting this together! The main entry point to docs is https://github.com/github/hubot/blob/master/docs/README.md, so you'd want to make sure it gets linked somewhere. This sounds like a pattern though, so maybe move it to docs/patterns/authentication.coffee, and link to it from docs/patterns.md? I think that would make sense for docs/patterns/oauth.coffee as well. |
|
I also think this needs some editing. You mention it came from a blog post, and definitely reads like one. In particular, it starts out assume you know you want authentication, when it should probably explain what it is. I think this is actually about authorization, not authentication, ie that someone has a particular role, not that they are a specific person. You'd want the flow to be like... explaining what this authorization is, and why you want it, then go into configuration, and lastly using it from scripts. Make sense? |
|
@technicalpickles Perfect sense. I'll attempt a re-write, but it's good to know that ya'll are interested. I'll attempt to get it written over the weekend. Updates when i got em. |
|
@technicalpickles any comments? |
|
Thanks! I'm not sure what to do with this until #656 is merged or tweaked or decided upon, so I guess I'd say that's a block :) |
|
Linking for posterity to #768 - I'm working on providing a more generalized method of authorization policy. Hoping to have it done in a couple months. |
| # Authorization for Hubot | ||
|
|
||
| Authorization is the ability to scope certain commands for certain people. This is accomplished by two scripts and redis that come with | ||
| the basic install of hubot: [auth.coffee](https://github.com/github/hubot/blob/master/src/scripts/auth.coffee) and [roles.coffee](https://github.com/github/hubot/blob/master/src/scripts/roles.coffee). This tutorial is designed to get a basic understanding of setting it up, so you concentrate on figuring out where to use it as quickly as possible. |
There was a problem hiding this comment.
These scripts aren't included by default any more, so probably should point to the extracted scripts.
|
Closing now that #803 has merged (including guidance for setting up custom authorization policies) |
I made a post on my blog, it seems like something that should be in the
docs.