After successful installation there are some things worth knowing before starting the server. This article describes the key items.
Start the PhenixID server
- Make sure there is a license file in the license folder. If not please follow this link.
- Locate the Windows service PhenixID Server and select Start, in order to start the service
- The startup sequence can be verified in the server.log and/or events.log
- Make sure there is a license file in the license folder. If not please follow this link
- Start service: [installation path]/PhenixID/Server/bin/sudo ./start-PhenixID.sh
- The startup sequence can be verified in the server.log and/or events.log.
Login into the PhenixID Configuration Manager
NOTE: Modules are deployed the first time the server is started which might take 30-300 seconds. The configuration interface won’t be available until this is complete!
- Access the administration configuration interface via a web browser at https://<hostname_or_ip>:8443/config/
- Login is done using username and password provided during installation
The folder structure after a installation should look like shown below. Base of this folder is referenced as phenixid server root.
Key folders and their purpose are:
- bin – contains startup scripts and configuration files for tuning custom performance. By changing settings in the *.vmoptions files custom boot behavior achieved. Please consult PhenixID support before changing anything in any file
- classes - part of the class path.
- config – contains configuration files. The most important file is the boot.json file, the main bootstrap file. It contains the bare minimum to get the server started. The phenix-store.json contains most PhenixID Server settings. The log4j2.xml file regulates the level of logging in the server. How logging works and is configured is described in detail in separate document which can be found here.
- license – This the location of the license. How to replace the license is described here.
- logs – Contains log files. A more deep documentation for logging can be found here. server.log – contains system information used for troubleshooting. event.log – contains server events like startup, deployment and more
- mods – contains temporary data. Please do not add or remove anything from this directory if not instructed to do so by PhenixID support.
- overlay - where to put graphical customizations.
- data - holds the reporting data and additional "non system configuration".
PhenixID server relies on a bootstrap file, boot.json. It contains initial configuration data used to start the server. File location must be <phenixid server root>/config and may not be changed . Changes to this file should only be done advised by PhenixID support or PhenixID documentation.
After successful login four main headings are available.
The start page is a dashboard for the PhenixID Server which will contain information about the installation, connections and most recent events.
The Reports page provides a number of default reports on system events. It is possible to create custom reports.
PhenixID Server ships with several scenarios to choose from. With these you will be able to create a number of configurations. Each scenario aims to quickly get admins going in terms of MFA. Typical usage is protecting a VPN login or web application SSO .
Once walked through a scenario the result will be found under the heading selected. To edit or delete just select the scenario and all possible options will presented on screen.
The Advanced page is a powerful module used when needing to move outside the capabilities of a Scenario. It gives a total control over the system configuration and is basically a way into the configuration file. Usage of this implies great knowledge about PhenixID server. When in doubt contact PhenixID support.
Backup / Restore
PhenixID server relies on files and folders created during the installation process. Maintain backup of the installation root directory. A recovery simply means replacing the current files and folders with the data from last backup. Replacing single files or directories should only be done if advised by PhenixID support.
Restoring data to the database require additional steps. Depending on the set up these steps may vary.