Skip to content

Commit 5125315

Browse files
author
Open Identity Platform Community
committed
upload OpenIDM docs after deploy e294c2a56e24b5027b1ed53cff330f27880d8e83
1 parent 7de290a commit 5125315

29 files changed

+193
-148
lines changed

‎openidm/modules/ROOT/images/gsg-selfservice-menu.png

44.7 KB
Loading

‎openidm/modules/ROOT/images/gsg-windows.png

-80.7 KB
Loading

‎openidm/modules/connectors-guide/pages/chap-groovy.adoc

+4-2
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
1919
:example-caption!:
2020
:table-caption!:
2121
:leveloffset: -1"
22+
:openidm-version: 6.2.3
23+
:openidm-version-short: 6.2
2224
2325
2426
[#chap-groovy]
@@ -31,7 +33,7 @@ The Groovy Connector Toolkit is not a complete connector in the traditional sens
3133
[#groovy-connector]
3234
=== Groovy Connector Toolkit
3335
34-
The Groovy Connector Toolkit is bundled with OpenIDM 4.5, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`.
36+
The Groovy Connector Toolkit is bundled with OpenIDM {openidm-version-short}, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`.
3537
3638
Sample implementations are provided in xref:samples-guide:chap-groovy-samples.adoc#chap-groovy-samples["Samples That Use the Groovy Connector Toolkit to Create Scripted Connectors"] in the __Samples Guide__.
3739

‎openidm/modules/connectors-guide/pages/chap-ldap.adoc

+4-2
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
1919
:example-caption!:
2020
:table-caption!:
2121
:leveloffset: -1"
22+
:openidm-version: 6.2.3
23+
:openidm-version-short: 6.2
2224
2325
2426
[#chap-ldap]
@@ -31,7 +33,7 @@ OpenICF provides a legacy Active Directory (AD) .NET connector. Note, however, t
3133
[#ldap-connector-config]
3234
=== Setting Up the Generic LDAP Connector
3335
34-
OpenIDM 4.5 bundles version 1.4.1.2 of the LDAP connector. Three sample LDAP connector configurations are provided in the `path/to/openidm/samples/provisioners/` directory:
36+
OpenIDM {openidm-version-short} bundles version 1.4.1.2 of the LDAP connector. Three sample LDAP connector configurations are provided in the `path/to/openidm/samples/provisioners/` directory:
3537
3638
* `provisioner.openicf-opendjldap.json` provides a sample LDAP connector configuration for an OpenDJ directory server.
3739

‎openidm/modules/connectors-guide/pages/chap-overview.adoc

+5-3
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,21 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
1919
:example-caption!:
2020
:table-caption!:
2121
:leveloffset: -1"
22+
:openidm-version: 6.2.3
23+
:openidm-version-short: 6.2
2224
2325
2426
[#chap-overview]
25-
== Overview of the Connectors Supported With OpenIDM 4.5
27+
== Overview of the Connectors Supported With OpenIDM {openidm-version-short}
2628
27-
This chapter provides a high-level overview of the connectors supported with OpenIDM 4.5. Additional OpenICF connectors, not supported with OpenIDM, are available on the OpenICF download site, but are not described in this guide.
29+
This chapter provides a high-level overview of the connectors supported with OpenIDM {openidm-version-short}. Additional OpenICF connectors, not supported with OpenIDM, are available on the OpenICF download site, but are not described in this guide.
2830
2931
For instructions on building connector configurations interactively, see xref:integrators-guide:chap-resource-conf.adoc#connector-wiz["Creating Default Connector Configurations"] in the __Integrator's Guide__.
3032

‎openidm/modules/connectors-guide/pages/index.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,11 @@
2626
:figure-caption!:
2727
:example-caption!:
2828
:table-caption!:
29+
:openidm-version: 6.2.3
30+
:openidm-version-short: 6.2
31+
2932
[abstract]
30-
This guide describes the connectors that are supported with OpenIDM 4.5. The guide provides installation and configuration instructions for each connectors, and examples that demonstrate how to use the connectors in a deployment.
33+
This guide describes the connectors that are supported with OpenIDM {openidm-version-short}. The guide provides installation and configuration instructions for each connectors, and examples that demonstrate how to use the connectors in a deployment.
3134
3235
* xref:preface.adoc[]
3336
* xref:chap-overview.adoc[]

‎openidm/modules/getting-started/pages/chap-basic-install.adoc

+9-8
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
@@ -68,7 +68,7 @@ This section covers what you need to have on your system before running OpenIDM:
6868
6969
* Operating System: Windows or UNIX/Linux.
7070
71-
* Java: Java Runtime Environment (JRE) Standard Edition (Java SE) 7, update 6 or later, or Java 8. Alternatively, you can use the same version of the Java Development Kit (JDK). On Linux, you may also install the OpenJDK package native to your updated Linux distribution.
71+
* Java: Java Runtime Environment (JRE) Standard Edition (Java SE) 8, or later. Alternatively, you can use the same version of the Java Development Kit (JDK). On Linux, you may also install the OpenJDK package native to your updated Linux distribution.
7272
7373
* At least 250 MB of free disk space.
7474
@@ -78,18 +78,20 @@ This section covers what you need to have on your system before running OpenIDM:
7878
7979
We provide this document, __Getting Started with OpenIDM__, for demonstration purposes only.
8080
81-
With this document, we want to make it as easy as possible to set up a demonstration of OpenIDM. To that end, we have written this document for installations on a desktop operating system, Microsoft Windows 7.
81+
With this document, we want to make it as easy as possible to set up a demonstration of OpenIDM. To that end, we have written this document for installations on a desktop operating system, Microsoft Windows 10.
8282
8383
[#java-prerequisites]
8484
==== Java Environment
8585
86-
On Windows systems, after installing Java, set the `JAVA_HOME` environment variable. To do so on Windows 7, take the following steps:
86+
On Windows systems, after installing Java, set the `JAVA_HOME` environment variable. To do so on Windows 10, take the following steps:
8787
8888
====
8989
90-
. Locate your JRE or JDK installation directory. For a default installation of Java 8 on Windows 7, you should find the directory here: `C:\Program Files\Java\jre-version`.
90+
. Locate your JRE or JDK installation directory. For a default installation of Java 8 on Windows 10, you should find the directory here: `C:\Program Files\Java\jre-version`.
9191
92-
. Select Start > Control Panel > System and Security > Advanced System Settings to open a System Properties window.
92+
. Press `Windows + R` to launch the Windows Run prompt Properties window.
93+
94+
. Enter `sysdm.cpl` and press Enter to launch the System Properties window.
9395
9496
. Select Advanced > Environment Variables.
9597
@@ -102,12 +104,11 @@ On Windows systems, after installing Java, set the `JAVA_HOME` environment varia
102104
[#download-and-start]
103105
=== Downloading and Starting OpenIDM
104106
105-
106107
[#download-start-openidm]
107108
====
108109
This procedure assumes that you are downloading and starting OpenIDM as a regular (not administrative) user named `user`.
109110
110-
. Download enterprise software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank].
111+
. Download software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank].
111112
+
112113
For more information on the contents of the OpenIDM binary package, see xref:integrators-guide:appendix-file-layout.adoc#appendix-file-layout["File Layout"] in the __Integrator's Guide__.
113114

‎openidm/modules/getting-started/pages/chap-where-to-go.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,6 @@ Press Return, and enter the following command:
194194
. OpenIDM is self-contained. After you shut down OpenIDM, you can choose to delete the files in the `/path/to/openidm` directory. OpenIDM includes no artifacts in system registries or elsewhere.
195195
196196
====
197-
We hope that you want to continue exploring OpenIDM. To do so, review the rest of the link:../../../openidm/4.5[OpenIDM documentation, window=\_blank].
197+
We hope that you want to continue exploring OpenIDM. To do so, review the rest of the link:/openidm[OpenIDM documentation, window=\_blank].
198198
199199

‎openidm/modules/install-guide/pages/appendix-ro-install.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
information: "Portions copyright [year] [name of copyright owner]".
1313

1414
Copyright 2017 ForgeRock AS.
15-
Portions Copyright 2024 3A Systems LLC.
15+
Portions Copyright 2024-2025 3A Systems LLC.
1616
////
1717
1818
:figure-caption!:
1919
:example-caption!:
2020
:table-caption!:
2121
:leveloffset: -1"
22-
22+
:openidm-version: 6.2.3
2323
2424
[appendix]
2525
[#appendix-ro-install]
@@ -65,9 +65,9 @@ $ sudo mount -o remount,rw /idm
6565
----
6666
With the following commands, you can unpack the OpenIDM binary in the `/idm` directory, and give user `idm` ownership of all files in that directory:
6767
68-
[source, console]
68+
[source, console, subs="attributes"]
6969
----
70-
$ sudo unzip /idm/openidm-4.5.1-20.zip
70+
$ sudo unzip /idm/openidm-{openidm-version}.zip
7171
$ sudo chown -R idm.idm /idm
7272
----
7373
@@ -119,7 +119,7 @@ Make sure `handlerForQueries` is set to `repo`.
119119
Redirect the `logDirectory` property to the newly created `/var/log/openidm/audit` subdirectory:
120120
+
121121
122-
[source, javascript]
122+
[source, json]
123123
----
124124
{
125125
"auditServiceConfig" : {

‎openidm/modules/install-guide/pages/chap-install.adoc

+11-10
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
:example-caption!:
2020
:table-caption!:
2121
:leveloffset: -1"
22+
:openidm-version: 6.2.3
2223
2324
2425
[#chap-install]
@@ -39,7 +40,7 @@ This section covers what you need to know before running OpenIDM.
3940
[#java-prerequisites]
4041
==== Java Environment
4142
42-
On Windows systems, you must set the `JAVA_HOME` environment variable to point to the root of a valid Java installation. The following steps indicate how to set the `JAVA_HOME` environment variable on Windows Server 2008 R2. Adjust the steps for your specific environment:
43+
On Windows systems, you must set the `JAVA_HOME` environment variable to point to the root of a valid Java installation. The following steps indicate how to set the `JAVA_HOME` environment variable on Windows Server 2012 R2. Adjust the steps for your specific environment:
4344
4445
. Locate your JRE Installation Directory. If you have not changed the installation path for the Java Runtime Environment during installation, it will be in a directory under `C:\Program Files\Java\`.
4546
@@ -51,7 +52,7 @@ On Windows systems, you must set the `JAVA_HOME` environment variable to point t
5152
5253
. Under System Variables, click New.
5354
54-
. Enter the Variable name (`JAVA_HOME`) and set the Variable value to the JRE installation directory, for example `C:\Program Files\Java\jre7`.
55+
. Enter the Variable name (`JAVA_HOME`) and set the Variable value to the JRE installation directory, for example `C:\Program Files\Java\jre8`.
5556
5657
. Click OK.
5758
@@ -60,7 +61,7 @@ On Windows systems, you must set the `JAVA_HOME` environment variable to point t
6061
[#application-container-prerequisites]
6162
==== Application Container
6263
63-
OpenIDM services run in an OSGi container with an embedded Servlet container, and an embedded noSQL database. By default the OSGi container is Apache Felix (Felix). The default Servlet container is Jetty. For OpenIDM 4.5, the only supported configuration is running the services in Felix and Jetty.
64+
OpenIDM services run in an OSGi container with an embedded Servlet container, and an embedded noSQL database. By default the OSGi container is Apache Felix (Felix). The default Servlet container is Jetty. For OpenIDM 6.2, the only supported configuration is running the services in Felix and Jetty.
6465
6566
6667
@@ -80,24 +81,24 @@ Follow these steps to install OpenIDM:
8081
[source, console]
8182
----
8283
$ java -version
83-
java version "1.7.0_79"
84-
Java(TM) SE Runtime Environment (build 1.7.0_79-b15)
85-
Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode)
84+
openjdk version "1.8.0_362"
85+
OpenJDK Runtime Environment (Temurin)(build 1.8.0_362-b09)
86+
OpenJDK 64-Bit Server VM (Temurin)(build 25.362-b09, mixed mode)
8687
----
8788
8889
. Download software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank].
8990
9091
. Unpack the contents of the .zip file into the install location:
9192
+
9293
93-
[source, console]
94+
[source, console, subs="attributes"]
9495
----
9596
$ cd /path/to
96-
$ unzip ~/Downloads/openidm-4.5.1-20.zip
97-
Archive: openidm-4.5.1-20.zip
97+
$ unzip ~/Downloads/openidm-{openidm-version}.zip
98+
Archive: openidm-{openidm-version}.zip
9899
inflating: openidm/.checksums.csv
99100
creating: openidm/bundle/
100-
extracting: openidm/bundle/openidm-audit-4.5.1-20.jar
101+
extracting: openidm/bundle/openidm-audit-{openidm-version}.jar
101102
...
102103
----
103104

‎openidm/modules/install-guide/pages/chap-repository.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@
1919
:example-caption!:
2020
:table-caption!:
2121
:leveloffset: -1"
22+
:openidm-version: 6.2.3
23+
:openidm-version-short: 6.2
2224
2325
2426
[#chap-repository]
2527
== Installing a Repository For Production
2628
2729
By default, OpenIDM uses OrientDB for its internal repository so that you do not have to install a database in order to evaluate OpenIDM. Before using OpenIDM in production, however, you must replace OrientDB with a supported JDBC repository.
28-
In production environments, OpenIDM 4.5 supports the use of the following internal repositories:
30+
In production environments, OpenIDM {openidm-version-short} supports the use of the following internal repositories:
2931
3032
* MySQL
3133

0 commit comments

Comments
 (0)