Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Branding: your own logos

Administrators can replace the two TeamCraft logos under Admin → Branding (/admin/branding):

SlotWhere it appearsSuggested size
Wide logotop left of the web header, the sign-in page, the title bar of the desktop appabout 5:1, for example 600 × 120 px, transparent background
Square logobottom left of the web page (footer), the browser tab icon, the navigation rail of the desktop app1:1, for example 256 × 256 px

Without an upload the built-in TeamCraft logos stay. Use the built-in logo removes an upload again.

Rules for the files

  • PNG, JPEG, WebP or SVG – the type is decided from the content, not from the file name.
  • At most 512 KiB; bitmaps at most 4096 pixels per side. A PNG, JPEG or WebP file whose pixel size cannot be read is refused.
  • SVG files must not contain scripts, event handlers, animations, foreignObject, entity declarations (<!ENTITY …>) or links to other files: href, xlink:href, src and CSS url(…) may point only into the file itself (#id) or carry an embedded data:image/…. Namespace declarations and metadata, as Inkscape writes them, are fine. Illustrator files saved with Preserve Illustrator Editing Capabilities carry entity declarations and are refused; use File → Export → Export As… → SVG instead, or save from Inkscape as Plain SVG. SVG logos are shown only as images and served with a sandboxing Content-Security-Policy.
  • The web header shows one wide logo for all skins (light and dark). A logo with a transparent background and colours that read on both is best.

What else to know

  • The logos are stored in the database, so a backup contains them and a restore brings them back.
  • Every upload and reset is written to the audit log (branding.set, branding.reset).
  • The web pages show a new logo at once. The desktop app loads the logos when it signs in or starts; sign out and in again to see a change.
  • The image routes GET /branding/wide and GET /branding/square need no sign-in (the sign-in page shows the logo); they answer 404 while the built-in logo is in use. The REST API reports the state and the content types at GET /api/v1/branding; its image routes are cached private.

Header name and subtitle

Under Admin → Branding → Header name you can rename what the top left of the web header and the desktop title bar shows, today TeamCraft PLM:

  • Display name – up to 40 characters, plain text on one line (no < or >). Leave it empty to use the default: TEAMCRAFT_INSTANCE_NAME, else TeamCraft.
  • Subtitle – up to 20 characters, default PLM; empty shows none.

The name appears in the web header (when no wide logo is set; the logo wins), page titles, the sign-in page, notification e-mails and chat messages, and the desktop title bar. Changes are effective at once in the web UI and written to the audit log (branding.update); the desktop app reads them when it signs in. The REST API has GET /api/v1/branding (display_name, subtitle) and PUT /api/v1/branding/name (administrators).

Renaming the instance never renames the software. The footer, the desktop About dialog and Settings, the version, the licence and no-warranty notices, /api/v1/version, the CLI, the desktop user agent and the MCP serverInfo always say TeamCraft, so support and the MPL-2.0 notices stay clear about which software runs.