Required Documents
If you do not have access to online documentation, please verify that you have the following PDF documents, which are part of or are referenced during the installation process.
Tip |
---|
Tip: You should be able to install and configure the using only the Install Guide. However, if you have additional requirements or require further explanation than what is provided in the Install Guide, these documents are important references. |
Info |
---|
NOTE: For AWS Marketplace or Azure Marketplace installs, the content available through the Marketplace should contain all documentation required to complete the installation. |
Document | Starting Online Link | Description |
---|
Planning Guide PDF | Install Planning | Requirements and pre-install preparation for the in your install environment Tip |
---|
Tip: If you have not done so already. please review this Guide and verify requirements against your environment. In particular, please verify the Product Support Matrix and System Requirements sections. |
|
Databases Guide PDF | Install Databases | Install or upgrade the for one of the supported database versions. |
Install Guide PDF | Install Overview | Instructions for installing the software and configuring it for basic operations Info |
---|
NOTE: There are separate Install Guides for each supported infrastructure. Please verify that you are using the appropriate one. |
|
Configuration Guide PDF | Configure | Configure integrations with running environments, backend storage, and other data sources, as well as instructions for configuring the |
Admin Guide PDF | Admin | For the installation process, this Guide contains useful topics on backup and recovery and verifying operations of the . |
User Guide PDF | Workflow Basics | After installation and configuration is complete, this Guide can be helpful for references on how to use the product. |
Basic Install Workflow
- Prepare the environment for your installation scenario.
- Install the software.
- Install the databases.
- Start the platform and login.
- Configure your installation.
- Verify operations.
The install workflow is described in detailed in the page for your installation scenario.
Noprint |
---|
Installation ScenariosThe following installation scenarios are supported for unless otherwise noted:Install On-PremisesInstallation of within your enterprise's infrastructure. See Install On-Premises.Install for AWSInstallation of on Amazon Web Services in an environment that you manage. For more information, see Install for AWS.Install for AzureInstallation of on Microsoft Azure in an environment that you manage. For more information, see Install for Azure.Install for DockerYou can install using a Docker image that you download, or if your environment requires special configuration, you can build your own Docker image. See Install for Docker. |
Install Errata
Notation
In this guide, JSON settings may be provided in dot notation in either of the following forms.
For example, webapp.selfRegistration
refers to a JSON block selfRegistration
under webapp
:
Form 1:
Code Block |
---|
{
...
"webapp": {
"selfRegistration": true,
...
}
...
} |
Form 2:
Code Block |
---|
"webapp.selfRegistration": true, |