You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: Reference correct path for db.rb
chore: Add omniauth support
refac: Use the security app to handle Omniauth routes
chore: Add up and down db migrations
refac: Link users to identities
chore: Clean up config and documents
fix: Link to registration from sidebar
fix: Logout functionality
refac: Make the views easier to customize
refac: Proper load order for DB and models
refac: Use Base Roda app
fix: Allow admin users to create users
fix: Properly handle authentication failure
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/proxes`. To experiment with that code, run `bin/console` for an interactive prompt.
3
+
# ProxES
4
4
5
-
TODO: Delete this and the text above, and describe your gem
5
+
ProxES provides a couple of components to allow you to embed and wrap
6
+
Elasticsearch within your Rack app.
7
+
8
+
## Components
9
+
10
+
ProxES has two main components that works together, but can be used separately
11
+
as well:
12
+
13
+
### 1. Management Interface
14
+
15
+
This interface gives you the ability to manage your Elasticsearch users and get
16
+
and overview of your Elasticsearch cluster.
17
+
18
+
### 2. Security Middleware
19
+
20
+
The Rack middleware checks all requests going to your Elasticsearch cluster
21
+
against the users and permissions you've set up in the Management Interface. It
22
+
uses a combination of [Pundit](https://github.com/elabs/pundit) and
23
+
[OmniAuth](https://github.com/omniauth/omniauth) to secure your cluster.
6
24
7
25
## Installation
8
26
@@ -22,7 +40,15 @@ Or install it yourself as:
22
40
23
41
## Usage
24
42
25
-
TODO: Write usage instructions here
43
+
Check the included [`config.ru`](https://github.com/EagerELK/proxes/blob/master/config.ru) file for an example setup.
44
+
45
+
At a minimum, you need to
46
+
47
+
* Set up Session Middleware
48
+
* Set up OmniAuth to Authenticate the user
49
+
* Mount the `ProxES::App`
50
+
* Proxy all Elasticsearch requests after running it through the `ProxES::Security`
51
+
middleware
26
52
27
53
## Development
28
54
@@ -34,8 +60,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
34
60
35
61
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/proxes.
36
62
37
-
38
63
## License
39
64
40
-
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
65
+
The gem is available as open source under the terms of the [LGPLv3 license](http://www.gnu.org/licenses/lgpl-3.0.html).
0 commit comments