feat: add secure quick-start installer - #298
Open
lykakis wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Secure Quick Start Installer
Summary
Adds a secure, guided Quick Start installer for running Sendium with Docker Compose on Linux, macOS, and WSL.
The installer generates the required runtime configuration, credentials, directories, and Compose file. It can then start Sendium and wait for it to become ready.
Why
Previously, evaluating Sendium required manually creating several configuration files and understanding its authentication, routing, and SMPP worker settings.
This change provides a safer and more approachable setup while preserving explicit configuration and provider-neutral behavior.
What Changed
quick-start.sh.compose.yml,.sendium.env, credentials, SMPP configuration, and routing configuration.127.0.0.1by default.--forceis explicitly supplied.Safe Upstream Regeneration
When an upstream provider is added through forced regeneration, the installer first writes the complete worker configuration with:
This prevents the worker from starting before its .type property is available.
Testing
Added a dependency-free POSIX shell test suite covering:
The optional image-backed CI test also verifies:
All 11 non-image test groups pass under WSL.
Scope Note
This PR prevents the configuration reload ordering issue in the Quick Start workflow by staging worker activation.
The underlying application-wide hot-reload race remains outside this PR and should be addressed separately.