Skip to content

Commit

Permalink
upload OpenIDM docs after deploy e294c2a56e24b5027b1ed53cff330f27880d…
Browse files Browse the repository at this point in the history
…8e83
  • Loading branch information
Open Identity Platform Community committed Feb 7, 2025
1 parent 7de290a commit 5125315
Show file tree
Hide file tree
Showing 29 changed files with 193 additions and 148 deletions.
Binary file modified openidm/modules/ROOT/images/gsg-selfservice-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified openidm/modules/ROOT/images/gsg-windows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions openidm/modules/connectors-guide/pages/chap-groovy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
:example-caption!:
:table-caption!:
:leveloffset: -1"
:openidm-version: 6.2.3
:openidm-version-short: 6.2
[#chap-groovy]
Expand All @@ -31,7 +33,7 @@ The Groovy Connector Toolkit is not a complete connector in the traditional sens
[#groovy-connector]
=== Groovy Connector Toolkit
The Groovy Connector Toolkit is bundled with OpenIDM 4.5, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`.
The Groovy Connector Toolkit is bundled with OpenIDM {openidm-version-short}, in the JAR `openidm/connectors/groovy-connector-1.4.2.1.jar`.
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__.
Expand Down
6 changes: 4 additions & 2 deletions openidm/modules/connectors-guide/pages/chap-ldap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
:example-caption!:
:table-caption!:
:leveloffset: -1"
:openidm-version: 6.2.3
:openidm-version-short: 6.2
[#chap-ldap]
Expand All @@ -31,7 +33,7 @@ OpenICF provides a legacy Active Directory (AD) .NET connector. Note, however, t
[#ldap-connector-config]
=== Setting Up the Generic LDAP Connector
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:
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:
* `provisioner.openicf-opendjldap.json` provides a sample LDAP connector configuration for an OpenDJ directory server.
Expand Down
8 changes: 5 additions & 3 deletions openidm/modules/connectors-guide/pages/chap-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,21 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
:example-caption!:
:table-caption!:
:leveloffset: -1"
:openidm-version: 6.2.3
:openidm-version-short: 6.2
[#chap-overview]
== Overview of the Connectors Supported With OpenIDM 4.5
== Overview of the Connectors Supported With OpenIDM {openidm-version-short}
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.
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.
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__.
Expand Down
5 changes: 4 additions & 1 deletion openidm/modules/connectors-guide/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@
:figure-caption!:
:example-caption!:
:table-caption!:
:openidm-version: 6.2.3
:openidm-version-short: 6.2
[abstract]
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.
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.
* xref:preface.adoc[]
* xref:chap-overview.adoc[]
Expand Down
17 changes: 9 additions & 8 deletions openidm/modules/getting-started/pages/chap-basic-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand Down Expand Up @@ -68,7 +68,7 @@ This section covers what you need to have on your system before running OpenIDM:
* Operating System: Windows or UNIX/Linux.
* 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.
* 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.
* At least 250 MB of free disk space.
Expand All @@ -78,18 +78,20 @@ This section covers what you need to have on your system before running OpenIDM:
We provide this document, __Getting Started with OpenIDM__, for demonstration purposes only.
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.
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.
[#java-prerequisites]
==== Java Environment
On Windows systems, after installing Java, set the `JAVA_HOME` environment variable. To do so on Windows 7, take the following steps:
On Windows systems, after installing Java, set the `JAVA_HOME` environment variable. To do so on Windows 10, take the following steps:
====
. 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`.
. 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`.
. Select Start > Control Panel > System and Security > Advanced System Settings to open a System Properties window.
. Press `Windows + R` to launch the Windows Run prompt Properties window.
. Enter `sysdm.cpl` and press Enter to launch the System Properties window.
. Select Advanced > Environment Variables.
Expand All @@ -102,12 +104,11 @@ On Windows systems, after installing Java, set the `JAVA_HOME` environment varia
[#download-and-start]
=== Downloading and Starting OpenIDM
[#download-start-openidm]
====
This procedure assumes that you are downloading and starting OpenIDM as a regular (not administrative) user named `user`.
. Download enterprise software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank].
. Download software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank].
+
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__.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,6 @@ Press Return, and enter the following command:
. 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.
====
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].
We hope that you want to continue exploring OpenIDM. To do so, review the rest of the link:/openidm[OpenIDM documentation, window=\_blank].
10 changes: 5 additions & 5 deletions openidm/modules/install-guide/pages/appendix-ro-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
:example-caption!:
:table-caption!:
:leveloffset: -1"
:openidm-version: 6.2.3
[appendix]
[#appendix-ro-install]
Expand Down Expand Up @@ -65,9 +65,9 @@ $ sudo mount -o remount,rw /idm
----
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:
[source, console]
[source, console, subs="attributes"]
----
$ sudo unzip /idm/openidm-4.5.1-20.zip
$ sudo unzip /idm/openidm-{openidm-version}.zip
$ sudo chown -R idm.idm /idm
----
Expand Down Expand Up @@ -119,7 +119,7 @@ Make sure `handlerForQueries` is set to `repo`.
Redirect the `logDirectory` property to the newly created `/var/log/openidm/audit` subdirectory:
+
[source, javascript]
[source, json]
----
{
"auditServiceConfig" : {
Expand Down
21 changes: 11 additions & 10 deletions openidm/modules/install-guide/pages/chap-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
:example-caption!:
:table-caption!:
:leveloffset: -1"
:openidm-version: 6.2.3
[#chap-install]
Expand All @@ -39,7 +40,7 @@ This section covers what you need to know before running OpenIDM.
[#java-prerequisites]
==== Java Environment
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:
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:
. 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\`.
Expand All @@ -51,7 +52,7 @@ On Windows systems, you must set the `JAVA_HOME` environment variable to point t
. Under System Variables, click New.
. Enter the Variable name (`JAVA_HOME`) and set the Variable value to the JRE installation directory, for example `C:\Program Files\Java\jre7`.
. Enter the Variable name (`JAVA_HOME`) and set the Variable value to the JRE installation directory, for example `C:\Program Files\Java\jre8`.
. Click OK.
Expand All @@ -60,7 +61,7 @@ On Windows systems, you must set the `JAVA_HOME` environment variable to point t
[#application-container-prerequisites]
==== Application Container
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.
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.
Expand All @@ -80,24 +81,24 @@ Follow these steps to install OpenIDM:
[source, console]
----
$ java -version
java version "1.7.0_79"
Java(TM) SE Runtime Environment (build 1.7.0_79-b15)
Java HotSpot(TM) 64-Bit Server VM (build 24.79-b02, mixed mode)
openjdk version "1.8.0_362"
OpenJDK Runtime Environment (Temurin)(build 1.8.0_362-b09)
OpenJDK 64-Bit Server VM (Temurin)(build 25.362-b09, mixed mode)
----
. Download software releases from the link:https://github.com/OpenIdentityPlatform/OpenIDM/releases[GitHub, window=\_blank].
. Unpack the contents of the .zip file into the install location:
+
[source, console]
[source, console, subs="attributes"]
----
$ cd /path/to
$ unzip ~/Downloads/openidm-4.5.1-20.zip
Archive: openidm-4.5.1-20.zip
$ unzip ~/Downloads/openidm-{openidm-version}.zip
Archive: openidm-{openidm-version}.zip
inflating: openidm/.checksums.csv
creating: openidm/bundle/
extracting: openidm/bundle/openidm-audit-4.5.1-20.jar
extracting: openidm/bundle/openidm-audit-{openidm-version}.jar
...
----
Expand Down
4 changes: 3 additions & 1 deletion openidm/modules/install-guide/pages/chap-repository.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,15 @@
:example-caption!:
:table-caption!:
:leveloffset: -1"
:openidm-version: 6.2.3
:openidm-version-short: 6.2
[#chap-repository]
== Installing a Repository For Production
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.
In production environments, OpenIDM 4.5 supports the use of the following internal repositories:
In production environments, OpenIDM {openidm-version-short} supports the use of the following internal repositories:
* MySQL
Expand Down
Loading

0 comments on commit 5125315

Please sign in to comment.