Sign-in page
Deployed and supported. The fields and commands described here are stable within version v1alpha1.
Your users sign in on a page in your organization's colors: logo, colors, theme, title, links to your terms of use. It is set once for your whole tenant, from the Authentication → Sign-in page section of the console, with a live preview, or with sng iam login-page.
Customization works through tokens: typed values (color, HTTPS address, choice from a list). There is no free CSS or HTML, which keeps the sign-in page safe; readability is guaranteed (text colors are computed to stay contrasted).
Prerequisites
- A session on the tenant:
sng tenant use acme. auth:ManageLoginPageto modify (policyreadwriteoradmin);auth:ListUsersis enough to read.
Settings
| Setting | Values | Default |
|---|---|---|
logoURL, logoDarkURL | https:// address of a PNG, WebP or JPEG image | StackNGO logo |
faviconURL | https:// address | StackNGO icon |
primaryColor, accentColor | #rrggbb | StackNGO theme |
backgroundColor | #rrggbb | theme background |
backgroundImageURL | https:// address | none |
theme | light, dark, auto | auto |
radius | none, sm, md, lg (button rounding) | md |
layout | centered or split (image on the left, form on the right) | centered |
fontFamily | stackngo, inter, system | stackngo |
title, subtitle | plain text per language (fr, en), 200 characters at most | "Sign in to …" |
links.terms, links.privacy | https:// addresses | none |
supportEmail | email address | none |
showPoweredBy | true or false | true |
users.signup | invite or open | invite |
A field left empty takes the default value. SVG images are not accepted.
Steps
1. See the current state
sng iam login-page show
With no saved settings, the command shows the default page with invite sign-up.
2. Modify
sng iam login-page set --logo-url https://acme.example/logo.png --primary-color "#0a7cff" --signup invite
The command covers the logo, the primary color and the sign-up policy; the console gives access to all the settings above. Rejected fields (malformed color, non-HTTPS address, insufficient contrast) are reported one by one, and nothing is saved as long as one of them is rejected.
3. Check the preview
In the console, the page shows a preview that follows your changes before saving.
Propagation
After saving, the sign-in page changes within a few minutes. In the meantime, sng iam login-page show distinguishes saved settings from those already applied.
Invitation-only or open sign-up
users.signup | Effect |
|---|---|
invite | only invited people create an account |
open | anyone who signs in with an enabled sign-in method creates their account |
Switching to open only makes sense if you accept that any holder of a Google, GitHub… account (depending on the methods enabled) can get in: your application remains free to refuse accounts without a role.
Verification
sng iam login-page show
Then open the sign-in page from your application (authorization_code flow, see Authentication for your applications): the logo and colors appear.
Limits
- The settings apply to all the applications in your directory.
- Only changes made from your tenant's primary cluster are accepted (otherwise the command answers
409). - Your tenant must have a directory enabled (otherwise
404).