devise-proxy 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. data/README.md +34 -7
  2. data/VERSION +1 -1
  3. data/devise-proxy.gemspec +1 -1
  4. metadata +2 -2
data/README.md CHANGED
@@ -8,17 +8,44 @@ Authentication is done on *every* request, so it is advisable to use devise-prox
8
8
  devise-proxy will return a 502 if a network connection to your authentication host cannot be established.
9
9
 
10
10
 
11
- # Quick Start #
11
+ ## Quick Start ##
12
12
 
13
- - Create a devise-proxy.yml using the provided .sample.
14
- - `rackup config.ru' to start the proxy server.
15
- - Configure you web browser or other client software to use the proxy and set a username (email) and password.
16
- - Enjoy!
13
+ 1. Create a devise-proxy.yml using the provided .sample.
14
+ 1. Start the proxy server:
15
+ > rackup config.ru
16
+ 1. Configure you web browser or other client software to use the proxy and set a username (email) and password.
17
+ 1. Enjoy!
17
18
 
18
- # Authors #
19
+ ## Example Configuration ##
20
+
21
+ You'll need a config/devise-proxy.yml file to start the application. For example:
22
+
23
+ authentication:
24
+ hostname: localhost
25
+ port: 3000
26
+ forwarding:
27
+ hostname: localhost
28
+ port: 3000
29
+
30
+
31
+ ## Troubleshooting ##
32
+
33
+
34
+
35
+ ### Infinite Client Redirects ###
36
+
37
+ If your client complains about infinite redirects, you're probably forwarding traffic to a hostname that returns a 302.
38
+ This may be the case if you request example.com, but the server redirects you to www.example.com.
39
+ When this occurs, the client will receive the 302 with the preferred hostname try again with a new URL. Since the proxy tosses out the hostname portion of the URL
40
+ and replaces it with whatever's in the config file, however, the proxy will forward to the same bad hostname, get another 302,
41
+ and return it to the client, introducing an infinite loop that the browser *should* eventually catch and stop.
42
+ This shouldn't be a big deal if you're forwarding to your own well-behaved devise app, but is worth mentioning.
43
+
44
+
45
+ ## Authors ##
19
46
 
20
47
  Preston Lee
21
48
 
22
- # Legal #
49
+ ## Legal ##
23
50
 
24
51
  See LICENSE file for details.
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.1.3
1
+ 0.1.4
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = "devise-proxy"
8
- s.version = "0.1.3"
8
+ s.version = "0.1.4"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Preston Lee"]
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: devise-proxy
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
115
115
  version: '0'
116
116
  segments:
117
117
  - 0
118
- hash: 3790407277146841335
118
+ hash: -1230018857575091658
119
119
  required_rubygems_version: !ruby/object:Gem::Requirement
120
120
  none: false
121
121
  requirements: