Discource-C
/
discourse-steam-login
mirror of https://github.com/discourse/discourse-steam-login.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Allows user authentication with discourse via the Steam user API
12 Commits 4 Branches 0 Tags 1.6 MiB
Ruby 98.7%
JavaScript 1.3%
Go to file
defaye 49ab10ab7f Plugin compatible with runtime changes to API KEY 
Version bumped to 1.3.0.
Backward compatible with environment variable.
Updated instructions in the README.
 		2016-07-08 22:13:59 +01:00
assets/stylesheets Update plugin inline with new plugin format 2016-06-18 19:18:46 +01:00
config Update plugin inline with new plugin format 2016-06-18 19:18:46 +01:00
lib Plugin compatible with runtime changes to API KEY 2016-07-08 22:13:59 +01:00
.gitignore Update plugin inline with new plugin format 2016-06-18 19:18:46 +01:00
LICENSE Initial commit 2014-07-20 20:01:34 +01:00
README.md Plugin compatible with runtime changes to API KEY 2016-07-08 22:13:59 +01:00
plugin.rb Plugin compatible with runtime changes to API KEY 2016-07-08 22:13:59 +01:00

README.md

Discourse Steam Login

  1. SSH into your server and edit your Discourse Docker configuration file (e.g. nano /var/discourse/containers/app.yml) and make the following changes:

    • Add a git clone of this repository to the plugin list under hooks: below the Discourse Docker Manager plugin like so: - git clone https://github.com/defaye/discourse-steam-login.git.

  2. Check the validity of your file if you must. Then exit and save changes. (E.g. ctrl + x, y, enter)

  3. Run the rebuild script to apply the changes (e.g. /var/discourse/launcher rebuild app).

  4. Acquire your STEAM WEB API KEY obtainable from steamcommunity.com/dev/apikey (example domain name: forum.example.org). Login to your admin account and go to: Plugins — Steam authenticator — and save your key in the discourse steam login api key field.

  5. You're done! You should now be able to login via Steam. Please consider starring my repository if you use github. The more stars it receives, the more TLC and time I will spend in maintaining it.

Bugs

Please ask well-formed, well-written questions at the meta.discourse.org page. If you think there is a bug, prove it in an issue or do not open one. This may come across as blunt but it really does need to be quite explicit or otherwise these instructions will be ignored and you will waste my time.

Troubleshooting

For backwards compatibility with versions < 1.3.0, the plugin will default to the environment variable STEAM_WEB_API_KEY if no key is found in the plugin's site setting.

If you are setting up discourse for the first time or are able to re-build the app, you can set the API KEY at runtime under env: section of your configuration file in the format STEAM_WEB_API_KEY: 'YOURKEY'.

If you are not using docker and do not have access to admin (and have somehow managed to only permit Steam login (you are cool by the way)), you might be able to redeem the situation by setting the environment variable manually in your server (e.g export STEAM__WEB_API_KEY=YOURKEY).