Skip to main content

Migrate to ZUI Cloud names

The service previously called Pro Services is now ZUI Cloud. A private deployment is ZUI Cloud Private. Config Store, PDF Export, and Scheduled Delivery keep their module names, and the HTTP /v1 routes and zui_pk_ / zui_st_ token prefixes do not change.

Update build and deployment names

PreviousCurrent
packages/pro-servicespackages/cloud
@zuilib/pro-services@zuilib/cloud
pnpm pro-services:*pnpm cloud:*
make pro-servicesmake cloud
dist/server/pro-servicesdist/server/zui-cloud
deploy/pro-servicesdeploy/cloud
zui-pro-services.servicezui-cloud.service
pro.zuilib.comcloud.zuilib.com

The checked-in deploy script migrates the existing service directory, environment file, SQLite data, and artifact directory before disabling the old systemd unit. Calls to the old hosted origin remain service-compatible during the announced transition; authenticated POST clients must update their base URL and must not depend on an HTTP redirect.

Update environment variables

Use the canonical names in every new deployment:

PreviousCurrent
ZUI_PRO_SERVICES_URL or ZUI_SERVICE_URLZUI_CLOUD_URL
ZUI_PRO_SERVICES_KEY or ZUI_SERVICE_KEYZUI_CLOUD_KEY
PRO_SERVICES_HOSTZUI_CLOUD_HOST
PRO_SERVICES_PORTZUI_CLOUD_PORT
PRO_SERVICES_DATABASEZUI_CLOUD_DATABASE_URL
PRO_SERVICES_WEB_DIRZUI_CLOUD_WEB_DIR
PRO_SERVICES_ALLOW_SIGNUPZUI_CLOUD_ALLOW_SIGNUP
PRO_SERVICES_CORS_ORIGINSZUI_CLOUD_CORS_ORIGINS
PRO_SERVICES_SESSION_TTL_HOURSZUI_CLOUD_SESSION_TTL_HOURS
PRO_SERVICES_DEMO_KEYZUI_CLOUD_DEMO_KEY

PDF and schedule settings follow the same namespace, for example ZUI_CLOUD_PDF_CONCURRENCY and ZUI_CLOUD_SCHEDULE_REDIS_URL.

For one transition release, the server uses an old variable only when its new equivalent is absent. The new name always wins, and each old name that supplies a value produces one startup warning containing variable names but never their values. Remove aliases promptly: the following release may reject them.

Verify the migration

  1. Deploy the replacement key or environment variables while the old service is still healthy.
  2. Exercise Config Store reads and writes, one PDF export, and one schedule in a non-production environment.
  3. Confirm clients use cloud.zuilib.com, then revoke superseded keys.
  4. Verify the old service is stopped and the new service reads the existing database and artifacts.
  5. Keep the pre-migration backup and prior release until the observation window has passed.

Existing database table names, stored resource IDs, Redis scheduler namespace, and browser session-storage key remain unchanged to avoid a risky data migration. See ZUI Cloud Private operations for backup, rollback, and production checks.