openvpn-status-web 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/README.md +12 -6
  2. data/lib/openvpn-status-web.rb +1 -1
  3. data/lib/openvpn-status-web/version.rb +1 -1
  4. metadata +65 -19
data/README.md CHANGED
@@ -4,12 +4,10 @@
4
4
 
5
5
  ## Description
6
6
 
7
- Small (another word for naive in this case, it's simple and serves my needs) [Rack](http://rack.github.com/) application providing the information the [OpenVPN](http://openvpn.net/index.php/open-source.html) server collects in it's status file especially including a list of currently connected clients (common name, remote address, traffic, ...).
7
+ Small (another word for naive in this case, it's simple and serves my needs) [Rack](http://rack.github.com/) application providing the information an [OpenVPN](http://openvpn.net/index.php/open-source.html) server collects in it's status file especially including a list of currently connected clients (common name, remote address, traffic, ...).
8
8
 
9
9
  It lacks:
10
10
 
11
- * tracking multiple status at the same time
12
- * newer status file versions than v1
13
11
  * caching (parses file on each request, page does auto-refresh every minute as OpenVPN updates the status file these often by default)
14
12
  * management interface support
15
13
  * *possibly more...*
@@ -31,9 +29,15 @@ user: "nobody"
31
29
  group: "nogroup"
32
30
  # logfile is optional, logs to STDOUT else
33
31
  logfile: "openvpn-status-web.log"
34
- # display name for humans and the status file path
35
- name: "My Small VPN"
36
- status_file: "/var/log/openvpn-status.log"
32
+ # hash with each VPNs display name for humans as key and further config as value
33
+ vpns:
34
+ My Small VPN:
35
+ # the status file path and status file format version are required
36
+ version: 1
37
+ status_file: "/var/log/openvpn-status.log"
38
+ My Other VPN:
39
+ version: 3
40
+ status_file: "/var/log/other-openvpn-status.log"
37
41
  ```
38
42
 
39
43
  Your OpenVPN configuration should contain something like this:
@@ -45,6 +49,8 @@ status-version 1
45
49
  # ...snip...
46
50
  ```
47
51
 
52
+ For more information about OpenVPN status file and version, see their [man page](https://community.openvpn.net/openvpn/wiki/Openvpn23ManPage). openvpn-status-web is able to parse all versions from 1 to 3.
53
+
48
54
  ## Advanced topics
49
55
 
50
56
  ### Authentication
data/lib/openvpn-status-web.rb CHANGED
@@ -8,7 +8,7 @@ require 'yaml'
8
8
  require 'rack'
9
9
  require 'erb'
10
10
  require 'metriks'
11
- require 'better_errors'
11
+ require 'better_errors' if ENV['RACK_ENV'] == "development"
12
12
 
13
13
  require 'openvpn-status-web/status'
14
14
  require 'openvpn-status-web/parser/v1'
data/lib/openvpn-status-web/version.rb CHANGED
@@ -1,4 +1,4 @@
1
1
 
2
2
  module OpenVPNStatusWeb
3
- VERSION = "1.0.0"
3
+ VERSION = "1.0.1"
4
4
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: openvpn-status-web
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,11 +9,11 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2013-05-03 00:00:00.000000000Z
12
+ date: 2013-10-07 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: rack
16
- requirement: &70153409956960 !ruby/object:Gem::Requirement
16
+ requirement: !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
21
21
  version: '0'
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *70153409956960
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: '0'
25
30
  - !ruby/object:Gem::Dependency
26
31
  name: metriks
27
- requirement: &70153409956540 !ruby/object:Gem::Requirement
32
+ requirement: !ruby/object:Gem::Requirement
28
33
  none: false
29
34
  requirements:
30
35
  - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
32
37
  version: '0'
33
38
  type: :runtime
34
39
  prerelease: false
35
- version_requirements: *70153409956540
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
36
46
  - !ruby/object:Gem::Dependency
37
47
  name: bundler
38
- requirement: &70153409956040 !ruby/object:Gem::Requirement
48
+ requirement: !ruby/object:Gem::Requirement
39
49
  none: false
40
50
  requirements:
41
51
  - - ~>
@@ -43,10 +53,15 @@ dependencies:
43
53
  version: '1.3'
44
54
  type: :development
45
55
  prerelease: false
46
- version_requirements: *70153409956040
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: '1.3'
47
62
  - !ruby/object:Gem::Dependency
48
63
  name: rake
49
- requirement: &70153409955620 !ruby/object:Gem::Requirement
64
+ requirement: !ruby/object:Gem::Requirement
50
65
  none: false
51
66
  requirements:
52
67
  - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
54
69
  version: '0'
55
70
  type: :development
56
71
  prerelease: false
57
- version_requirements: *70153409955620
72
+ version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - ! '>='
76
+ - !ruby/object:Gem::Version
77
+ version: '0'
58
78
  - !ruby/object:Gem::Dependency
59
79
  name: rspec
60
- requirement: &70153409955160 !ruby/object:Gem::Requirement
80
+ requirement: !ruby/object:Gem::Requirement
61
81
  none: false
62
82
  requirements:
63
83
  - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
65
85
  version: '0'
66
86
  type: :development
67
87
  prerelease: false
68
- version_requirements: *70153409955160
88
+ version_requirements: !ruby/object:Gem::Requirement
89
+ none: false
90
+ requirements:
91
+ - - ! '>='
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
69
94
  - !ruby/object:Gem::Dependency
70
95
  name: rack-test
71
- requirement: &70153409954740 !ruby/object:Gem::Requirement
96
+ requirement: !ruby/object:Gem::Requirement
72
97
  none: false
73
98
  requirements:
74
99
  - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
76
101
  version: '0'
77
102
  type: :development
78
103
  prerelease: false
79
- version_requirements: *70153409954740
104
+ version_requirements: !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - ! '>='
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
80
110
  - !ruby/object:Gem::Dependency
81
111
  name: better_errors
82
- requirement: &70153409954320 !ruby/object:Gem::Requirement
112
+ requirement: !ruby/object:Gem::Requirement
83
113
  none: false
84
114
  requirements:
85
115
  - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
87
117
  version: '0'
88
118
  type: :development
89
119
  prerelease: false
90
- version_requirements: *70153409954320
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ none: false
122
+ requirements:
123
+ - - ! '>='
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
91
126
  - !ruby/object:Gem::Dependency
92
127
  name: binding_of_caller
93
- requirement: &70153409953900 !ruby/object:Gem::Requirement
128
+ requirement: !ruby/object:Gem::Requirement
94
129
  none: false
95
130
  requirements:
96
131
  - - ! '>='
@@ -98,7 +133,12 @@ dependencies:
98
133
  version: '0'
99
134
  type: :development
100
135
  prerelease: false
101
- version_requirements: *70153409953900
136
+ version_requirements: !ruby/object:Gem::Requirement
137
+ none: false
138
+ requirements:
139
+ - - ! '>='
140
+ - !ruby/object:Gem::Version
141
+ version: '0'
102
142
  description: Small Rack (Ruby) application serving OpenVPN status file.
103
143
  email: chrnicolai@gmail.com
104
144
  executables:
@@ -143,15 +183,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
143
183
  - - ! '>='
144
184
  - !ruby/object:Gem::Version
145
185
  version: '0'
186
+ segments:
187
+ - 0
188
+ hash: 229156271
146
189
  required_rubygems_version: !ruby/object:Gem::Requirement
147
190
  none: false
148
191
  requirements:
149
192
  - - ! '>='
150
193
  - !ruby/object:Gem::Version
151
194
  version: '0'
195
+ segments:
196
+ - 0
197
+ hash: 229156271
152
198
  requirements: []
153
199
  rubyforge_project:
154
- rubygems_version: 1.8.6
200
+ rubygems_version: 1.8.25
155
201
  signing_key:
156
202
  specification_version: 3
157
203
  summary: openvpn-status-web