Project

General

Profile

Revision 4597

Added by daigle about 12 years ago

Change references to LDAP to be Auth

View differences:

docs/user/metacatconfigure.html
46 46
  <div class="toc1"><a href="#Overview">Overview</a></div>
47 47
      <div class="toc2"><a href="#MetacatConfiguration">Metacat Configuration</a></div> 
48 48
      <div class="toc2"><a href="#ConfigurationRules">Configuration Rules</a></div>
49
  <div class="toc1"><a href="#LdapConfig">LDAP Configuration</a></div>
50
      <div class="toc2"><a href="#LdapOverview">LDAP Overview</a></div> 
51
      <div class="toc2"><a href="#GetToLdapConfig">Getting to the LDAP Configuration</a></div> 
52
      <div class="toc2"><a href="#ConfigLdapNoAuth">Changing LDAP Configuration Without Authentication</a></div>
49
  <div class="toc1"><a href="#authConfig">Authentication Configuration</a></div>
50
      <div class="toc2"><a href="#AuthOverview">Authentication Overview</a></div> 
51
      <div class="toc2"><a href="#GetToAuthConfig">Getting to the Authentication Configuration</a></div> 
52
      <div class="toc2"><a href="#ConfigAuthNoAuth">Changing Authentication Configuration Without Authentication</a></div>
53 53
  <div class="toc1"><a href="#AdminLogin">Admin Log In</a></div>
54 54
    <div class="toc2"><a href="#AdminLoginOverview">Admin Log In</a></div>
55 55
    <div class="toc2"><a href="#LoggingIn">Logging In</a></div>
......
101 101
  
102 102
  <ul>
103 103
    <li>
104
      Is LDAP Configured? If not, show 
105
      <a HREF="metacatconfigure.html#ldap-config">LDAP Configuration Section</a>.  
106
      You will need to have LDAP configured in order to define administrative accounts
107
      and authenticate as one of these users via LDAP.
104
      Is Authentication Configured? If not, show 
105
      <a HREF="metacatconfigure.html#auth-config">Authentication Configuration Section</a>.  
106
      You will need to have authorizaiton configured in order to define administrative accounts
107
      and authenticate as one of these users.
108 108
    </li>
109 109
    <li>
110 110
      Are you logged in as an administrative user?  If not, show 
......
128 128
  <p> See the following sections for descriptions of how each of these work.  For more
129 129
  information on each field, click on the blue question mark icon to the right.</p>
130 130

  
131
<a name="LdapConfig"></a><div class="header1">LDAP Configuration</div>
132
<a name="LdapOverview"></a><div class="header2">LDAP Overview</div>
133
  <p>Metacat uses LDAP as it's primary authentication mechanism.  The three main
134
  values needed are LDAP URL, LDAP Secure URL and Metacat Administrators.  You need 
135
  to verify that the the LDAP URL and LDAP Secure URL are correct (fig 1).  
136
  <span class="emphasis">You need to make sure that your LDAP user 
137
  account is entered into the MetaCat Administrators field.  You will not be allowed
131
<a name="AuthConfig"></a><div class="header1">Authentication Configuration</div>
132
<a name="AuthOverview"></a><div class="header2">Authentication Overview</div>
133
  <p>Metacat uses LDAP as it's primary authentication mechanism, but you can define
134
  your own mechanism by creating a java class that implements 
135
  AuthInterface. The configuration values needed are Authentication Class, Authentication URL, 
136
  Authentication Secure URL and Metacat Administrators.  You need 
137
  to verify that the the Authentication URL and Authentication Secure URL are correct (fig 1).  
138
  <span class="emphasis">You need to make sure that your user 
139
  account is entered into the Metacat Administrators field.  You will not be allowed
138 140
  to continue with configuration if this is missing.</span>
139 141

  
140
  <img class="screenshot" src="./images/ldap-config.png"/>
142
  <img class="screenshot" src="./images/auth-config.png"/>
