Installing Sunbird Portal on Local Laptop or Desktop

Edit | Report


Before you install Sunbird on your laptop, examine your environment and gather data to ensure an optimal installation experience. Review the following to ensure that the environment has the necessary resources and compliant target systems to successfully install and run Sunbird.

System Requirements

To install Sunbird, your laptop or desktop must have the following minimum system requirements:

  • Operating System: Windows 7 and above or 4.2 Mac OS or 10.0 and above/Linux
  • RAM: >1.5GB
  • CPU: 2 cores, >2 GHz

Sunbird has two primary software components:

  • Sunbird portal or web application
  • Sunbird services stack or the backend API interface.

Sunbird Portal Setup

To set up the Sunbird portal successfully, follow these steps sequentially:

  1. Check the prerequisites
  2. Follow setup instructions
  3. Configure the backend service stack
  4. Edit the application config file
  5. Run the application


Check for the following before installing and running the Sunbird-player application:

  1. Software dependencies
    • Node - install the latest release of 6.x.x LTS series
    • Gulp- latest version of gulp: npm install -g gulp-cli
    • nodemon - Latest version of nodemon: npm install -g nodemon
  2. API Keys To let sunbird portal communicate with other services, if API keys are required then it needs to be generated from user side.

    Note: For setting up portal locally. while installing all the services , a JWT token should have been generated, present by the name “jwt_token_player.txt”


    For setting up the application, check out the code. The code can be checked out via the command:

    git clone

    Note: Stable versions of the sunbird portal are available via tags for each release, and the master branch contains latest stable release. For latest stable release refer Once the git clone command is over, run the following set of commands:

    $ cd {PROJECT-FOLDER}/src/app $ npm install $ gulp download:editors $ cd {PROJECT-FOLDER}/src/app/client $ npm install

    Configuring the Environment and Services Stack

  3. Configure the following system environment variables in the terminal which you have opened | Environment Variable | Value | Data Type | |—————————|———|———–| | sunbird_environment | local | string | | sunbird_instance | sunbird | string | | sunbird_default_channel | sunbird | string | | sunbird_default_tenant | sunbird | string |

    The initialization of these environmental variables can take place in a common place like in your .bashrc or .bash_profile

    Configure Backend Service Stack

    The Sunbird portal application is powered by a set of Service APIs. These Service API(s) run in a distributed environment.For instance, deploying the Sunbird to production; but for the sake of simplicity and ease of debugging, you can also run these service API(s) locally on a single server. For now, let us configure the Sunbird portal to use a cloud instance of the Sunbird Service API(s).These APIs are hosted by project Sunbird and are used for testing and demonstration purposes. Note: The cloud instance of the API(s) hosted by Project Sunbird are not for production usage.

    Edit the Application Config

    Open <PROJECT-FOLDER>/src/app/helpers/environmentVariablesHelper.js in any available text editor. Once the file opens, update the contents of the file so that it contains exactly the following values: module.exports = { // 1. LEARNER_URL
    LEARNER_URL: env.sunbird_learner_player_url || <’https://<host for adopter’s instance>’,
    // 2. CONTENT_URL CONTENT_URL: env.sunbird_content_player_url || <’https://<host for adopter’s instance>’,
    CONTENT_PROXY_URL: env.sunbird_content_proxy_url || <’https://<host for adopter’s instance>’,
    PORTAL_REALM: env.sunbird_portal_realm || ‘sunbird’, // 4. PORTAL_AUTH_SERVER_URL PORTAL_AUTH_SERVER_URL: env.sunbird_portal_auth_server_url || <’https://<host for adopter’s instance>’,
    PORTAL_AUTH_SERVER_CLIENT: env.sunbird_portal_auth_server_client || “portal”, … PORTAL_PORT: env.sunbird_port || 3000,

     // 5. PORTAL_API_AUTH_TOKEN     
     PORTAL_API_AUTH_TOKEN: env.sunbird_api_auth_token || User generated API auth token
     PORTAL_ECHO_API_URL: env.sunbird_echo_api_url || '',                                                       
     ...  } Once the file is updated with appropriate values, then you can proceed with running the application.           

Run the Application

  1. Update the Sunbird application with the modified configuration file values. Run the following command in the {PROJECT-FOLDER}/src/app/client folder:
  2. Wait for the following message before proceeding to the next step
     [nodemon] clean exit - waiting for changes before restart
  3. Run the following commands in your console (CLI): $ cd {PROJECT-FOLDER}/src/app $ node server.js
  4. After executing the commands, open http://localhost:3000 in browser.

Edit | Report