Skip to content

Commit 88f8872

Browse files
vharsekovharseko
authored
Restore docs from community repository
2 parents 7a43b92 + f4779d5 commit 88f8872

File tree

257 files changed

+65318
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

257 files changed

+65318
-0
lines changed

‎openam-documentation/openam-doc-source/src/main/docbkx/admin-guide/appendix-interface-stability.xml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
! CCPL HEADER START
4+
!
5+
! This work is licensed under the Creative Commons
6+
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
7+
! To view a copy of this license, visit
8+
! http://creativecommons.org/licenses/by-nc-nd/3.0/
9+
! or send a letter to Creative Commons, 444 Castro Street,
10+
! Suite 900, Mountain View, California, 94041, USA.
11+
!
12+
! See the License for the specific language governing permissions
13+
! and limitations under the License.
14+
!
15+
! If applicable, add the following below this CCPL HEADER, with the fields
16+
! enclosed by brackets "[]" replaced with your own identifying information:
17+
! Portions Copyright [yyyy] [name of copyright owner]
18+
!
19+
! CCPL HEADER END
20+
!
21+
! Copyright 2013 ForgeRock, Inc.
22+
!
23+
-->
24+
<appendix xml:id="appendix-interface-stability"
25+
xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
26+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
27+
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
28+
xmlns:xlink='http://www.w3.org/1999/xlink'
29+
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
30+
<title>Release Levels &amp; Interface Stability</title>
31+
32+
<para>This appendix includes ForgeRock definitions for product release levels
33+
and interface stability.</para>
34+
35+
<xinclude:include href="../shared/sec-release-levels.xml" />
36+
<xinclude:include href="../shared/sec-interface-stability.xml" />
37+
</appendix>

‎openam-documentation/openam-doc-source/src/main/docbkx/admin-guide/chap-admin-tools.xml

