upload OpenDJ docs after deploy c19cb1ec29359a2f63f32753c54b837cb6998187

Author: Open Identity Platform Community

opendj/modules/ROOT/attachments/Example.ldif

@@ -0,0 +1,38 @@
+# The contents of this file are subject to the terms of the Common Development and
+# Distribution License (the License). You may not use this file except in compliance with the
+# License.
+#
+# You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+# specific language governing permission and limitations under the License.
+#
+# When distributing Covered Software, include this CDDL Header Notice in each file and include
+# the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+# Header, with the fields enclosed by brackets [] replaced by your own identifying
+# information: "Portions Copyright [year] [name of copyright owner]".
+#
+# Portions Copyright 2015 ForgeRock AS.
+
+# Captured dsconfig command to replace anonymous read access with authenticated access.
+# Edit this script to match your deployment.
+#
+# This command does not affect global-aci properties allowing anonymous access
+# to read the root DSE and to read directory schema definitions,
+# nor to use selected LDAP controls and extended operations.
+#
+# This command works against a server built following the changes introduced
+# in http://sources.forgerock.org/changelog/opendj?cs=9325.
+# If the global-aci settings are different on your OpenDJ server,
+# generate this script for that server as described in the documentation.
+#
+dsconfig set-access-control-handler-prop \
+          --remove global-aci:\(targetattr!=\"userPassword\|\|authPassword\|\|debugsearchindex\|\|changes\|\|changeNumber\|\|changeType\|\|changeTime\|\|targetDN\|\|newRDN\|\|newSuperior\|\|deleteOldRDN\"\)\(version\ 3.0\;\ acl\ \"Anonymous\ read\ access\"\;\ allow\ \(read,search,compare\)\ userdn=\"ldap:///anyone\"\;\) \
+          --remove global-aci:\(targetattr=\"createTimestamp\|\|creatorsName\|\|modifiersName\|\|modifyTimestamp\|\|entryDN\|\|entryUUID\|\|subschemaSubentry\|\|etag\|\|governingStructureRule\|\|structuralObjectClass\|\|hasSubordinates\|\|numSubordinates\"\)\(version\ 3.0\;\ acl\ \"User-Visible\ Operational\ Attributes\"\;\ allow\ \(read,search,compare\)\ userdn=\"ldap:///anyone\"\;\) \
+          --add global-aci:\(targetattr!=\"userPassword\|\|authPassword\|\|debugsearchindex\|\|changes\|\|changeNumber\|\|changeType\|\|changeTime\|\|targetDN\|\|newRDN\|\|newSuperior\|\|deleteOldRDN\"\)\(version\ 3.0\;\ acl\ \"Authenticated\ read\ access\"\;\ allow\(read,search,compare\)\ userdn=\"ldap:///all\"\;\) \
+          --add global-aci:\(targetattr=\"createTimestamp\|\|creatorsName\|\|modifiersName\|\|modifyTimestamp\|\|entryDN\|\|entryUUID\|\|subschemaSubentry\|\|etag\|\|governingStructureRule\|\|structuralObjectClass\|\|hasSubordinates\|\|numSubordinates\"\)\(version\ 3.0\;\ acl\ \"User-Visible\ Operational\ Attributes\"\;\ allow\(read,search,compare\)\ userdn=\"ldap:///all\"\;\) \
+          --hostname opendj.example.com \
+          --port 4444 \
+          --trustStorePath /path/to/opendj/config/admin-truststore \
+          --bindDN cn=Directory\ Manager \
+          --bindPassword ****** \
+          --no-prompt
+

opendj/modules/ROOT/attachments/captured-global-aci-edits.sh

@@ -0,0 +1,39 @@
+////
+
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions Copyright [year] [name of copyright owner]".
+
+  Copyright 2015 ForgeRock AS.
+  Portions Copyright 2024 3A Systems LLC.
+
+////
+
+== Attributes
+The optional attribute list specifies the attributes to return in the entries found
+by the search. In addition to identifying attributes by name such as `cn sn mail`
+and so forth, you can use the following notations, too.
+--
+
+`*`::
+Return all user attributes such as `cn`, `sn`, and `mail`.
+
+`+`::
+Return all operational attributes such as `etag` and `pwdPolicySubentry`.
+
+`@objectclass`::
+Return all attributes of the specified object class, where __objectclass__ is one of the object classes on the entries returned by the search.
+
+`1.1`::
+Return no attributes, only the DNs of matching entries.
+
+--
+

opendj/modules/ROOT/partials/_attributes.adoc

@@ -0,0 +1,37 @@
+////
+
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions Copyright [year] [name of copyright owner]".
+
+  Copyright 2015-2016 ForgeRock AS.
+  Portions Copyright 2024 3A Systems LLC.
+
+////
+
+== Examples
+The following example displays index information.
+
+[source, console]
+----
+$ bin/backendstat dump-index  -n userRoot -b dc=example,dc=com -i id2childrencount 
+
+    Key (len 2): 1#52
+    Value (len 8): 1
+    Key (len 2): 2#52
+    Value (len 8): 500000
+    Key (len 9): Total Children Count
+    Value (len 8): 500001
+
+    Total Records: 3
+    Total / Average Key Size: 13 bytes / 4 bytes
+    Total / Average Data Size: 24 bytes / 8 bytes
+----

opendj/modules/ROOT/partials/_backendstat-examples.adoc

@@ -0,0 +1,55 @@
+////
+
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions Copyright [year] [name of copyright owner]".
+
+  Copyright 2015-2016 ForgeRock AS.
+  Portions Copyright 2024 3A Systems LLC.
+
+////
+
+== Examples
+
+The following example backs up all user data while the server is online.
+
+[source, console]
+----
+$ backup -p 4444 -D "cn=Directory Manager" -w password \
+ -a -d /path/to/opendj/bak -t 0
+Backup task 20110613143801866 scheduled to start ...
+----
+The following example schedules back up of all user data every night at 2 AM when the server is online, and
+notifies \[email protected] when finished, or on error.
+
+[source, console]
+----
+$ backup -p 4444 -D "cn=Directory Manager" -w password -a \
+ -d /path/to/opendj/bak --recurringTask "00 02 * * *" \
+ --completionNotify [email protected] --errorNotify [email protected]
+Recurring Backup task BackupTask-988d6adf-4d65-44bf-8546-6ea74a2480b0
+scheduled successfully
+----
+The following example backs up all user data while the server is offline.
+
+[source, console]
+----
+$ stop-ds
+Stopping Server...
+...
+
+$ backup --backupAll --backupDirectory /path/to/opendj/bak
+... msg=The backup process completed successfully
+
+$ start-ds
+... The Directory Server has started successfully
+----
+

opendj/modules/ROOT/partials/_backup-examples.adoc

@@ -0,0 +1,40 @@
+////
+
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions Copyright [year] [name of copyright owner]".
+
+  Copyright 2015-2016 ForgeRock AS.
+  Portions Copyright 2024 3A Systems LLC.
+
+////
+
+== Examples
+The following command shows the changes from the external change log
+in human-readable format.
+
+
+[source]
+----
+$ base64 decode -d YWRkOiBkZXNjcmlwdGlvbgpkZXNjcmlwdGlvbjogQSB0aGlyZCBjaGFuZ2UK\
+LQpyZXBsYWNlOiBtb2RpZmllcnNOYW1lCm1vZGlmaWVyc05hbWU6IGNuPURpcmVjdG9yeSBNYW5hZ2V\
+yLGNuPVJvb3QgRE5zLGNuPWNvbmZpZwotCnJlcGxhY2U6IG1vZGlmeVRpbWVzdGFtcAptb2RpZnlUaW\
+1lc3RhbXA6IDIwMTEwNjEzMDcxMjEwWgotCg==
+add: description
+description: A third change
+-
+replace: modifiersName
+modifiersName: cn=Directory Manager,cn=Root DNs,cn=config
+-
+replace: modifyTimestamp
+modifyTimestamp: 20110613071210Z
+-
+----

opendj/modules/ROOT/partials/_base64-examples.adoc

@@ -0,0 +1,26 @@
+////
+
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions Copyright [year] [name of copyright owner]".
+
+  Copyright 2015-2016 ForgeRock AS.
+  Portions Copyright 2024 3A Systems LLC.
+
+////
+
+== Examples
+The following example starts the Control Panel on a remote host.
+
+[source, console]
+----
+$ control-panel -r -h opendj.example.com -p 4444 &
+----

opendj/modules/ROOT/partials/_control-panel-examples.adoc

@@ -0,0 +1,28 @@
+////
+
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions Copyright [year] [name of copyright owner]".
+
+  Copyright 2015-2016 ForgeRock AS.
+  Portions Copyright 2024 3A Systems LLC.
+
+////
+
+== Examples
+The following example adds a script to start OpenDJ at boot time on a Debian-based system,
+and then updates the runlevel system to use the script.
+
+[source, console]
+----
+$ sudo create-rc-script -f /etc/init.d/opendj -u opendj-user
+$ sudo update-rc.d opendj
+----

opendj/modules/ROOT/partials/_create-rc-script-examples.adoc

@@ -0,0 +1,124 @@
+////
+
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions Copyright [year] [name of copyright owner]".
+
+  Copyright 2015-2016 ForgeRock AS.
+  Portions Copyright 2024 3A Systems LLC.
+
+////
+
+The `dsconfig` command provides many subcommands.
+
+Subcommands let you create, list, and delete entire configuration components, and also let you get and set component properties. Subcommands therefore have names that reflect these five actions.
+
+* create-__component__
+
+* list-__component__s
+
+* delete-__component__
+
+* get-__component__-prop
+
+* set-__component__-prop
+
+Here, __component__ names are names of managed object types. Subcommand __component__ names are lower-case, hyphenated versions of the friendly names. When you act on an actual configuration component, you provide the name of the component as an option argument.
+For example, the Log Publisher component has these corresponding subcommands.
+
+* `create-log-publisher`
+
+* `list-log-publishers`
+
+* `delete-log-publisher`
+
+* `get-log-publisher-prop`
+
+* `set-log-publisher-prop`
+
+When you create or delete Log Publisher components and when you get and set their configuration properties, you provide the name of the actual log publisher, which you can find by using the `list-log-publishers` subcommand.
+
+[source, console]
+----
+$ dsconfig \
+ list-log-publishers \
+ --hostname opendj.example.com \
+ --port 4444 \
+ --bindDN "cn=Directory Manager" \
+ --bindPassword password \
+ --trustAll
+
+Log Publisher                 : Type                   : enabled
+------------------------------:------------------------:--------
+File-Based Access Logger      : file-based-access      : true
+File-Based Audit Logger       : file-based-audit       : false
+File-Based Debug Logger       : file-based-debug       : false
+File-Based Error Logger       : file-based-error       : true
+File-Based HTTP Access Logger : file-based-http-access : false
+Replication Repair Logger     : file-based-error       : true
+
+$ dsconfig \
+ get-log-publisher-prop \
+ --publisher-name "File-Based Access Logger" \
+ --property rotation-policy \
+ --hostname opendj.example.com \
+ --port 4444 \
+ --bindDN "cn=Directory Manager" \
+ --bindPassword password \
+ --trustAll
+Property        : Value(s)
+----------------:--------------------------------------------------------------
+rotation-policy : 24 Hours Time Limit Rotation Policy, Size Limit Rotation
+                : Policy
+----
+Many subcommands let you set property values. Notice in the reference for the subcommands below that specific options are available for handling multi-valued properties. Whereas you can assign a single property value by using the `--set` option, you assign multiple values to a multi-valued property by using the `--add` option. You can reset the values of the multi-valued property by using the `--reset` option.
+Some property values take a time duration. Durations are expressed as numbers followed by units. For example `1 s` means one second, and `2 w` means two weeks. Some durations have minimum granularity or maximum units, so you cannot necessary specify every duration in milliseconds or weeks for example. Some durations allow you to use a special value to mean unlimited. Units are specified as follows.
+
+* `ms`: milliseconds
+
+* `s`: seconds
+
+* `m`: minutes
+
+* `h`: hours
+
+* `d`: days
+
+* `w`: weeks
+
+Use the following options to view help for subcommands.
+--
+
+`dsconfig --help-all`::
+Display all subcommands
+
+`dsconfig --help-core-server`::
+Display subcommands relating to core server
+
+`dsconfig --help-database`::
+Display subcommands relating to caching and back-ends
+
+`dsconfig --help-logging`::
+Display subcommands relating to logging
+
+`dsconfig --help-replication`::
+Display subcommands relating to replication
+
+`dsconfig --help-security`::
+Display subcommands relating to authentication and authorization
+
+`dsconfig --help-user-management`::
+Display subcommands relating to user management
+
+--
+For help with individual subcommands, either use `dsconfig subcommand --help`, or start `dsconfig` in interactive mode, without specifying a subcommand.
+
+To view all component properties, use the `dsconfig list-properties` command.