Skip to content

Release 1.12.0

Latest

Choose a tag to compare

@github-actions github-actions released this 18 Nov 16:12
· 30 commits to main since this release

Goiabada 1.12.0

Brands for the sign-in pages and the emails (#809), with a look for each app, custom palettes, custom CSS and email wording you edit in the admin console. All changes

Before upgrading

  • #819 If you start a server with --authserver-templatedir, --authserver-staticdir, --adminconsole-templatedir or --adminconsole-staticdir: remove the flag before upgrading. These flags are gone, and a server started with one prints its usage and exits with code 2.

Upgrade notes

  • #819 If you serve your own templates, static files or message catalogs through GOIABADA_AUTHSERVER_TEMPLATEDIR, GOIABADA_AUTHSERVER_STATICDIR, GOIABADA_ADMINCONSOLE_TEMPLATEDIR, GOIABADA_ADMINCONSOLE_STATICDIR or GOIABADA_I18N_OVERRIDES_DIR: they're no longer read, and the pages and emails come from the built-in ones, in the six built-in languages. Set your look in a brand under Admin, Settings, Branding, and your emails' wording under Admin, Settings, Email, Email templates. A user whose page language came from your catalogs gets Automatic.
  • #810 The upgrade turns the Theme setting into a brand named Default, on the Blueberry theme, keeping a light or dark choice and making any other Automatic, and makes it the default brand. Admin, Settings, Theme is now Admin, Settings, Branding.
  • #810 If a script calls GET or PUT /api/v1/admin/settings/ui-theme, reads uiTheme from GET /api/public/settings, or alerts on updated_ui_theme_settings: they're gone. Use /api/v1/admin/brands, the public settings' brand, and the brand events created_brand, updated_brand, deleted_brand, updated_default_brand and updated_client_brand.
  • #708 If you let clients register themselves: a confidential client that registers from now on must send its secret the way it registered, client_secret_basic unless it asked for client_secret_post, at /auth/token, /auth/revoke and /auth/introspect. A secret sent the other way is refused with invalid_client. Clients registered before the upgrade, and clients an administrator created, in the admin console or through the Admin API, keep accepting both.
  • #862 If you run Goiabada behind Nginx, or behind Kubernetes' F5 NGINX Ingress Controller: raise its request body limit to 4 MiB, with client_max_body_size 4m; in both server blocks, as Reverse proxy shows, or the annotation nginx.org/client-max-body-size: 4m. Its 1 MiB default refuses a brand's background image or font over 1 MiB, and a profile picture or client logo over 1 MiB sent through the Admin or Account API.
  • #816 If a proxy in front of Goiabada adds stylesheets, inline styles, images or fonts from another site to its pages: the new Content-Security-Policy, script-src 'self'; style-src 'self'; img-src 'self' data:; font-src 'self'; object-src 'none'; base-uri 'none'; frame-ancestors 'none', refuses them.
  • #813 If an app uploads profile pictures or client logos through the Admin or Account API: an animated GIF, PNG or WebP is refused 400 with validator.image.animated.

⚙️ Config changes

  • Database: SQLite, MySQL, PostgreSQL and SQL Server schema 000088 → 000096.
  • #816 New, optional: GOIABADA_AUTHSERVER_BRAND_SAFE_MODE (flag --authserver-brand-safe-mode, default false) draws every page of both servers in safe mode, until you unset it and restart the auth server.
  • #819 Removed: GOIABADA_AUTHSERVER_TEMPLATEDIR, GOIABADA_AUTHSERVER_STATICDIR, GOIABADA_ADMINCONSOLE_TEMPLATEDIR, GOIABADA_ADMINCONSOLE_STATICDIR and GOIABADA_I18N_OVERRIDES_DIR, which are ignored if still set, and the flags --authserver-templatedir, --authserver-staticdir, --adminconsole-templatedir and --adminconsole-staticdir.
  • #819 The setup wizard's docker-compose.yml no longer sets the four template and static directory variables.

New

  • #810 Brands, under Admin, Settings, Branding: a brand has a name, an appearance (Automatic, Light or Dark) and one of eight built-in themes, Blueberry, Blackberry, Avocado, Plum, Tangerine, Guava, Coconut and High contrast. Every page with no brand of its own is drawn in the default brand. The Admin API manages them at /api/v1/admin/brands.
  • #811 The brand editor previews a sign-in card and a page of messages as you edit, light and dark.
  • #812 Each client can have a brand of its own, under Brand on its Settings tab or with PUT /api/v1/admin/clients/{id}/brand. A sign-in to it, the registration and forgot password pages that sign-in links, and a sign-out naming it are drawn in it. The admin console is drawn in its own client's brand.
  • #862 A legal document opened from an app's sign-in is drawn in that app's brand, as are the earlier versions it links.
  • #813 A brand's kit: a logo and a dark logo, a favicon, a background image, a font, one of six system families or an uploaded WOFF2 with an optional bold file, and Square, Rounded or Pill corners. Files are uploaded in the editor or through /api/v1/admin/brand-assets/.
  • #814 A brand can show up to three footer links, each with a label for each language, and a support contact, an email address, a support page and a phone number, under the sign-in card.
  • #815 Custom palettes: set four colors for each mode and let the other 19 be worked out, or set all 23. The editor lists every pair below its WCAG 2.2 level AA contrast minimum as you edit, and the brand list marks a brand that has any.
  • #816 Custom CSS for a brand, up to 64 KB, written against a styling contract whose variables, page names and classes stay the same from one release to the next. CSS that could make a browser load anything is refused.
  • #816 Safe mode draws the pages without a brand's custom CSS, custom palette and uploaded font, so a brand that made them unusable can be fixed: goiabada_safe_mode=true on an authorization request or an admin console address, or GOIABADA_AUTHSERVER_BRAND_SAFE_MODE for every page.
  • #817 Every email is drawn in a brand, with its logo, colors, corners, font, with System UI in place of an uploaded one, and footer, and a button in the brand's color in the password reset link, activation, new user's setup and welcome emails: the brand of the sign-in or the Account page it came from, or the default brand for an administrator's action. Each email also has a plain-text part.
  • #818 Email templates, under Admin, Settings, Email, Email templates: reword the subject, button label and body of any of the 19 emails in each of the six built-in languages, in a small set of Markdown with placeholders, with a preview and a test send. A release that rewords a field you didn't change still reaches your users. The Admin API manages them at /api/v1/admin/email-templates.

Fixed

  • #708 Dynamic client registration's answer lists the grant types the client can use, refresh_token beside authorization_code, and always sends response_types. A registration asking for refresh_token alone is refused with invalid_client_metadata.
  • #725 Creating a user whose setup email can't be sent answers 201 with the user and setupEmailSent: false, instead of 500, and the admin console says on the new user's page that the email wasn't sent. The user is kept, so no retry is needed.
  • #817 With email verification off, a registration whose welcome email can't be sent no longer shows an error page for the account it created: the email is sent after the response, and a failure is logged.
  • In the admin console, a "saved" notice shows on the page that saved, no longer on a page another tab of the same browser loaded at that moment.
  • On a client's Authentication tab, Save waits for the secret that choosing Confidential generates, so a quick save is no longer refused as an invalid client secret.

Maintenance

  • #863 CI runs take less time, with every test still run.
  • Docs: a Customize the pages and emails guide and a Styling contract reference replace Customize and translate the pages.
  • Docs: goiabada.dev's first screen points AI agents to the plain-text docs, llms.txt and llms-full.txt.
  • Docs: claims the code contradicts are corrected, and text readers don't need is cut.

Pinned image references

The multi-platform image index digests this release pushed and attested, one per image. The same digests name the images at ghcr.io/leodip/goiabada, which the same push wrote.

  • Auth server: leodip/goiabada:authserver-1.12.0@sha256:4d196f87bf827cb6f783403b1bcd3d822a2fcb64441227e4e57328242a570b48
  • Admin console: leodip/goiabada:adminconsole-1.12.0@sha256:3a1446edf9a6475d6fef10cf014c4e79e6bbb4feafb31951b4ebfa346bdaf728