+242
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
! CCPL HEADER START
4+
!
5+
! This work is licensed under the Creative Commons
6+
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
7+
! To view a copy of this license, visit
8+
! http://creativecommons.org/licenses/by-nc-nd/3.0/
9+
! or send a letter to Creative Commons, 444 Castro Street,
10+
! Suite 900, Mountain View, California, 94041, USA.
11+
!
12+
! You can also obtain a copy of the license at
13+
! src/main/resources/legal-notices/CC-BY-NC-ND.txt.
14+
! See the License for the specific language governing permissions
15+
! and limitations under the License.
16+
!
17+
! If applicable, add the following below this CCPL HEADER, with the fields
18+
! enclosed by brackets "[]" replaced with your own identifying information:
19+
! Portions Copyright [yyyy] [name of copyright owner]
20+
!
21+
! CCPL HEADER END
22+
!
23+
! Copyright 2011-2012 ForgeRock AS
24+
!
25+
-->
26+
<chapter xml:id='chap-admin-tools'
27+
xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
28+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
29+
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
30+
xmlns:xlink='http://www.w3.org/1999/xlink'>
31+
<title>Administration Interfaces &amp; Tools</title>
32+
33+
<para>This chapter provides a brief introduction to the web-based OpenAM
34+
console. It also lists and describes each command line interface (CLI)
35+
administration tool.</para>
36+
37+
<section xml:id="openam-console-overview">
38+
<title>OpenAM Web-Based Console</title>
39+
<indexterm><primary>Console overview</primary></indexterm>
40+
<para>After you install OpenAM, login to the web-based console as OpenAM
41+
Administrator, <literal>amadmin</literal> with the password you set during
42+
installation. Navigate to a URL such as
43+
<literal>http://openam.example.com:8080/openam</literal>. In this case,
44+
communications proceed over the HTTP protocol to a FQDN
45+
(<literal>openam.example.com</literal>), over a standard Java EE web container
46+
port number (8080), to a specific deployment URI (<literal>/openam</literal>).</para>
47+
48+
<mediaobject xml:id="figure-console-as-amadmin">
49+
<alt>How the console looks to amadmin</alt>
50+
<imageobject>
51+
<imagedata fileref="images/console-as-amadmin.png" format="PNG" />
52+
</imageobject>
53+
<textobject><para>The OpenAM Administrator sees all capabilities of the
54+
console.</para></textobject>
55+
</mediaobject>
56+
57+
<para>When you login as the OpenAM Administrator, <literal>amadmin</literal>,
58+
you have access to the complete OpenAM console. In addition, OpenAM has set a
59+
cookie in your browser that lasts until the session expires, you logout, or
60+
you close your browser.<footnote>
61+
<para>Persistent cookies can remain valid when you
62+
close your browser. This section reflects OpenAM default behavior before
63+
you configure additional functionality.</para></footnote></para>
64+
65+
<para>When you login to the OpenAM console as a non-administrative end user,
66+
you do not have access to the administrative console. Your access is limited
67+
to a configuration page with your account information.</para>
68+
69+
<mediaobject xml:id="figure-console-as-bjensen">
70+
<alt>How the console looks to an end user</alt>
71+
<imageobject>
72+
<imagedata fileref="images/console-as-bjensen.png" format="PNG" />
73+
</imageobject>
74+
<textobject><para>OpenAM console directs an end user to a page where she
75+
can view and update her account information.</para></textobject>
76+
</mediaobject>
77+
78+
<para>If you configure OpenAM to grant administrative capabilities to
79+
another user, then that user also sees the console after login. For
80+
instance, the OpenAM Administrator granted Kirsten Vaughan privileges to
81+
administer the OpenAM Top Level Realm. (This can be done through the console
82+
under Access Control &gt; / (Top Level Realm) &gt; Privileges. Kirsten
83+
has authorization to read and write policy properties and configured
84+
policy agent properties.) When Kirsten logs in, she sees only part of the
85+
console capabilities.<footnote><para>For more on delegated administration,
86+
see the chapter covering realms.</para></footnote></para>
87+
88+
<mediaobject xml:id="figure-console-as-kvaughan">
89+
<alt>How the console looks to an administrator</alt>
90+
<imageobject>
91+
<imagedata fileref="images/console-as-kvaughan.png" format="PNG" />
92+
</imageobject>
93+
<textobject><para>OpenAM console appears differently to an administrator
94+
with limited rights.</para></textobject>
95+
</mediaobject>
96+
</section>
97+
98+
<section xml:id="openam-cli-overview">
99+
<title>OpenAM Command-Line Tools</title>
100+
<para>The script tools in the following list have <literal>.bat</literal>
101+
versions for use on Microsoft Windows.</para>
102+
<indexterm><primary>Command line tools overview</primary></indexterm>
103+
<indexterm><primary>Silent installation</primary></indexterm>
104+
<variablelist>
105+
<para>You can install the following OpenAM command-line tools.</para>
106+
<varlistentry>
107+
<term><command>agentadmin</command></term>
108+
<listitem>
109+
<para>This tool lets you manage OpenAM policy agent installations.</para>
110+
<para>Unpack this tool as part of policy agent installation.</para>
111+
</listitem>
112+
</varlistentry>
113+
<varlistentry>
114+
<term><command>ampassword</command></term>
115+
<listitem>
116+
<para>This tool lets you change OpenAM Administrator passwords, and
117+
display encrypted password values.</para>
118+
<para>Install this from the <filename><?eval ${ssoadminZipFile}?></filename>.</para>
119+
</listitem>
120+
</varlistentry>
121+
<varlistentry>
122+
<term><command>amverifyarchive</command></term>
123+
<listitem>
124+
<para>This tool checks log archives for tampering.</para>
125+
<para>Install this from <filename><?eval ${ssoadminZipFile}?></filename>.</para>
126+
</listitem>
127+
</varlistentry>
128+
<varlistentry>
129+
<term><command><?eval ${configJarFile}?></command></term>
130+
<listitem>
131+
<para>This executable .jar file lets you perform a silent installation of an OpenAM
132+
server with a configuration file. For example, the <command>java -jar configurator.jar -f
133+
config.file</command> command couples the <filename>configurator.jar</filename> archive
134+
with the <replaceable>config.file</replaceable>. The <filename>sampleconfiguration</filename>
135+
file provided with the tool is set up with the format for the <filename>config.file</filename>,
136+
and it must be adapted for your environment.</para>
137+
<para>Install this from <filename><?eval ${ssoconfigZipFile}?></filename>.</para>
138+
</listitem>
139+
</varlistentry>
140+
<varlistentry>
141+
<term><command>ssoadm</command></term>
142+
<listitem>
143+
<para>This tool provides a rich command-line interface for the configuration
144+
of OpenAM core services.</para>
145+
<para>In a test environment you can activate
146+
<filename>ssoadm.jsp</filename> to access the same functionality in your
147+
browser. Once active, you can use many features of the <command>ssoadm</command>
148+
command, by navigating to the <filename>ssoadm.jsp</filename> URI, in a URL such as
149+
<literal>http://openam.example.com:8080/openam/ssoadm.jsp</literal>.</para>
150+
<para>Install this from <filename><?eval ${ssoadminZipFile}?></filename>.</para>
151+
<para>To translate settings applied in OpenAM console to service attributes
152+
for use with <command>ssoadm</command>, login to the OpenAM console
153+
as <literal>amadmin</literal> and access the services page, in a URL such as
154+
<literal>http://openam.example.com:8080/openam/services.jsp</literal>.</para>
155+
</listitem>
156+
</varlistentry>
157+
<!--
158+
<varlistentry>
159+
<term><command>ssodtool.sh</command></term>
160+
<listitem>
161+
<para>This extensible diagnostic tool runs in GUI mode by default, but can
162+
also be run in command-line mode. The tool helps you check configuration
163+
settings and verify configuration integrity, test connectivity, and
164+
generate test reports.</para>
165+
<para>Install this from <filename><?eval ${diagnosticsZipFile}?></filename>.</para>
166+
</listitem>
167+
</varlistentry>
168+
-->
169+
</variablelist>
170+
171+
<para>The commands access the OpenAM configuration over HTTP (or HTTPS).
172+
When using the administration commands in a site configuration, the
173+
commands access the configuration through the front end load balancer.</para>
174+
<itemizedlist>
175+
<para>Sometimes a command cannot access the load balancer, because:</para>
176+
<listitem>
177+
<para>Network routing restrictions prevent the tool from accessing
178+
the load balancer.</para>
179+
</listitem>
180+
<listitem>
181+
<para>For testing purposes, the load balancer uses a self-signed
182+
certificate for HTTPS, and the tool does not have a way of trusting the
183+
self-signed certificate.</para>
184+
</listitem>
185+
<listitem>
186+
<para>The load balancer is temporarily unavailable.</para>
187+
</listitem>
188+
</itemizedlist>
189+
<para>In such cases you can work around the problem by adding an option
190+
such as the following to the <command>java</command> command in the
191+
tool's script. The option sets a comma-separated list of key-value pairs,
192+
where the key is the load balancer URL and the value is the server URL.
193+
(This all belongs on one line with no spaces in the script.)</para>
194+
<programlisting language="none">
195+
-D"com.iplanet.am.naming.map.site.to.server=https://lb.example.com:443/openam=
196+
http://server1.example.com:8080/openam,https://lb.example.com:443/openam=
197+
http://server2.example.com:8080/openam"</programlisting>
198+
<para>In the above example the load balancer is on the <literal>lb</literal>
199+
host, <literal>https://lb.example.com:443/openam</literal> is the site name,
200+
and the OpenAM servers in the site are on <literal>server1</literal> and
201+
<literal>server2</literal>.</para>
202+
</section>
203+
204+
<section xml:id="openam-ssoadm-jsp-overview">
205+
<title>OpenAM ssoadm.jsp</title>
206+
<para>You can use the <command>ssoadm.jsp</command> page to access a large
207+
subset of the configuration capabilities of the <command>ssoadm</command>
208+
command. Yet, <command>ssoadm.jsp</command> is disabled by default to prevent
209+
potential misuse.</para>
210+
<procedure xml:id="enable-ssoadm-jsp">
211+
<title>To Enable ssoadm.jsp</title>
212+
<indexterm><primary>Enabling ssoadm.jsp</primary></indexterm>
213+
<step>
214+
<para>Login as OpenAM administrator, <literal>amadmin</literal>.</para>
215+
</step>
216+
<step>
217+
<para>Click Configuration &gt; Servers and Sites &gt;
218+
Servers &gt; <replaceable>URL of your server</replaceable>.</para>
219+
</step>
220+
<step>
221+
<para>Click Advanced to display the Advanced Properties table,
222+
and then click Add. In the text boxes that appear, include the following
223+
information, and then click Save.</para>
224+
<variablelist>
225+
<varlistentry>
226+
<term>Property Name</term>
227+
<listitem><para>ssoadm.disabled</para></listitem>
228+
</varlistentry>
229+
<varlistentry>
230+
<term>Property Value</term>
231+
<listitem><para>false</para></listitem>
232+
</varlistentry>
233+
</variablelist>
234+
</step>
235+
<step>
236+
<para>To see if the change worked, navigate to the URL of OpenAM with the
237+
<literal>/ssoadm.jsp</literal> URI. For the aforementioned URL, you would
238+
navigate to <literal>http://openam.example.com:8080/openam/ssoadm.jsp</literal>.</para>
239+
</step>
240+
</procedure>
241+
</section>
242+
</chapter>

0 commit comments

Comments
 (0)