Summary
Improve the complete local installation experience so users can install and start the platform without requiring cloud-specific configuration. The local setup should be fully self-contained, reliable, and capable of tracking activated installations for future management.
Objectives
- Make local installation work out of the box using the provided
install.sh script.
- Remove unnecessary dependency on cloud-only configuration during local installations.
- Ensure local setup remains independent from cloud services unless those services are explicitly enabled.
- Provide a smooth first-time installation experience without manual configuration.
- Track local setup activations for future management and analytics.
Requirements
Installation
- Local installation should complete successfully using the provided installer.
- Users should not be required to configure optional cloud integrations during installation.
- Installation should continue even if optional services are not configured.
- Required configuration should remain mandatory, while optional configuration should not block startup.
Local Mode
- Introduce a clear local setup mode that automatically configures the application for self-hosted installations.
- Cloud-specific features should remain disabled until configured.
- Local users should still be able to use all core platform functionality.
Database Initialization
- Database initialization should always complete successfully during installation.
- Initial setup should not fail because optional integrations are unavailable.
- Migrations and initial data should execute successfully for local installations.
Activation & Tracking
Implement a local setup activation flow that records each successful installation.
The activation process should:
- Register a newly installed local instance.
- Store installation details for future management.
- Prevent duplicate registrations for the same installation.
- Allow the application to identify whether the local setup has already been activated.
- Be designed so future features (license management, updates, telemetry, support, etc.) can use the stored activation information.
API
Add an activation endpoint that:
- Is executed during or immediately after installation.
- Registers the local setup.
- Returns activation status.
- Handles repeated activation requests safely.
Local Setup Management
Persist information necessary to manage local installations, including:
- Installation identity
- Activation status
- Installation timestamp
- Version information
- Additional metadata required for future enhancements
Acceptance Criteria
- Local installation completes successfully with a single installer command.
- Optional cloud services are not required for local setup.
- Core application starts successfully after installation.
- Database initialization completes successfully.
- Local installation is automatically activated.
- Installation is recorded only once.
- Activation endpoint is idempotent.
- Future updates can identify and manage existing local installations.
- Existing cloud deployments continue working without behavior changes.
Summary
Improve the complete local installation experience so users can install and start the platform without requiring cloud-specific configuration. The local setup should be fully self-contained, reliable, and capable of tracking activated installations for future management.
Objectives
install.shscript.Requirements
Installation
Local Mode
Database Initialization
Activation & Tracking
Implement a local setup activation flow that records each successful installation.
The activation process should:
API
Add an activation endpoint that:
Local Setup Management
Persist information necessary to manage local installations, including:
Acceptance Criteria