Genero Identity Platform StarterApp reference

The StarterApp configures the Genero Identity Platform (GIP) running on a Genero Application Server (GAS).

Before you can use the GIP, you must configure the GIP. The StarterApp configures the GIP.

If you are setting up the GIP for the first time, follow the instructions here: Configure the primary Genero Identity Provider.

If your architecture involves multiple GAS servers, you initially set up the primary GIP on one GAS. After the initial configuration, you then configure external GIPs on the other GAS servers to link to that initial setup.

The remainder of this topic serves as a complete reference to the StarterApp. Its purpose is to provide you with the detail behind each decision you are asked to make while using the StarterApp.

Starting the StarterApp

To start the StarterApp, enter the StarterApp URL:

http[s]://host:port[/gas]/ua/r/idp/StarterApp

Tip:

The square brackets around the [/gas] element of the URL indicates that it is optional. In development, you may be using the httpdispatch standalone dispatcher. For the standalone dispatcher, the StarterApp URL is:

http[s]://host:port/ua/r/idp/StarterApp

Tip:

You can access the StarterApp from the demos page for the GAS, however you must have started the demos page using a valid hostname instead of localhost.

Completing the StarterApp forms

If you are configuring a fresh installation of the GIP, you will complete two forms:

The Genero IDP first installation form. See Table 1.
The Genero Identity Provider Installation form is based on the installation mode selected.
- For a local mode installation (which sets up the primary GIP), see Table 2.
- For an external mode installation (which sets up an external GIP), see Table 3

Table 1. Genero IDP first installation
Configuration option	Instruction
	Select "Local" if you are configuring the GIP: for a GAS sitting behind a web server, when you are on the same machine as the web server and GAS. for a standalone GAS dispatcher (httpdispatch). Select "External" if you are in a multi-GAS environment, and the primary GIP has already been configured for a GAS on an external machine.

Table 2. Genero Identity Platform Installation (local mode)
Configuration option	Instruction
	Create the GIP administrator account. This account has access to GIP components, such as the Console App and Deployment App.
	The GIP uses the OAuth password when generating OAuth secret IDs. For example, when deploying and securing applications, the GIP uses this password to compute the `SECRET ID`. Safely store the OAuth password entered here, in case of system failure. Restoring it later will allow you to re-create all secret ids of the OAuth protocol.
	The Base URL is the base URL for the Genero Application Server. The StarterApp computes the default URL from the address of the GAS running the StarterApp. If the GAS is configured with a web server in HTTPS, the base URL will use the HTTPS protocol. HTTPS is preferred for GIP. You can typically accept the default URL. Edit this setting if you intend the GIP to use a different GAS.
	The profile service is a component of GIP that maintains user data for registered users on the GIP, such as name, date of birth, email address, etc. Select "None" if you do not want to install the user profile service. Select "Integrated" if installing the user profile service on the same host as the GIP. This is the default option. Select "External" if you have installed the user profile service on another machine, and need to provide the URL to the service.
	The IDP database stores all permissions managed by the GIP. By default, the GIP creates a SQLite database. Note: You may wish to use a more robust database in your production environment; however, if the SQLite file is on a physical disk (as apposed to a network disk) and concurrent access is working, you should not have an issue if there are not too many users. To use another Genero-supported database, select the vendor from the Database combobox and provide the database details in the fields that display.
	When using an integrated user profile service, the User info database stores the details for each user profile. By default, the GIP creates a SQLite database. Note: You may wish to use a more robust database in your production environment; however, if the SQLite file is on a physical disk (as apposed to a network disk) and concurrent access is working, you should not have an issue if there are not too many users. To use another Genero-supported database, select the vendor from the Database combobox and provide the database details in the fields that display.
	"Deployment service" are a set of services required by the GAS to manage Genero Archive (gar), and GBC. This option is selected by default. The service is used by the Deployment App and the command line tools that use its micro services to deploy. Select "Deployment app" to install the GUI tool that connects to the Deployment services. It provides an alternative to using command line tools for deploying GAR and GBC. Tip: In a multi-GAS set up, the Deployment App can be on one machine. You just need to ensure the Deployment services are running on the machines you want it to deploy to. Select "Shared file demo" to view a demo of the shared file microservice. If you opt not to install this now, you can install it by hand on the GAS, or deploy it in the GIP as a new application using the Deployment App later. Reading the topic Deploying and securing applications and web services can help you understand this process.

Table 3. Genero Identity Platform Installation (external mode)
Configuration option	Instruction
	When you select the External radio button, an Edit field appears. Enter the URL of the Genero Identity Provider (which has been installed on a separate GAS): http[s]://`host`:`port`/[gas/]ws/r/services/GeneroIdentityProvider When you click Ok, a second form opens.
	For the GAS base URL, enter the URL of the GAS you are currently configuring. Typically, you can accept the default base URL as the StarterApp automatically computes this from the address of the GAS you run the app from. If the GAS is configured with a web server in HTTPS, the base URL will use the HTTPS protocol. HTTPS is preferred for GIP.
	Under Additional features, select the services and apps you want to install on this local GAS. They will be protected by the external GIP specified in the first step. "Deployment service" are a set of services required by the GAS to manage Genero Archive (gar), and GBC. This option is selected by default. The service is used by the Deployment App and the command line tools that use its micro services to deploy. Select "Deployment app" to install the GUI tool that connects to the Deployment services. It provides an alternative to using command line tools for deploying GAR and GBC. Tip: In a multi-GAS set up, the Deployment App can be on one machine. You just need to ensure the Deployment services are running on the machines you want it to deploy to. Select "Shared file demo" to install the demo of the shared file microservice.