Skip to main content
Version: 2.0

OpenDesign

OpenDesign provides a web console and API. The Websoft9 package persists app data in a volume and supports read-only single-file configuration overrides.

Getting Started​

Initialize​

After installing OpenDesign in the Websoft9 console, open My Apps > OpenDesign and get the access URL and credentials from the Access tab. Sign in to open the OpenDesign console.

Start using OpenDesign​

After signing in, use the features available in the OpenDesign console. For details about the product's functionality and workflows, refer to the OpenDesign website and project documentation.

Change the password​

  1. Open the OpenDesign Compose tab in the Websoft9 console.
  2. Update the password in .env and save.
  3. Rebuild the app for the change to take effect.

Best Practices​

Preserve application data​

Application data is stored in the opendesign_data persistent volume mounted at /app/.od. Back up this volume before upgrading or recreating the app. To override configuration, mount a single file as read-only; do not replace the entire configuration directory.

Configuration​

SettingDescriptionDefault / location
Web Console and APIWeb interface and API port7456
Application dataOpenDesign persistent data directoryopendesign_data volume mounted at /app/.od
PasswordUpdate in the app's .envRebuild the app after changing
Image versionCurrently supported version0.24.1; latest is also available
Configuration filesOverride with a read-only single-file mountFiles are included in the image

Pin a specific image version for production.

Administration​

Upgrade​

Upgrade OpenDesign from the Websoft9 console. Back up the opendesign_data volume first. Recreate the app after upgrading or changing its configuration as prompted by the console.

Backup and restore​

Back up and restore the opendesign_data persistent volume. If you override configuration files, restore each read-only file mount separately; do not mount a directory over the image's entire configuration directory.

Troubleshooting​

The app does not start​

Check the app's Compose logs and confirm that the image and service started successfully.

The page is not reachable​

Verify the access URL and check that port 7456 is allowed by the server firewall or cloud security group.

The new password does not work​

Confirm that the password was saved in .env on the Compose tab and that the app was rebuilt before signing in again.

References​