KNEL/KNELCloudronPackages
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Scaffold Cloudron packaging workspace

Browse Source
This commit is contained in:
Charles N Wyble - admin
2025-10-02 13:39:36 -05:00
parent 482d4ff1b8
commit fe0ade1dd9
366 changed files with 4035 additions and 2493 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
apps/datahub/README.md
View File

@@ -2,19 +2,19 @@
- **Upstream repository**: https://github.com/datahub-project/datahub.git
- **Implementation issue**: https://projects.knownelement.com/issues/309
- **Status**: Draft scaffolding generated on $(date -u +"%Y-%m-%dT%H:%M:%SZ")
- **Generated**: 2025-10-02T17:19:00Z UTC
## Packaging Checklist
1. Review upstream deployment requirements and map them to Cloudron services (database, cache, object storage, workers).
2. Update `Dockerfile` with the correct build steps and runtime dependencies.
3. Implement `start.sh` to configure the app from Cloudron-provided environment variables and launch the primary process.
4. Edit `CloudronManifest.json` with accurate metadata, permissions, ports, addons, and health checks.
5. Add integration and smoke tests under `test/` to validate the package.
6. Document manual configuration steps, migration requirements, and known gaps in this README.
1. Map upstream services (databases, caches, workers) to Cloudron addons; remove unused entries from `optionalAddons` and enable required ones under `addons`.
2. Implement the multi-stage build in `Dockerfile` to fetch/compile the correct release of DataHub.
3. Update `start.sh` to configure the app from Cloudron environment variables and launch the primary process.
4. Replace the placeholder health checks and smoke test with real coverage.
5. Complete `CloudronManifest.json` (tagline, description, versioning, resource limits, ingress, TCP ports, etc.).
6. Document manual configuration steps, migrations, and known gaps below.
## Notes
- Replace the placeholder long-running process in `start.sh`.
- Populate the `app/` directory with the application build artefacts or git submodules.
- Use the shared packaging container (`docker/packager`) to run `cloudron build` and `cloudron install` so the host remains clean.
- Populate the `app/` directory with runtime overlays or artifacts generated during the build stage.
- Use the shared packaging container (`docker/packager`) for `cloudron build/install` to keep the host clean.
- Record decisions and operational requirements under `docs/apps/datahub/` as work progresses.