Skip to content
This repository has been archived by the owner on Aug 16, 2019. It is now read-only.

Commit

Permalink
Merge pull request #660 from Basreena/dev
Browse files Browse the repository at this point in the history
sidebar update
  • Loading branch information
Basreena authored Sep 12, 2018
2 parents 4f4387c + 771c6eb commit e7ac14b
Show file tree
Hide file tree
Showing 6 changed files with 91 additions and 78 deletions.
113 changes: 64 additions & 49 deletions _includes/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,14 +224,30 @@ <h4 class="sidebar-group-title">Developer Documentation</h4>
<a href="developer-docs/installation/">Installation</a>
<ul class="sidebar-group">
<li>
<div class="">
<a href="developer-docs/server-installation/">Server Installation 1.9</a>
<ul class="sidebar-group">
<li>
<a href="developer-docs/server-installation/overview/">Overview</a>
</li>
<li>
<a href="developer-docs/server-installation/prerequisites">Prerequisites</a>
</li>
<li>
<a href="developer-docs/server-installation/configuring_installer">Configuring the Installer</a>
</li>
<li>
<a href="eveloper-docs/server-installation/installation">Installation</a>
</li>
<li>
<a href="developer-docs/server-installation/troubleshooting/">Troubleshooting</a>
</li>
</ul>
</div>
</li>
<li>
<a href="developer-docs/installation/developer_installation/">Developer Installation</a>
</li>
<li>
<a href="developer-docs/installation/server_installation/">Server Installation</a>
<<<<<<< HEAD
<li>
<a href="developer-docs/configuring_sunbird/sso_publickey/">SSO Public Key Configuration</a>
</li>
</li>
<li>
<a href="developer-docs/installation/install_mobile_setup/">Mobile App Installation</a>
Expand All @@ -245,67 +261,38 @@ <h4 class="sidebar-group-title">Developer Documentation</h4>
<li>
<a href="developer-docs/upgrade/upgrade_angular_node/">Upgrading Angular</a>
</li>
<li>
<a href="developer-docs/installation/static_pages_to_cdn/">Migrate Tenant Pages</a>
</li>
<li>
<a href="developer-docs/installation/user_channel_migration/">Migrate User Channel</a>
</li>
</ul>
</div>
=======
>>>>>>> 0a904c8ebb93fcd353e49844c246388facb45d84
</li>
<li>
<a href="developer-docs/configuring_sunbird/sso_publickey/">SSO Public Key Configuration</a>
</li>
<li>
<a href="developer-docs/installation/install_mobile_setup/">Mobile App Installation</a>
</li>
<li>
<a href="developer-docs/upgrading/">Upgrading Sunbird</a>
</li>
<li>
<div class="">
<ul class="sidebar-group">
<li>
<a href="developer-docs/upgrade/upgrade_angular_node/">Upgrading Angular</a>
</li>
</ul>
</div>
</li>
<li>
<a href="developer-docs/installation/static_pages_to_cdn/">Migrate Tenant Pages</a>
</li>
<li>

s <li>
<div class="">
<a href="developer-docs/server-installation/">Server Installation 1.9</a>
<a href="developer-docs/configuring_sunbird/">Configuration</a>
<ul class="sidebar-group">
<li>
<a href="developer-docs/server-installation/overview/">Overview</a>
<a href="developer-docs/configuring_sunbird/env_variables_portal/">Portal Service Environment Variables</a>
</li>
<li>
<a href="developer-docs/server-installation/prerequisites">Prerequisites</a>
</li>
<a href="developer-docs/configuring_sunbird/env_variables_content_service/">Content Service Environment Variables</a>
</li>
<li>
<a href="developer-docs/server-installation/configuring_installer">Configuring the Installer</a>
<a href="developer-docs/configuring_sunbird/configuring_email_notification/">Email Notifications</a>
</li>
<li>
<a href="eveloper-docs/server-installation/installation">Installation</a>
</li>
<li>
<a href="developer-docs/server-installation/signup_and_login">Sign up and Login</a>
</li>
<li>
<a href="developer-docs/server-installation/troubleshooting/">Troubleshooting</a>
</li>
</ul>
</div>
</li>
<li>
<div class="">
<a href="developer-docs/configuring_sunbird/">Configuration</a>
<ul class="sidebar-group">
<li>
<a href="developer-docs/configuring_sunbird/env_variables_portal/">Portal Service Environment Variables</a>
<a href="developer-docs/configuring_sunbird/content_checklist_configuration/">Review Checklist</a>
</li>
<li>
<a href="developer-docs/configuring_sunbird/env_variables_content_service/">Content Service Environment Variables</a>
</li>
<li>
<a href="developer-docs/configuring_sunbird/content_filtering/">Content Filtering</a>
</li>
Expand All @@ -315,6 +302,15 @@ <h4 class="sidebar-group-title">Developer Documentation</h4>
<li>
<a href="developer-docs/configuring_sunbird/env_variables_lms/">LMS Service Environment Variables</a>
</li>
<li>
<div class="">
<ul class="sidebar-group">
<li>
<a href="developer-docs/configuring_sunbird/sso_otpsms/">SMS based OTP Configuration</a>
</li>
</ul>
</div>
</li>
</ul>
</div>
</li>
Expand All @@ -340,6 +336,25 @@ <h4 class="sidebar-group-title">Developer Documentation</h4>
</ul>
</div>
</li>
<li>
<div class="">
<a href="developer-docs/how-to-guide/">How to Guides</a>
<ul class="sidebar-group">
<li>
<a href="developer-docs/how-to-guide/how_to_create_organization/">Creating Organization</a>
</li>
<li>
<a href="developer-docs/how-to-guide/how_to_create_user/">Creating Users</a>
</li>
<li>
<a href="developer-docs/how-to-guide/how_to_create_org_add_user/">Mapping Users to Organization</a>
</li>
<li>
<a href="developer-docs/how-to-guide/how_to_create_framework_in_sunbird/">Creating Framework</a>
</li>
<li>
<a href="developer-docs/how-to-guide/how_to_create_badge/">Creating Badges</a>
</li>
<li>
<div class="">
<a href="developer-docs/telemetry/overview/">Telemetry</a>
Expand Down
29 changes: 18 additions & 11 deletions pages/developer-docs/installation/install_mobile_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,15 @@ Unique identifier for the app

