Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 48 lines (30 sloc) 1.11 kb
dc35318 [project @ documentation updates and removed references to "consumer onl...
tailor authored
1 = Ruby OpenID Library Installation
bb24b85 [project @ initial checkin]
tailor authored
2
0535ab8 [project @ added rubygems hints for installation]
tailor authored
3 == Rubygems Installation
bb24b85 [project @ initial checkin]
tailor authored
4
0535ab8 [project @ added rubygems hints for installation]
tailor authored
5 Rubygems is a tool for installing ruby libraries and their
6 dependancies. If you have rubygems installed, simply:
7
8 gem install ruby-openid
9
10 == Manual Installation
11
12 Unpack the archive and run setup.rb to install:
bb24b85 [project @ initial checkin]
tailor authored
13
35f67e1 [project @ Huge documentation patch]
tailor authored
14 ruby setup.rb
15
0535ab8 [project @ added rubygems hints for installation]
tailor authored
16 setup.rb installs the library into your system ruby. If don't want to
17 add openid to you system ruby, you may instead add the *lib* directory of
18 the extracted tarball to your RUBYLIB environment variable:
19
20 $ export RUBYLIB=${RUBYLIB}:/path/to/ruby-openid/lib
21
22
23 == Testing the Installation
bb24b85 [project @ initial checkin]
tailor authored
24
25 Make sure everything installed ok:
35f67e1 [project @ Huge documentation patch]
tailor authored
26 $> irb
0535ab8 [project @ added rubygems hints for installation]
tailor authored
27 irb$> require "openid"
28 => true
29
30 Or, if you installed via rubygems:
31
32 $> irb
33 irb$> require "rubygems"
34 => true
35 irb$> require_gem "ruby-openid"
35f67e1 [project @ Huge documentation patch]
tailor authored
36 => true
37
38 == Run the test suite
39
736404f [project @ doc updates]
tailor authored
40 Go into the test directory and execute the *runtests.rb* script.
35f67e1 [project @ Huge documentation patch]
tailor authored
41
42 == Next steps
bb24b85 [project @ initial checkin]
tailor authored
43
35f67e1 [project @ Huge documentation patch]
tailor authored
44 * Run consumer.rb in the examples directory.
f84a853 [project @ big patch with lots of doc additions and moves]
tailor authored
45 * Get started writing your own consumer using OpenID::Consumer
46 * Write your own server with OpenID::Server
0535ab8 [project @ added rubygems hints for installation]
tailor authored
47 * Use the OpenIDLoginGenerator! Read example/README for more info.
Something went wrong with that request. Please try again.