Repository navigation
fix(synkronus-quickstart): support docker and podman quickstart flows - #1
Merged
Merged
Conversation
bokchan
force-pushed
the
revise-and-validate-docs
branch
from
April 19, 2026 12:18
9567f88 to
d0fbbf6
Compare
bokchan
force-pushed
the
revise-and-validate-docs
branch
from
April 19, 2026 12:26
d0fbbf6 to
65c560b
Compare
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aims to make the Synkronus quickstart flow work consistently across Docker and Podman by updating helper scripts/docs and adding CI validation for both runtimes.
Changes:
- Added a data-volume migration utility and an automated upgrade-path validation workflow.
- Updated backup/bootstrap scripts to support selecting Docker vs Podman via
SYNK_RUNTIME. - Added GitHub Actions coverage for Docker/Podman manual + installer flows and adjusted installer/docs for rootless-friendly localhost access.
Reviewed changes
Copilot reviewed 14 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| utilities/migrate-synkronus-data.sh | New script to migrate legacy volume layout into the current /app/data structure. |
| utilities/backup-db.sh | Adds runtime selection via SYNK_RUNTIME; adjusts output path handling. |
| utilities/backup-attachments.sh | Adds runtime selection via SYNK_RUNTIME. |
| utilities/README.md | Documents the utilities list in a clearer table format. |
| install.sh | Switches localhost Caddy binding to host port 8081 and updates printed next steps. |
| docker-compose.yml | Adds container_name for synkronus, changes default credentials, and publishes Postgres port 5432. |
| create_sync_db.sh | Adds runtime detection + container discovery for Docker/Podman and uses it for DB bootstrap. |
| README.md | Updates quickstart/manual-install docs and clarifies localhost + rootless Podman behavior. |
| .gitignore | Ignores generated Caddyfile and docker-compose.override.yml. |
| .github/workflows/test-upgrade-path.yml | New workflow to test migration flow on Docker and Podman. |
| .github/workflows/test-podman-runtime.yml | New workflow to test Podman quickstart flows via reusable workflow. |
| .github/workflows/test-docker-runtime.yml | New workflow to test Docker quickstart flows via reusable workflow. |
| .github/workflows/reusable-runtime-flow.yml | Reusable workflow to run runtime scenario scripts. |
| .github/scripts/upgrade-path-flow.sh | Scripted end-to-end upgrade-path/migration test used by CI. |
| .github/scripts/runtime-flow.sh | Scripted end-to-end manual + installer quickstart tests used by CI. |
| .github/actions/setup-runtime/action.yml | Composite action to install/auth/verify Docker or Podman tooling in CI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This was referenced Nov 12, 2026
Removes the temporary update-docs push trigger, as noted in the PR's TODO.
Member
|
Thanks @bokchan , great work making the quickstart reliable on both Docker and Podman, and the new CI is a big win. |
najuna-brian
approved these changes
Nov 13, 2026
Contributor
Author
@najuna-brian I am happy to help 😃 |
najuna-brian
approved these changes
Nov 13, 2026
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.
Pull Request Title
fix(synkronus-quickstart): support docker and podman quickstart flows
Description
This draft PR tightens the Synkronus quickstart flow so the documented manual setup works consistently across Docker and Podman.
It updates the runtime scripts and docs, fixes the manual database bootstrap flow, and adds GitHub Actions coverage for both runtimes.
TODO:
- update-docsfromon.push.branchesbefore mergingType of Change
Component(s) Affected
Related Issue(s)
Closes/Fixes/Resolves: None
Testing
Breaking Changes
If breaking changes, please describe migration steps:
None.
Documentation Updates
Checklist
Thank you for contributing to Open Data Ensemble (ODE)!