This is the UI for the Canonical Identity Platform.
To create a binary with the UI you need to run:
make npm-build buildPlease don't run them in parallel, build requires the target cmd/ui/dist
which, unless the js code has been build independently, requires npm-build
If you want to skip the npm-build make sure the js artifacts are in
the ui/dist folder (check the Makefile for more advanced information).
This will:
- build the
jscode - produce a binary called
appwhich you can run with:
PORT=<port number> ./cmd/appCode dealing with the environment variables resides in here where each attribute has an annotation which is the lowercase of the environment variable name.
At the moment the application is sourcing the following from the environment:
OTEL_GRPC_ENDPOINT- needed if we want to use the OTel gRPC exporter for tracesOTEL_HTTP_ENDPOINT- needed if we want to use the OTel HTTP exporter for traces (if gRPC is specified this gets unused)TRACING_ENABLED- switch for tracing, defaults to enabled (true)LOG_LEVEL- log level, defaults toerrorLOG_FILE- log file which the log rotator will write into. default tolog.txt. Make sure application user has permissions to write.PORT- HTTP server port, defaults to8080BASE_URL- the base url that the application will be running onKRATOS_PUBLIC_URL- address of Kratos Public APIsKRATOS_ADMIN_URL- address of Kratos Admin APIsHYDRA_ADMIN_URL- address of Hydra admin APIsOPENFGA_API_SCHEME- the OpenFGA API schemeOPENFGA_API_HOST- the OpenFGA API host nameOPENFGA_STORE_ID- the OpenFGA store ID to useOPENFGA_MODEL_ID- the OpenFGA model ID to use. If not specified, a new model will be createdMFA_ENABLED- whether MFA is enabled and enforced, defaults to true
To build the UI OCI image, you need rockcraft. To install rockcraft run:
sudo snap install rockcraft --channel=latest/edge --classicTo build the image:
rockcraft packIn order to run the produced image with docker:
# Import the image to Docker
sudo /snap/rockcraft/current/bin/skopeo --insecure-policy \
copy oci-archive:./identity-platform-login-ui_0.1_amd64.rock \
docker-daemon:localhost:32000/identity-platform-login-ui:registry
# Run the image
docker run -d \
-it \
--rm \
-p 8080:8080 \
--name login-ui \
localhost:32000/identity-platform-login-ui:registry start login-uiTo try the identity-platform login UI, you can use the docker-compose.yml.
Please install docker and docker-compose.
You need to have a registered GitHub OAuth application to use for logging in. To register a GitHub OAuth application:
- Go to https://github.com/settings/applications/new. The application
name and homepage URL do not matter, but the Authorization callback URL must
be
http://localhost:4433/self-service/methods/oidc/callback/github. - Generate a client secret
- Create a file called
.envon the root of the repository and paste your client credentials:
CLIENT_ID=<client_id>
CLIENT_SECRET=<client_secret>From the root folder of the repository, run the docker-compose:
docker compose upTo test the authorization code flow you can use the Ory Hydra CLI:
To install the Ory Hydra CLI follow the instructions.
code_client=$(hydra create client \
--endpoint http://localhost:4445 \
--name grafana \
--grant-type authorization_code,refresh_token \
--response-type code \
--format json \
--scope openid,offline_access,email,profile \
--redirect-uri http://127.0.0.1:4446/callback \
--audience app_client \
)
hydra perform authorization-code \
--endpoint http://localhost:4444 \
--client-id `echo "$code_client" | yq .client_id` \
--client-secret `echo "$code_client" | yq .client_secret` \
--scope openid,profile,email,offline_access
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent