Stars End
Edit this page

Prime Radiant Installation

A new installation of Prime Radiant.

Download Full Application

  1. Download Prime Radiant zip from a release.
  2. Unpack the zip to e.g. C:\primeradiant
    • you can place the installation directory anywhere (if you choose to do so, modify the next steps accordingly)

If you don’t have any local NSF directory either, download one from the same release page and unzip it to C:\NSF (or elsewhere, but adjust nsfBase configuration further).

Create Postgres Database

  1. Create a primeRadiant Postgres database (the name can be anything, but adjust further configuration accordingly).
  2. Import primeradiant/dist/data/sql/0000_provision_db.sql

Edit Local Configuration

  1. Open primeradiant/config/custom_vars.bat (or custom_vars.sh for Linux and Mac).
  2. (Required) Configure DATABASE_* options to match your local setup
    • if you are upgrading and don’t see these options, download a Full Application zip, and copy the options from there
  3. (Optional for Windows, Required for Linux/Mac) ensure that JAVA_HOME and MAVEN_BIN point to valid locations
    • For Windows, we recommend leaving both variables undefined; instead use use system configuration (global JAVA_HOME variable, and mvn available in PATH)
  4. Adjust the rest of configuration to your liking

Configure NSF Bases

  1. (Optional for Windows, Required for Linux/Mac) Open primeradiant/config/nsfBases.xml
    • Add or modify Nsf Bases to your liking. You can have multiple Nsf Bases, e.g. one for workspace, several for deployment, etc. See NsfBases for more info.
  2. At least one NsfBase must contain a pre-configured expand base
    • For example, create the following file C:\NSF\primespace\expansionsPR\expandBase.xml 
      <expandBase name="Expansions 3.0 - PR">
   <baseRoot>expansionsPR</baseRoot>
   <useAppId value="false"/>
   <description>-</description>
 </expandBase>

Launch Prime Radiant

On Windows

# or double-click the file from Explorer
C:\primeradiant\PrimeRadiant.bat

On Linux/Mac

# only if not already executable
chmod +x primeradiant/PrimeRadiant.sh

./primeradiant/PrimeRadiant.sh

Execute Internal Upgrade

NOTE: This step is required both for new installations, as well as every time an installation is upgraded.

Finally, you must execute upgrade/installation steps from within Prime Radiant.

  1. Open Prime Radiant in your browser http://localhost:9000/primeRadiant/
    • (Optional) If you customized PRIME_RADIANT_BASE_PORT in custom_vars.bat, adjust the url accordingly
  2. Log in
    • default credentials are admin/testAdmin
  3. Navigate to PrimeBase page (Upgrade on Dashboard, via menu Upgrading > PrimeBase, or http://localhost:9000/primeRadiant/elements/primeBase/all)
  4. Select the available PrimeBase, click Update All, and wait for everything to finish
    • For more information on this page, see PrimeBase.
  5. Navigate to NsfBase page (via menu Upgrading > NsfBase, or http://localhost:9000/primeRadiant/elements/nsfBase/all)
    • Here you see all NsfBases configured in C:\primeradiant\config\nsfBases.xml, and additionally dist (internal distribution base).
  6. Click on Synchronize All button
    • Synchronize (All) scan NsfBase(s) and looks for all existing sourceBases (projects), expandBases (expansions), and deployBases (servers)
    • Prime Radiant console window also lists all found entries
    • Rerun this action when you add/remove new entries, such as cloning a new project to your workspace

Your Prime Radiant is now fully operational.