Name of the application

<<<<<<< HEAD
## Changing API Configuration
=======
**app_version_code**

Version code for the app release.
>>>>>>> 4f4387cb6f5d9f73a0d320a05df7ad801c416ae2
**App end-point**:
To customize the end points in the app:

Replace redirect base url REDIRECT_BASE_URL and all other base urls with your respective domain name in sunbird.properties

Expand All @@ -50,20 +54,23 @@ Generate the key and secret for mobile_app user using the JWT token of the mobil

* **server folder /where-you-cloned-sunbird-devops-repo/sunbird-devops/deploy/logs/apis.log.*

Please invoke the below API to generate the key and secret for the mobile app:

curl -X POST \ <your-sunbird-base-url>/api/api-manager/v1/consumer/mobile_app/credential/register \
-H 'authorization: Bearer <mobile_admin_jwt_token_from_apis_log_file>' \
-H 'content-type: application/json' \
-d '{
"request": {
"key": "<implementation-name>-mobile-app-<version-number>"
}
}'
Execute the listed API to generate the key and secret for the mobile app:

curl -X POST \ <your-sunbird-base-url>/api/api-manager/v1/consumer/mobile_app/credential/register \
-H 'authorization: Bearer <mobile_admin_jwt_token_from_apis_log_file>' \
-H 'content-type: application/json' \
-d '{
"request": {
"key": "<implementation-name>-mobile-app-<version-number>"
}
}'

Response body:

{"result":{"key":"<implementation-name>-mobile-app-<version-number>","secret":"<secret>"}} Use the value of "key" and "secret" from the response above for MOBILE_APP_KEY and MOBILE_APP_SECRET configuration in respective environments in gradle.properties file. Example:
{"result":{"key":"<implementation-name>-mobile-app-<version-number>","secret":"<secret>"}}

Use the value of "key" and "secret" from the response above for MOBILE_APP_KEY and MOBILE_APP_SECRET configuration in respective environments in gradle.properties file. Example:

**dev_mobile_app_key = "<implementation-name>-mobile-app-<version-number>"
dev_mobile_app_secret = "<secret>"**
Expand Down
6 changes: 4 additions & 2 deletions pages/developer-docs/server-installation/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ allowSearch: true
---

## Installation
This section details the procedures for installing auxilliary services and validating the installation.

This section details the procedures for installing auxilliary services and validating the installation

### Installing Auxilliary Services

Expand Down Expand Up @@ -135,3 +134,6 @@ The Sunbird installation script `./sunbird_install.sh` is a wrapper shell script
* `deploy-badger.sh` - Deploys the badger service as docker service.

* `deploy-core.sh` - Deploys the core services player, content, actor and learner service as docker services. The content, actor and learner service together form the LMS backend.


Signing up on Sunbird is a seamless process. Once you have successfully installed Sunbird on your server, you can create sing up credentials on the portal. For details on signing up on Sunbird, refer <a href="http://www.sunbird.org/features-documentation/signup/" target="_blank">Sign Up on Sunbird</a>
9 changes: 5 additions & 4 deletions pages/developer-docs/server-installation/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This section explains the minimum prerequisites that must be ensured before inst
## API Key

* Sunbird requires EkStep API keys to access the EkStep content repository. For details on how to get access the keys, refer <a href="http://www.sunbird.org/developer-docs/server_installation/ekstep_keys" target="_blank">Ekstep API Keys</a> to get the keys. If you are creating a test environment, get the QA API keys
* Use the key and secret to generate JWT Token. Use the web based tool - http://jwtbuilder.jamiekurtz.com/. Note that when using this tool, the key in the EkStep Developer credentials should be set as the Issuer field and the secret in the Key field
* Use the key and secret to generate JWT. Use the web based tool - http://jwtbuilder.jamiekurtz.com/. Note that when using this tool, the key in the EkStep Developer credentials should be set as the Issuer field and the secret in the Key field

## Domain Name

Expand All @@ -34,15 +34,16 @@ This section explains the minimum prerequisites that must be ensured before inst

#### Cloud Servers

* Supported: AWS and Azure
* Supported Providers: AWS and Azure

* Minimum 2 servers with 7 GB RAM, running Ubuntu server 16.04 LTS
* A general purpose server with 7 GB RAM on Azure, running Ubuntu server 16.04 LTS
* A general purpose server with 8 GB RAM on AWS, running Ubuntu server 16.04 LTS
* You can scale the infrastructure by adding servers. Sunbird is designed to scale horizontally
* The scripts do not work on virtual machines created locally (using VMware/VirtualBox) and have been tested on Azure and AWS VMs

#### Cloud Blob Storage
* Sunbird requires an Azure BLOB storage account, for details on creating an account, refer <a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account" target="_blank">Azure storage account</a>
* This account is used to store QR code images and achievement badges.
* This account is used to store QR code images and achievement badges

#### Operating System
Ubuntu 16.04 LTS (64 bit)
Expand Down
12 changes: 0 additions & 12 deletions pages/developer-docs/server-installation/sign_up_and_login.md

This file was deleted.

0 comments on commit e7ac14b

Please sign in to comment.