|
1 | | -# Masq OpenID Server |
| 1 | +# Masq2 OpenID Server |
2 | 2 |
|
3 | 3 | [](http://travis-ci.org/bardbess/masq) |
4 | 4 |
|
5 | | -Masq is a mountable Rails engine that provides OpenID server/identity provider functionality. |
6 | | -It is the successor of the stand-alone Rails application [masquerade](http://github.com/dennisreimann/masquerade/). |
| 5 | +Masq2 is a mountable Rails engine that provides OpenID server/identity provider functionality. |
| 6 | +It is the successor to the [masq gem](https://github.com/dennisreimann/masq), which in turn |
| 7 | +was the successor of the stand-alone Rails application of the same purpose, [masquerade](http://github.com/dennisreimann/masquerade/). |
7 | 8 |
|
8 | | -The project is released under the MIT-License and its source code is available at [GitHub](http://github.com/dennisreimann/masquerade/). |
| 9 | +Because of this history, and the desire to be drop-in compatible with `masq`, |
| 10 | +the namespace remains `Masq`, not `Masq2`. |
| 11 | + |
| 12 | +The project is released under the MIT-License and its source code is available at [GitHub](http://github.com/oauth-xx/masq2/). |
9 | 13 | Feel free to fork and submit patches :) |
10 | 14 |
|
11 | 15 | ## Installation |
12 | 16 |
|
13 | | -0. In case you want to run masq as a standalone application (not integrated into an existing app), you will have to generate a barebone Rails app first: |
| 17 | +0. In case you want to run Masq2 as a standalone application (not integrated into an existing app), you will have to generate a bare-bone Rails app first: |
14 | 18 | * `rails new my_openid_provider` |
15 | 19 |
|
16 | | -1. Add masq to your Gemfile and install it: |
17 | | - * `gem 'masq'` |
| 20 | +1. Add `masq2` to your Gemfile and install it: |
| 21 | + * `gem 'masq2'` |
18 | 22 | * `bundle install` |
19 | 23 |
|
20 | 24 | 2. Copy the configuration and edit it: |
@@ -56,7 +60,9 @@ client-server communication (like requesting simple registration data). |
56 | 60 |
|
57 | 61 | ### Introduction |
58 | 62 |
|
59 | | -This fork adds ORACLE database support to the existing dennisreimann/masq gem. |
| 63 | +`masq2` adds ORACLE database support, as well as support for |
| 64 | +Rails 5.1, 5.2, 6.0, 6.1, 7.0, 7.1, 7.2, 8.0, |
| 65 | +which `masq` never had. |
60 | 66 |
|
61 | 67 | The main functionality is in the server controller, which is the endpoint for incoming |
62 | 68 | OpenID requests. The server controller is supposed to only interact with relying parties |
|
0 commit comments