{"id":22268213,"url":"https://github.com/curityio/idsvr-customization-recipes","last_synced_at":"2025-07-07T07:07:33.231Z","repository":{"id":171318801,"uuid":"635863189","full_name":"curityio/idsvr-customization-recipes","owner":"curityio","description":"Recipes for customizing login screen related behavior for the Curity Identity Server","archived":false,"fork":false,"pushed_at":"2023-05-31T12:07:35.000Z","size":1706,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-04T19:12:32.556Z","etag":null,"topics":["authentication","customization","look-and-feel","oauth","openid-connect"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/curityio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-03T16:01:33.000Z","updated_at":"2023-05-31T08:44:31.000Z","dependencies_parsed_at":"2023-06-30T09:01:06.953Z","dependency_job_id":null,"html_url":"https://github.com/curityio/idsvr-customization-recipes","commit_stats":null,"previous_names":["curityio/idsvr-customization-recipes"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/curityio/idsvr-customization-recipes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fidsvr-customization-recipes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fidsvr-customization-recipes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fidsvr-customization-recipes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fidsvr-customization-recipes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/curityio","download_url":"https://codeload.github.com/curityio/idsvr-customization-recipes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fidsvr-customization-recipes/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264032255,"owners_count":23546802,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","customization","look-and-feel","oauth","openid-connect"],"created_at":"2024-12-03T11:11:55.007Z","updated_at":"2025-07-07T07:07:33.194Z","avatar_url":"https://github.com/curityio.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Curity Identity Server Customization Recipes\n\n[![quality](https://img.shields.io/badge/quality-example-red)](https://curity.io/resources/code-examples/status/)\n[![availabitly](https://img.shields.io/badge/availability-source-blue)](https://curity.io/resources/code-examples/status/)\n\nA fast setup for running the common login customization use cases.\\\nOnce understood, similar customizations can be quickly applied to your own system.\n\n## Prerequisites\n\nFirst ensure that the following components are installed locally:\n\n- A [Docker](https://www.docker.com/) engine for your operating system\n- The [envsubst](https://github.com/a8m/envsubst) tool, eg by running `brew install gettext`\n\n## Run the UI Builder\n\nFirst run the ui-builder tool, with a recipe to customize:\n\n```bash\nexport RECIPE='basics'\n./run-ui-builder.sh\n```\n\nThis copies the files from the first recipe, then opens the UI builder at the customized page.\\\nYou can see a list of all pages by browsing to the base URL of http://localhost:3000.  \nIn the following screenshot the language has been set to Portuguese:\n\n![UI Builder Options](images/ui-builder-options.png)\n\n## Example Recipes\n\nSome example customizations are provided, in the below link, each of which has its own README file:\n\n| Recipe Name | Description |\n| ----------- | ----------- |\n| [basics](recipes/basics) | Simple customizations to change text, logos and styles | \n| [email](recipes/email) | Customizations to email text, styles and templates, for email based login flows | \n| [multi-brand](recipes/multi-brand) | How to implement different branded customizations per client application |\n\n## Deploy Customizations\n\nDeploy the recipe files to the Curity Identity Server, using commands such as the following:\n\n```bash\nexport RECIPE='basics'\nexport USE_NGROK=false\n./deploy-idvr.sh\n```\n\nLogin to the Admin UI if required, using these details, to understand the demo client and its authentication:\n\n- URL: https://localhost:6749/admin\n- Username: admin\n- Password: Password1\n\nThe deployed system uses the `Username is Email` option from the Account Manager:\n\n![Account Manager](images/account-manager.png)\n\n## Run OAuth Tools\n\nOnce the system is up and running, use OAuth tools to test deployed customizations.\\\nRun the desktop version of OAuth Tools and create an environment from this metadata URL:\n\n```text\nhttp://localhost:8443/oauth/v2/oauth-anonymous/.well-known/openid-configuration\n```\n\nThen run a code flow with a test client, and use the following settings in OAuth tools.\\\nAlternatively use `template-area` clients with a client ID of `web-client1` or `web-client2`.\n\n- Client ID: web-client\n- Client Secret: Password1\n- Scope: openid\n- Prompt: login\n\nSelect the `HTML Form` authenticator and use the `Create Account` option to register a new test user.\\\nThen authenticate as the user and also run `Reset Password` flows that trigger emails.\\\nView received emails by browsing to http://localhost:1080:\n\n![Email messages](images/email.png)\n\n## Free Resources\n\nOnce you have finished customization testing, free resources by running this script:\n\n```bash\n./teardown.sh\n````\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurityio%2Fidsvr-customization-recipes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcurityio%2Fidsvr-customization-recipes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurityio%2Fidsvr-customization-recipes/lists"}