Vodmill docs
v1.0.0
Get help
● Set up · Your brand

White label
your name, your colour, your domain.

Customers should see your brand, not the product's. Most of it is a console setting. A deeper rename is one file in the source.

Brand sectionLegal linksproduct.ts

01Brand settings in the console

Console, Setup, Brand. Changes show in the app at once.

FieldWhere people see it
Product nameThe app's header, the browser tab, e-mail subjects, the first letter in the favicon
App title in the browser tabReplaces the product name in the tab. Empty uses the product name.
TaglineSent to the app with the brand
Accent colourButtons, links and highlights in the app, and the favicon letter. Default #1F6FEB.
LogoThe app's header, in place of the letter mark
Support emailSent to the app as the contact for your customers
WebsiteShown as a link on the app's sign-in page, next to the Terms and Privacy links. Only http and https addresses are shown (src/server/app.ts).

The favicon is drawn by the server from the first letter of the product name and the accent colour (src/server/app.ts).

03Other places your brand appears

  • Name on receipts: Money, Customer billing.
  • E-mail sender: System, E-mail, on a domain you verified in Resend.
  • Watermark: System, Rendering, "Watermark text on plans without No watermark". Each workspace can also set its own handle or logo as a watermark in the clip editor.
  • Caption presets: your own presets for every workspace, on the console's Caption presets page (Caption presets).
  • Your domain: PUBLIC_URL and the https proxy (Installation).

04Renaming in the source

The product's identity lives in one file, src/shared/product.ts:

FieldDefaultWhat it is
idvodmillMachine id: log prefix, backup file prefix, part of how saved secrets are sealed
nameVodmillThe name people see until you set a product name in the console
sessionCookievodmill_sessionThe app's session cookie
apiKeyPrefixvdm_Prefix of public API keys
accent#1F6FEBDefault accent colour
headerx-studioRequest header of the app, and the prefix of webhook headers

After a change run npm run build and restart.

Change id only before the first start

The id is part of how saved keys are sealed and of the backup file names. If you change it on an install that already has data, saved API keys must be entered again and older backup files are no longer recognised by the --keep clean-up. Changing apiKeyPrefix or sessionCookie later makes existing API keys and sign-ins invalid.

The app's interface text is English, in the source files under web/src/. There are no translation files in version 1.0.0.