Skip to content

Latest commit

 

History

History
182 lines (117 loc) · 7.37 KB

README.md

File metadata and controls

182 lines (117 loc) · 7.37 KB
Raw

WSO2 Identity Server Apps

End-user apps in WSO2 Identity Server

Branch Build Status Travis CI Status
master Build Status Build Status

Stackoverflow Discord License Twitter

Prerequisite

Setup Development Environment

  1. Install NodeJS LTS(Latest Stable Version) from https://nodejs.org/en/download/.

  2. Install pnpm.

    Note: Due to lockfile compatibility issue, pnpm v8.0.0 and above are currently not supported.

    corepack prepare [email protected] --activate

    Or, follow the other recommended installation options.

  3. Install Maven from https://maven.apache.org/download.cgi.

  4. Install JDK 11 https://www.openlogic.com/openjdk-downloads.

Download WSO2 Identity Server

In order to setup this repository locally, you need to have WSO2 Identity Server installed on your local environment.

We recommend you to download the latest release or build the product-is from source.

Setup WSO2 Identity Server

Allow CORS Origins

Add the following code to repository/conf/deployment.toml in WSO2 Identity Server distribution pack to allow CORS.

[cors]
allowed_origins = [
    "https://localhost:9000",
    "https://localhost:9001"
]
supported_methods = [
    "GET",
    "POST",
    "HEAD",
    "OPTIONS",
    "PUT",
    "PATCH",
    "HEAD",
    "DELETE",
    "PATCH"
]
exposed_headers = [ "Location" ]

Configure FIDO2 origins

Add your hostname and port as a trusted FIDO2 origin to the deployment.toml file as given below.

[fido.trusted]
origins=["https://localhost:9000"]

Make Applications Editable

Currently, Console & My Account are considered as system applications hence they are readonly by default. In order configure them, you need to add the following config to the deployment.toml file to override the default behavior.

[system_applications]
read_only_apps = []

Start the Identity Server

Now you can go ahead and start the Identity Server that was downloaded in the Prerequisites step.

For instructions on startup, read the docs.

Go to Management Console

Navigate to the Management Console i.e https://localhost:9443/carbon/ from the browser, and login to the system by entering an admin password.

💡 You can find out the default password details here: https://docs.wso2.com/display/ADMIN44x/Configuring+the+System+Administrator

Configure Callback URLs

In the Management Console, navigate to Service Providers -> List from left side panel. And then go to Edit option in the application that you want to configure in dev mode (ex: MY_ACCOUNT). Then click on Inbound Authentication Configuration -> OAuth/OpenID Connect Configuration -> Edit. And then update the Callback Url field with below corresponding values.

Console
regexp=(https://localhost:9443/console|https://localhost:9443/t/(.*)/console|https://localhost:9443/console/login|https://localhost:9443/t/(.*)/console/login|https://localhost:9001/console|https://localhost:9001/t/(.*)/console|https://localhost:9001/console/login|https://localhost:9001/t/(.*)/console/login)
My Account
regexp=(https://localhost:9443/myaccount|https://localhost:9443/t/(.*)/myaccount|https://localhost:9443/myaccount/login|https://localhost:9443/t/(.*)/myaccount/login|https://localhost:9000/myaccount|https://localhost:9000/t/(.*)/myaccount|https://localhost:9000/myaccount/login|https://localhost:9000/t/(.*)/myaccount/login)

Build & Run

Build

Clone or download the Identity Apps repository and run the following commands from the command line in the project root directory (where the package.json is located) to build all the packages with dependencies.

# From project root.
mvn clean install

Run

To start the apps in development mode, execute the following commands accordingly.

Console

# To start Console
cd apps/console
pnpm start

Once the development server is live, you can access the application via https://localhost:9001/console.

My Account

# To start My Account
cd apps/myaccount
pnpm start

Once the development server is live, you can access the application via https://localhost:9000/myaccount.

Configuration

The portals i.e. Console & My Account are configurable using the deployment.toml when they are hosted inside the Identity Server. Read through our configurations guidelines to learn about the configuration process.

Deployment

Go through our deployment guide to learn the different supported app deployment options.

Connectors

Go through our connectors guide to learn how to handle connectors in the Identity Server Console.

Troubleshoot

Go through our troubleshooting guide to clarify and issues you encounter.

If the issue you are facing is not on the existing guide, consider reaching out to us on slack, stackoverflow threads or by creating an issue as described in Reporting Issues.

Contributing

Go through our contributing guideline to get an understanding about our contribution process and other necessary instructions.

Reporting Issues

We encourage you to report issues, improvements and feature requests regarding the project through GitHub Issue Tracker.

Important: And please be advised that, security issues must be reported to [email protected], not as GitHub issues, in order to reach proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues.

License

Licenses this source under the Apache License, Version 2.0 (LICENSE), You may not use this file except in compliance with the License.

(c) Copyright 2022 WSO2 LLC.