File: INSTALL.html

package info (click to toggle)
libopenid-ruby 2.1.2debian-1
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 5,140 kB
  • ctags: 3,251
  • sloc: ruby: 17,165; xml: 219; sh: 54; python: 30; makefile: 12
file content (168 lines) | stat: -rw-r--r-- 3,505 bytes parent folder | download
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>File: INSTALL</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



  <div id="fileHeader">
    <h1>INSTALL</h1>
    <table class="header-table">
    <tr class="top-aligned-row">
      <td><strong>Path:</strong></td>
      <td>INSTALL
      </td>
    </tr>
    <tr class="top-aligned-row">
      <td><strong>Last Update:</strong></td>
      <td>Fri Jun 27 15:51:42 -0700 2008</td>
    </tr>
    </table>
  </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <h1>Ruby <a href="../classes/OpenID.html">OpenID</a> Library Installation</h1>
<h2>Rubygems Installation</h2>
<p>
Rubygems is a tool for installing ruby libraries and their dependancies. If
you have rubygems installed, simply:
</p>
<pre>
  gem install ruby-openid
</pre>
<h2>Manual Installation</h2>
<p>
Unpack the archive and run setup.rb to install:
</p>
<pre>
 ruby setup.rb
</pre>
<p>
setup.rb installs the library into your system ruby. If don&#8216;t want to
add openid to you system ruby, you may instead add the <b>lib</b> directory
of the extracted tarball to your RUBYLIB environment variable:
</p>
<pre>
  $ export RUBYLIB=${RUBYLIB}:/path/to/ruby-openid/lib
</pre>
<h2>Testing the Installation</h2>
<p>
Make sure everything installed ok:
</p>
<pre>
 $&gt; irb
 irb$&gt; require &quot;openid&quot;
 =&gt; true
</pre>
<p>
Or, if you installed via rubygems:
</p>
<pre>
 $&gt; irb
 irb$&gt; require &quot;rubygems&quot;
 =&gt; true
 irb$&gt; require_gem &quot;ruby-openid&quot;
 =&gt; true
</pre>
<h2>Run the test suite</h2>
<p>
Go into the test directory and execute the *runtests.rb* script.
</p>
<h2>Next steps</h2>
<ul>
<li>Run consumer.rb in the examples directory.

</li>
<li>Get started writing your own consumer using <a
href="../classes/OpenID/Consumer.html">OpenID::Consumer</a>

</li>
<li>Write your own server with <a
href="../classes/OpenID/Server.html">OpenID::Server</a>

</li>
<li>Use the OpenIDLoginGenerator! Read example/README for more info.

</li>
</ul>

    </div>


   </div>


  </div>


    <!-- if includes -->

    <div id="section">





      


    <!-- if method_list -->


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>