141 143
  <div class="fig-text"> fig 1 </div>
142 144

  
143
<a name="GetToLdapConfig"></a><div class="header2">Getting to the LDAP Configuration</div>
144
  <p>You will automatically be sent to the LDAP Configuration page if this is a new
145
<a name="GetToAdminConfig"></a><div class="header2">Getting to the Authentication Configuration</div>
146
  <p>You will automatically be sent to the Authentication Configuration page if this is a new
145 147
  installation or upgrade.</p>
146 148
  
147
  <p>You can also get to the LDAP configuration from a running Metacat by typing:</p>
149
  <p>You can also get to the Administrative configuration from a running Metacat by typing:</p>
148 150
  <div class="code">&lt;your_context_url&gt;/admin</div>
149 151
  <p>You will be required to log in as an administrator and restart Metacat once you
150 152
  make changes.</p>
151 153
  
152
  <a name="ConfigLdapNoAuth"></a><div class="header2">Changing LDAP Configuration Without Authentication</div>
154
  <a name="ConfigAuthNoAuth"></a><div class="header2">Changing Authentication Configuration Without Authentication</div>
153 155
  <p>There is one exception to the log in rule.  That is when you need to change or add 
154
  LDAP information, but you can't authenticate using the existing setup.  For example:</p>
156
  authentication information, but you can't authenticate using the existing setup.  For example:</p>
155 157
  
156 158
  <ul>
157 159
    <li>The existing Metacat administrator is no longer available</li>
158 160
    <li>You forgot the administrator password.</li>
159
    <li>The configured LDAP urls are unavailable and you need to configure new ones.</li>  
161
    <li>The configured authentication urls are unavailable and you need to configure new ones.</li>  
160 162
  </ul>
161 163
  
162 164
  <p>In this case, you will need to edit the Metacat configuration file by hand and
......
180 182
  
181 183
<a name="AdminLogin"></a><div class="header1">Admin Log In</div>
182 184
<a name="AdminLoginOverview"></a><div class="header2">Admin Log In Overview</div>
183
  <p>Once LDAP has been configured, you will be required to login as an 
185
  <p>Once authentication has been configured, you will be required to login as an 
184 186
  administrative user if you haven't already.  You will be taken to 
185 187
  the administrator login screen (fig 2).  You can also get to the login
186 188
  screen by choosing the "log in as different user" link at the bottom of
......
191 193

  
192 194
<a name="LoggingIn"></a><div class="header2">Logging In</div>
193 195
<p>You need to log in with an account that was configured as an administrative
194
user in the LDAP configuration section.  If you did not set up the correct user 
196
user in the authentication configuration section.  If you did not set up the correct user 
195 197
there, you will need to go through the 
196
<a href="#ConfigLdapNoAuth">Changing LDAP Configuration Without Authentication</a>
198
<a href="#ConfigAuthNoAuth">Changing Authentication Configuration Without Authentication</a>
197 199
instructions to set up the user.</p>
198 200

  
199
<p>Enter your user name.  This is the uid part of the ldap identifier that you 
200
entered in LDAP configuration.  Select your organization, enter your password and
201
hit enter.  You should successfully log in.</p>
201
<p>Enter your user name.  This is one of the Metacat administrators that you 
202
entered in authenticationuthentication configuration.  Enter your password and
203
hit the "Login" button.  You should successfully log in.</p>
202 204

  
203 205
<a name="MainConfig"></a><div class="header1">Main Configuration Page</div>
204 206
<a name="MainConfigOverview"></a><div class="header2">Main Configuration Overview</div>
205 207
  <p>The main configuration screen acts as a gateway into individual configuration
206
  sections (fig 3).  You should see that the LDAP is already configured.</p>  
208
  sections (fig 3).  You should see that the authentication is already configured.</p>  
207 209
  
208 210
  <p>Each section is listed with a status to the left which can be one of:</p>
209 211
  <ul>

Also available in: Unified diff