Portal Manager Deployment
The FlexiPortal Manager is a DHIS2 application that allows administrators to configure and manage the Public Portal. This guide provides instructions for deploying the Portal Manager application.
Deployment Options
The Portal Manager can be deployed in two main ways:
- From DHIS2 App Hub - Installed directly on your DHIS2 instance through the app hub
- Manual install - Installed by downloading the app from the releases pabe
Deploying as a DHIS2 App
Prerequisites
- Access to a DHIS2 instance with administrative privileges
- DHIS2 version 2.40 or later
Installation from DHIS2 App Hub
-
Log in to your DHIS2 instance as an administrator
-
Navigate to App Management (Apps > App Management)
-
Navigate to Custom apps
-
Search for
FlexiPortal Manager
application -
Click on install
-
After installation, the
FlexiPortal Manager
should appear in your DHIS2 app menu. Click on it to launch the application.
Manual Installation Steps
-
Download the App
Download the latest version of the Portal Manager app from the releases page or build it yourself.
-
Upload to DHIS2
a. Log in to your DHIS2 instance as an administrator
b. Navigate to App Management (Apps > App Management)
c. Click on "Upload App"
d. Select the downloaded .zip file
e. Click "Upload"
-
Verify Installation
After installation, the Portal Manager should appear in your DHIS2 app menu. Click on it to launch the application.
Deploying to Development DHIS2 Instance
For development purposes, you can deploy directly to a DHIS2 instance:
-
Configure Environment Variables
Create a
.env
file in theapps/manager
directory with:DHIS2_BASE_URL=https://your-dhis2-instance.org
-
Deploy
cd apps/manager
yarn deploy --username YOUR_USERNAME https://your-dhis2-instance.orgYou will be prompted for your password.
Troubleshooting
If you encounter issues with the Portal Manager deployment:
-
Check DHIS2 Version Compatibility
Ensure your DHIS2 instance is version 2.40 or later.
-
Verify Permissions
Make sure your DHIS2 user has the necessary permissions to install apps and access the required API endpoints.
-
Check Browser Console
If the app loads but doesn't function correctly, check your browser's developer console for errors.