File: INSTALL.md

package info (click to toggle)
ruby-openid 2.5.0debian-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,980 kB
  • ctags: 2,219
  • sloc: ruby: 16,737; xml: 219; sh: 24; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 1,144 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# Ruby OpenID Library Installation

## Rubygems Installation

Rubygems is a tool for installing ruby libraries and their
dependancies. If you have rubygems installed, simply:

    gem install ruby-openid

## Manual Installation

Unpack the archive and run setup.rb to install:

    ruby setup.rb

setup.rb installs the library into your system ruby. If don't want to
add openid to you system ruby, you may instead add the `lib` directory of
the extracted tarball to your RUBYLIB environment variable:

    $ export RUBYLIB=${RUBYLIB}:/path/to/ruby-openid/lib

## Testing the Installation

Make sure everything installed ok:

    $> irb
    irb$> require "openid"
    => true

Or, if you installed via rubygems:

    $> irb
    irb$> require "rubygems"
    => true
    irb$> require_gem "ruby-openid"
    => true

## Run the test suite

Go into the test directory and execute the `runtests.rb` script.

## Next steps

* Run `consumer.rb` in the examples directory.
* Get started writing your own consumer using OpenID::Consumer
* Write your own server with `OpenID::Server`
* Use the `OpenIDLoginGenerator`! Read `example/README` for more info.