Compare commits
216 Commits
f3b0cc4a44
...
main
Author | SHA1 | Date | |
---|---|---|---|
52439d8f37 | |||
39a28bbf2f | |||
abb7232ce0 | |||
790c5b9d92 | |||
01f6309dec | |||
e0f0a4ab56 | |||
11365035b8 | |||
c835a8438b | |||
02057f7815 | |||
8bb6d00b0f | |||
1a2f9bae6d | |||
4677c5c3ff | |||
7a4748496c | |||
0e98a63b99 | |||
59fc7fedf4 | |||
d34e1760c8 | |||
410f610af0 | |||
6acfe24403 | |||
a1ea3204f1 | |||
d22e6bbe81 | |||
d0fae8cbb0 | |||
26b311b9db | |||
79d3475c74 | |||
d50a58e934 | |||
33e9a861b0 | |||
fd910f1a72 | |||
d74cdc091b | |||
4bc1418831 | |||
48ed02209d | |||
a2a0f4ef48 | |||
54cc5f7308 | |||
f7bae09f22 | |||
0500eb3f54 | |||
f5a0c521c5 | |||
110d22de87 | |||
030ba67335 | |||
4511311565 | |||
4f71cba131 | |||
659640836c | |||
a0169a2d8a | |||
e61d4eb165 | |||
4ef3a47e25 | |||
37d9fae8c9 | |||
244ac11588 | |||
fd6aa5c0f0 | |||
f512afc53f | |||
b0ca0ef49c | |||
c315498391 | |||
6e23807a8a | |||
2f0fe97933 | |||
054f6c9e2f | |||
2a26247028 | |||
b2cd55b0ca | |||
60fc1b3aaf | |||
0148db9864 | |||
93775b7375 | |||
1b5dd39a11 | |||
d51149df29 | |||
e640d38400 | |||
da248f87cb | |||
e576d0175f | |||
62a0bd3bbc | |||
731ac82914 | |||
d45e8790d4 | |||
fffcd90d19 | |||
b69527bc7e | |||
949bd93dbf | |||
bc92e58407 | |||
caaedbe8b6 | |||
2157ed0742 | |||
aa50363ece | |||
90d618f71a | |||
3d1d640641 | |||
7acf4748f9 | |||
0564e4250b | |||
b87dbdec81 | |||
365d7ddebc | |||
42cbaa67b9 | |||
5fe6a855a9 | |||
dcbdaf01ae | |||
32099ee956 | |||
64b411f768 | |||
e9f69ae274 | |||
471b7ba296 | |||
aaffec4b47 | |||
113d1cd0fd | |||
a4db3a38d8 | |||
72cb0122c4 | |||
f0fa670ac5 | |||
24757c5cf5 | |||
eea38e1653 | |||
f2230d1663 | |||
4817710a10 | |||
c7ddeb4a89 | |||
9f74e0fc39 | |||
f3a57e5b87 | |||
f37ea77870 | |||
34990a9162 | |||
2f7d77b3c3 | |||
5a8a0caba8 | |||
898ecaaea6 | |||
b382498ea8 | |||
f0943949a5 | |||
425a6c01d6 | |||
f083ee7193 | |||
9e2cb96841 | |||
0f88372846 | |||
286e946a03 | |||
d318ed951c | |||
4a0584e2e7 | |||
570d5faa2d | |||
3207bd8a23 | |||
92c835c172 | |||
0ae11cac56 | |||
51b792f948 | |||
8373549544 | |||
a06d5aaf09 | |||
9d7b29d8be | |||
82e91e8ff5 | |||
4860c110c3 | |||
7bc3343183 | |||
afefac2d5c | |||
b57c994fc2 | |||
f2fe81c265 | |||
a5f817a29f | |||
98925b457b | |||
7019e08b88 | |||
38fb2a0085 | |||
580cde2be7 | |||
c6f41ce958 | |||
2f796b38df | |||
9b885cdabc | |||
8cac7b6121 | |||
5accf8a9a6 | |||
3d859bcf1d | |||
e6734cf308 | |||
d9e3f2814a | |||
b15c4f933c | |||
7327fb3c5d | |||
1237c53f97 | |||
89b85fbc21 | |||
99071a70e1 | |||
513c42fac6 | |||
2bb4ba2214 | |||
8ba85ac07f | |||
7950fbf338 | |||
d7d768e955 | |||
fc498b6292 | |||
f45c33a55b | |||
d898406955 | |||
d9b8038f18 | |||
219b888fd4 | |||
6aa4f69479 | |||
4f0464b122 | |||
e7e241495e | |||
3a3e103b59 | |||
cdeb8b12c6 | |||
e55c8d11f8 | |||
5bb35afd20 | |||
12a6469f32 | |||
4394679013 | |||
59dde0f00c | |||
9b5fc45226 | |||
ae5cba899c | |||
87b48ffd3c | |||
8636a334e7 | |||
eb964834d6 | |||
d1d370fa85 | |||
fe4d2fe842 | |||
79573cf439 | |||
03683f97d3 | |||
71d161f3fb | |||
2d1fad4560 | |||
dec8f6f269 | |||
949d561ebe | |||
47dc72474e | |||
1fa51e787f | |||
51c41ebc50 | |||
1e433ddc12 | |||
9f88542a16 | |||
9f9952af91 | |||
27f53ddade | |||
832882c489 | |||
24eacad478 | |||
542c74f3db | |||
8031fbd92c | |||
0f55dfa6c3 | |||
e23c71be94 | |||
0b20cdeaa3 | |||
2a3761a559 | |||
0b4061a045 | |||
79b8dcf774 | |||
995536c9fa | |||
923680a8e7 | |||
5df88e368e | |||
8a0d77ee49 | |||
66ab368dd3 | |||
2f04d6f234 | |||
6c6c1ce160 | |||
866200f5df | |||
b4c0b2e613 | |||
cabcedf88a | |||
87a8ac2408 | |||
f2a28633b1 | |||
dc6de5a37a | |||
321b44d0df | |||
5617999cef | |||
279cbb934e | |||
1ed8838270 | |||
0061ee7f7c | |||
ce6e89cfe6 | |||
62777ea382 | |||
574cf1223d | |||
fd3c6a2ea0 | |||
7152e0c7cd | |||
feb1952756 |
25
.editorconfig
Normal file
25
.editorconfig
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
charset = utf-8
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = true
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[Dockerfile]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.sh]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.yml]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.yaml]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.json]
|
||||||
|
indent_size = 2
|
||||||
|
|
16
.gitattributes
vendored
Normal file
16
.gitattributes
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
* text=auto eol=lf
|
||||||
|
|
||||||
|
# Enforce LF line endings for key file types
|
||||||
|
*.sh text eol=lf
|
||||||
|
Dockerfile text eol=lf
|
||||||
|
*.yml text eol=lf
|
||||||
|
*.yaml text eol=lf
|
||||||
|
*.json text eol=lf
|
||||||
|
*.md text eol=lf
|
||||||
|
|
||||||
|
# Binary assets
|
||||||
|
*.png binary
|
||||||
|
*.jpg binary
|
||||||
|
*.jpeg binary
|
||||||
|
*.ico binary
|
||||||
|
|
34
.gitignore
vendored
Normal file
34
.gitignore
vendored
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Development workspace (upstream clones, not tracked)
|
||||||
|
PackagingForCloudronWorkspace/Docker/*
|
||||||
|
PackagingForCloudronWorkspace/NonDocker/*
|
||||||
|
|
||||||
|
# Temporary packaging work directories
|
||||||
|
temp_*
|
||||||
|
*_package_new/
|
||||||
|
packaging_temp/
|
||||||
|
|
||||||
|
# Common local environment and editor files
|
||||||
|
.env
|
||||||
|
*.env
|
||||||
|
*.local
|
||||||
|
*.log
|
||||||
|
.envrc
|
||||||
|
.python-version
|
||||||
|
.tool-versions
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
|
||||||
|
# Build outputs (if any local builds are done)
|
||||||
|
dist/
|
||||||
|
build/
|
||||||
|
|
||||||
|
# OS generated files
|
||||||
|
.DS_Store
|
||||||
|
.DS_Store?
|
||||||
|
._*
|
||||||
|
.Spotlight-V100
|
||||||
|
.Trashes
|
||||||
|
ehthumbs.db
|
||||||
|
Thumbs.db
|
78
AGENTS.md
Normal file
78
AGENTS.md
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
# Agent Operating Guide (Project-wide)
|
||||||
|
|
||||||
|
Scope: This file applies to the entire repository. It defines how assistants and automation must work here.
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
Package ~100 free/libre/open-source applications as Cloudron apps with a fast, container-only workflow and a minimal, single-branch repo.
|
||||||
|
|
||||||
|
## Golden Rules
|
||||||
|
- Single branch: use only `main`. Do not create feature branches unless explicitly requested.
|
||||||
|
- Host is read-only: do not install or modify anything on the host OS. You MAY only check for the presence of tools and run them if already installed.
|
||||||
|
- Allowed host tools (if present): `docker`, `git`, `tea` (optional), and `curl` for connectivity checks. Never attempt to install or upgrade them.
|
||||||
|
- Containers only: all build, test, lint, and packaging commands must run inside the packaging container.
|
||||||
|
- Do not push to remote without approval: never run `git push` for a package change until it has been validated and explicitly approved by the maintainer.
|
||||||
|
- Keep repo slim: do not commit upstream source trees or build artefacts. Only commit package files under `CloudronPackages/<AppName>/`, small helper scripts, and minimal docs.
|
||||||
|
- Secrets: do not commit secrets or credentials. Use environment variables or Cloudron addons.
|
||||||
|
- Consistency: follow `.editorconfig`, `.gitattributes`, and `.gitignore`.
|
||||||
|
|
||||||
|
## Container-Only Workflow
|
||||||
|
- Packaging image: built from `docker/packaging/Dockerfile`.
|
||||||
|
- Control scripts (host-side wrappers):
|
||||||
|
- `scripts/packaging-up.sh` – build and start the packaging container; mounts repo at `/workspace` and `/var/run/docker.sock`.
|
||||||
|
- `scripts/packaging-enter.sh` – open a shell inside the container.
|
||||||
|
- `scripts/packaging-exec.sh <cmd>` – run any command inside the container.
|
||||||
|
- `scripts/workspace-clone.sh` – clone upstream repos (inside container).
|
||||||
|
- `scripts/workspace-update.sh` – update upstream repos (inside container).
|
||||||
|
- Never run package build/test outside the container. If a command needs to run, wrap it via `scripts/packaging-exec.sh`.
|
||||||
|
|
||||||
|
## Creating a New Package
|
||||||
|
- Scaffold from template using the helper:
|
||||||
|
- `scripts/new-package.sh <AppName> --id <com.example.app> --title "Title" --port <port> [--base <cloudron_base_tag>]`
|
||||||
|
- Edit `CloudronPackages/<AppName>/Dockerfile` and `start.sh` to run the app.
|
||||||
|
- Prefer prebuilt upstream releases over building toolchains in Docker to keep images small.
|
||||||
|
- Default Cloudron base image tag is `5.0.0`. Override with `--base` as needed.
|
||||||
|
|
||||||
|
## Validation Checklist (must pass before proposing push)
|
||||||
|
- Build succeeds inside the packaging container:
|
||||||
|
- `scripts/packaging-exec.sh "docker build -t <app>:dev CloudronPackages/<AppName>"`
|
||||||
|
- Run sanity check inside container:
|
||||||
|
- `scripts/packaging-exec.sh "docker run --rm -p <hp>:<hp> -v <app>-data:/app/data <app>:dev"`
|
||||||
|
- Health endpoint responds; logs show no fatal errors; app starts with least privilege.
|
||||||
|
- Manifest sanity: `CloudronManifest.json` has accurate `id`, `version`, `httpPort` or addon definitions, and `healthCheckPath`.
|
||||||
|
- No secrets or hard-coded credentials; proper ownership of `/app/data`.
|
||||||
|
- Image hygiene: no unnecessary build deps; minimal layers; correct exposed ports.
|
||||||
|
- Optional: `cloudron install --image <app>:dev` tested from inside the packaging container using `cloudron` CLI, if available.
|
||||||
|
|
||||||
|
## Approval Gate and Push Policy
|
||||||
|
- Commits: frequent, small, and descriptive commits are encouraged; no approval needed for local commits.
|
||||||
|
- After validation, present a concise summary of changes and validation output to the maintainer and request permission to push.
|
||||||
|
- Push only at “natural” points (coherent, validated milestones). Examples:
|
||||||
|
- First green build of a new package scaffold (image builds + container starts + health OK).
|
||||||
|
- A feature-complete slice (e.g., addon integration added and tested).
|
||||||
|
- A bug fix with verification.
|
||||||
|
- Pre-release stabilization checkpoint.
|
||||||
|
- Batch pushes to avoid noise (aim for 1–3 pushes per active app per work session).
|
||||||
|
- NEVER push a broken or non‑validated build.
|
||||||
|
- Only on explicit approval run `git push origin main` for package-affecting changes.
|
||||||
|
- Never force‑push unless explicitly instructed.
|
||||||
|
|
||||||
|
## Repository Hygiene
|
||||||
|
- Do not commit upstream repos. The directories `PackagingForCloudronWorkspace/Docker/` and `PackagingForCloudronWorkspace/NonDocker/` are gitignored on purpose.
|
||||||
|
- Keep package directories focused: `CloudronManifest.json`, `Dockerfile`, `start.sh`, and minimal config (e.g., `nginx.conf`, `supervisord.conf`, `config.yaml`, `logo.png`).
|
||||||
|
- Use LF line endings and 2-space indentation (see `.editorconfig`/`.gitattributes`).
|
||||||
|
|
||||||
|
## Networking & External Access
|
||||||
|
- All networked actions (git clones, docker pulls, downloads) must happen from within the packaging container.
|
||||||
|
- Host-level curl allowance: You MAY use `curl` on the host strictly for quick connectivity checks IF it is already installed. Do not install any host packages.
|
||||||
|
- Do not attempt other host-level network configuration, filesystem changes outside the repo, or host-level package installation.
|
||||||
|
|
||||||
|
## Commit Messages
|
||||||
|
- Use conventional, concise messages:
|
||||||
|
- `feat(<app>): ...` for new packages or features
|
||||||
|
- `fix(<app>): ...` for fixes
|
||||||
|
- `chore(...)`, `docs(...)` for non-functional changes
|
||||||
|
- Avoid large, mixed commits; keep changes scoped to an app.
|
||||||
|
|
||||||
|
## When in Doubt
|
||||||
|
- Ask for maintainer guidance before introducing new tools, dependencies, or changing global structure.
|
||||||
|
- Default to safer, smaller changes and explicit approval before pushing.
|
0
CloudronPackages/.gitkeep
Normal file
0
CloudronPackages/.gitkeep
Normal file
11
CloudronPackages/PackageTemplate/.dockerignore
Normal file
11
CloudronPackages/PackageTemplate/.dockerignore
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Ignore typical build context clutter
|
||||||
|
.git
|
||||||
|
.gitignore
|
||||||
|
node_modules
|
||||||
|
npm-debug.log
|
||||||
|
*.log
|
||||||
|
dist
|
||||||
|
build
|
||||||
|
Dockerfile.*
|
||||||
|
.DS_Store
|
||||||
|
|
19
CloudronPackages/PackageTemplate/CloudronManifest.json
Normal file
19
CloudronPackages/PackageTemplate/CloudronManifest.json
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"manifestVersion": 2,
|
||||||
|
"id": "__APP_ID__",
|
||||||
|
"title": "__APP_TITLE__",
|
||||||
|
"author": "KNEL",
|
||||||
|
"description": "Cloudron packaging template for __APP_TITLE__",
|
||||||
|
"website": "https://example.com",
|
||||||
|
"contactEmail": "admin@example.com",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"changelog": "Initial package template",
|
||||||
|
"healthCheckPath": "/",
|
||||||
|
"httpPort": __HTTP_PORT__,
|
||||||
|
"addons": {
|
||||||
|
"localstorage": {}
|
||||||
|
},
|
||||||
|
"tags": ["template", "example"],
|
||||||
|
"icon": "logo.png"
|
||||||
|
}
|
||||||
|
|
38
CloudronPackages/PackageTemplate/Dockerfile
Normal file
38
CloudronPackages/PackageTemplate/Dockerfile
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
FROM cloudron/base:__CLOUDRON_BASE__
|
||||||
|
|
||||||
|
# Metadata labels (edit as needed)
|
||||||
|
LABEL org.opencontainers.image.title="__APP_TITLE__"
|
||||||
|
LABEL org.opencontainers.image.description="Cloudron package for __APP_TITLE__"
|
||||||
|
LABEL org.opencontainers.image.source="https://example.com"
|
||||||
|
|
||||||
|
# Install OS dependencies here as needed
|
||||||
|
# RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||||
|
# curl ca-certificates tini \
|
||||||
|
# && rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# App code lives in /app/code (read-only at runtime)
|
||||||
|
WORKDIR /app/code
|
||||||
|
|
||||||
|
# Copy application code (adjust as needed)
|
||||||
|
# COPY . /app/code
|
||||||
|
|
||||||
|
# Create persistent directory for application data
|
||||||
|
RUN mkdir -p /app/data && chown -R cloudron:cloudron /app/data
|
||||||
|
|
||||||
|
# Copy startup script
|
||||||
|
COPY start.sh /app/pkg/start.sh
|
||||||
|
RUN chmod +x /app/pkg/start.sh && chown cloudron:cloudron /app/pkg/start.sh
|
||||||
|
|
||||||
|
USER cloudron
|
||||||
|
|
||||||
|
# Expose the app port specified in manifest
|
||||||
|
EXPOSE __HTTP_PORT__
|
||||||
|
|
||||||
|
# Default environment (customize per app)
|
||||||
|
ENV NODE_ENV=production \
|
||||||
|
APP_PORT=__HTTP_PORT__
|
||||||
|
|
||||||
|
HEALTHCHECK --interval=30s --timeout=5s --start-period=20s --retries=3 \
|
||||||
|
CMD curl -fsS http://127.0.0.1:${APP_PORT}/ || exit 1
|
||||||
|
|
||||||
|
CMD ["/app/pkg/start.sh"]
|
24
CloudronPackages/PackageTemplate/README.md
Normal file
24
CloudronPackages/PackageTemplate/README.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Package Template for Cloudron Apps
|
||||||
|
|
||||||
|
This is a minimal template to package an application for Cloudron.
|
||||||
|
|
||||||
|
Replace placeholders in files with your app specifics:
|
||||||
|
- `__APP_ID__` (e.g., com.example.myapp)
|
||||||
|
- `__APP_TITLE__` (human name)
|
||||||
|
- `__HTTP_PORT__` (default internal app port)
|
||||||
|
- `__CLOUDRON_BASE__` (Cloudron base image tag, e.g., 5.0.0)
|
||||||
|
|
||||||
|
Files
|
||||||
|
- `CloudronManifest.json` – base manifest
|
||||||
|
- `Dockerfile` – uses cloudron/base, non-root user, healthcheck
|
||||||
|
- `start.sh` – startup script with addon detection examples
|
||||||
|
- `nginx.conf` (optional) – example reverse proxy
|
||||||
|
- `supervisord.conf` (optional) – process manager example
|
||||||
|
- `config.yaml` (optional) – sample app config
|
||||||
|
- `logo.png` – add your 512x512 PNG icon here (not provided in template)
|
||||||
|
|
||||||
|
Usage
|
||||||
|
1. Create a new package from this template using `scripts/new-package.sh`:
|
||||||
|
`scripts/new-package.sh MyApp --id com.example.myapp --title "My App" --port 3000`
|
||||||
|
2. Adjust Dockerfile and start.sh to run your app.
|
||||||
|
3. Build and test locally; then commit and push.
|
11
CloudronPackages/PackageTemplate/config.yaml
Normal file
11
CloudronPackages/PackageTemplate/config.yaml
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Example configuration template for __APP_TITLE__
|
||||||
|
server:
|
||||||
|
port: __HTTP_PORT__
|
||||||
|
|
||||||
|
data:
|
||||||
|
dir: /app/data
|
||||||
|
|
||||||
|
database:
|
||||||
|
# url: ${CLOUDRON_POSTGRESQL_URL}
|
||||||
|
# redis: ${CLOUDRON_REDIS_URL}
|
||||||
|
|
26
CloudronPackages/PackageTemplate/nginx.conf
Normal file
26
CloudronPackages/PackageTemplate/nginx.conf
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
user cloudron;
|
||||||
|
worker_processes auto;
|
||||||
|
|
||||||
|
error_log /var/log/nginx/error.log warn;
|
||||||
|
pid /run/nginx.pid;
|
||||||
|
|
||||||
|
events { worker_connections 1024; }
|
||||||
|
|
||||||
|
http {
|
||||||
|
include /etc/nginx/mime.types;
|
||||||
|
default_type application/octet-stream;
|
||||||
|
access_log /var/log/nginx/access.log main;
|
||||||
|
sendfile on;
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen __HTTP_PORT__;
|
||||||
|
server_name _;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_pass http://127.0.0.1:__HTTP_PORT__;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
39
CloudronPackages/PackageTemplate/start.sh
Normal file
39
CloudronPackages/PackageTemplate/start.sh
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
log() { echo "[start] $(date -Is) $*"; }
|
||||||
|
abort() { echo "[start] ERROR: $*" >&2; exit 1; }
|
||||||
|
|
||||||
|
# Defaults
|
||||||
|
: "${APP_PORT:=__HTTP_PORT__}"
|
||||||
|
|
||||||
|
log "Starting __APP_TITLE__ on port ${APP_PORT}"
|
||||||
|
|
||||||
|
# Example: ensure /app/data exists and is writable
|
||||||
|
mkdir -p /app/data
|
||||||
|
chown -R cloudron:cloudron /app/data || true
|
||||||
|
|
||||||
|
# Example addon integration (uncomment and adapt as needed)
|
||||||
|
# if [[ -n "${CLOUDRON_POSTGRESQL_URL:-}" ]]; then
|
||||||
|
# log "Detected PostgreSQL addon"
|
||||||
|
# # Use $CLOUDRON_POSTGRESQL_* env vars
|
||||||
|
# fi
|
||||||
|
|
||||||
|
# if [[ -n "${CLOUDRON_REDIS_URL:-}" ]]; then
|
||||||
|
# log "Detected Redis addon"
|
||||||
|
# fi
|
||||||
|
|
||||||
|
# If your app needs config generation, do it here
|
||||||
|
# cat > /app/data/config.yaml <<'YAML'
|
||||||
|
# key: value
|
||||||
|
# YAML
|
||||||
|
|
||||||
|
# Example: start a simple HTTP server (placeholder)
|
||||||
|
# Replace with your actual app start command
|
||||||
|
if command -v python3 >/dev/null 2>&1; then
|
||||||
|
log "Launching placeholder server: python3 -m http.server ${APP_PORT}"
|
||||||
|
exec python3 -m http.server "${APP_PORT}" --bind 0.0.0.0
|
||||||
|
else
|
||||||
|
abort "No application command configured. Replace placeholder with your app's start command."
|
||||||
|
fi
|
||||||
|
|
12
CloudronPackages/PackageTemplate/supervisord.conf
Normal file
12
CloudronPackages/PackageTemplate/supervisord.conf
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
[supervisord]
|
||||||
|
logfile=/var/log/supervisor/supervisord.log
|
||||||
|
pidfile=/run/supervisord.pid
|
||||||
|
nodaemon=true
|
||||||
|
|
||||||
|
[program:app]
|
||||||
|
command=/app/pkg/start.sh
|
||||||
|
autorestart=true
|
||||||
|
stdout_logfile=/var/log/supervisor/app.stdout.log
|
||||||
|
stderr_logfile=/var/log/supervisor/app.stderr.log
|
||||||
|
user=cloudron
|
||||||
|
|
7
CloudronPackages/Rathole/.dockerignore
Normal file
7
CloudronPackages/Rathole/.dockerignore
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
.git
|
||||||
|
.gitignore
|
||||||
|
*.log
|
||||||
|
dist
|
||||||
|
build
|
||||||
|
.DS_Store
|
||||||
|
|
18
CloudronPackages/Rathole/CloudronManifest.json
Normal file
18
CloudronPackages/Rathole/CloudronManifest.json
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"manifestVersion": 2,
|
||||||
|
"id": "io.knel.rathole",
|
||||||
|
"title": "Rathole",
|
||||||
|
"author": "KNEL",
|
||||||
|
"description": "A reverse proxy that enables secure tunnels between local services and the internet.",
|
||||||
|
"website": "https://github.com/rathole-org/rathole",
|
||||||
|
"contactEmail": "admin@knownelement.com",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"changelog": "Initial Cloudron package (server/client configurable).",
|
||||||
|
"healthCheckPath": "/",
|
||||||
|
"httpPort": 3000,
|
||||||
|
"addons": {
|
||||||
|
"localstorage": {}
|
||||||
|
},
|
||||||
|
"tags": ["network", "tunnel", "reverse-proxy"]
|
||||||
|
}
|
||||||
|
|
41
CloudronPackages/Rathole/Dockerfile
Normal file
41
CloudronPackages/Rathole/Dockerfile
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
FROM cloudron/base:5.0.0
|
||||||
|
|
||||||
|
ARG RATHOLE_VERSION=v0.5.0
|
||||||
|
ARG ARCH=x86_64-unknown-linux-gnu
|
||||||
|
|
||||||
|
USER root
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends curl ca-certificates tar python3 \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
WORKDIR /app/pkg
|
||||||
|
|
||||||
|
# Download Rathole release binary (adjust version/arch via build args)
|
||||||
|
RUN set -eux; \
|
||||||
|
url="https://github.com/rathole-org/rathole/releases/download/${RATHOLE_VERSION}/rathole-${ARCH}.tar.gz"; \
|
||||||
|
echo "Fetching ${url}"; \
|
||||||
|
curl -fsSL "$url" -o rathole.tar.gz; \
|
||||||
|
tar -xzf rathole.tar.gz; \
|
||||||
|
rm rathole.tar.gz; \
|
||||||
|
mv rathole /app/pkg/rathole; \
|
||||||
|
chmod +x /app/pkg/rathole; \
|
||||||
|
chown cloudron:cloudron /app/pkg/rathole
|
||||||
|
|
||||||
|
# Start script
|
||||||
|
COPY start.sh /app/pkg/start.sh
|
||||||
|
RUN chmod +x /app/pkg/start.sh && chown cloudron:cloudron /app/pkg/start.sh
|
||||||
|
|
||||||
|
WORKDIR /app/code
|
||||||
|
RUN mkdir -p /app/data && chown -R cloudron:cloudron /app/data
|
||||||
|
|
||||||
|
USER cloudron
|
||||||
|
|
||||||
|
ENV APP_PORT=3000 \
|
||||||
|
RATHOLE_CONFIG_PATH=/app/data/rathole.toml
|
||||||
|
|
||||||
|
EXPOSE 3000 2333
|
||||||
|
|
||||||
|
HEALTHCHECK --interval=30s --timeout=5s --start-period=20s --retries=3 \
|
||||||
|
CMD curl -fsS http://127.0.0.1:${APP_PORT}/ || exit 1
|
||||||
|
|
||||||
|
CMD ["/app/pkg/start.sh"]
|
36
CloudronPackages/Rathole/README.md
Normal file
36
CloudronPackages/Rathole/README.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Rathole (Cloudron Package)
|
||||||
|
|
||||||
|
Rathole is a reverse proxy that provides secure tunnels for local services.
|
||||||
|
Upstream project: https://github.com/rathole-org/rathole
|
||||||
|
|
||||||
|
This Cloudron package runs Rathole and a lightweight HTTP health endpoint.
|
||||||
|
|
||||||
|
## Defaults
|
||||||
|
- Mode: `server` (server-only package)
|
||||||
|
- Config path: `/app/data/rathole.toml`
|
||||||
|
- Health port: `3000` (Cloudron `httpPort`)
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
- Put your Rathole TOML config at `/app/data/rathole.toml`, or provide it via the `RATHOLE_CONFIG` environment variable on first start.
|
||||||
|
- Example minimal server config is auto-generated if none exists.
|
||||||
|
|
||||||
|
## Build (inside packaging container)
|
||||||
|
```
|
||||||
|
scripts/packaging-up.sh
|
||||||
|
scripts/packaging-exec.sh "docker build -t rathole:dev CloudronPackages/Rathole"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run locally (inside packaging container)
|
||||||
|
```
|
||||||
|
scripts/packaging-exec.sh "docker run --rm -p 3000:3000 -p 2333:2333 -v rathole-data:/app/data rathole:dev"
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: expose additional service ports as needed per your TOML. Container exposes `2333` by default.
|
||||||
|
|
||||||
|
## Deploy to Cloudron
|
||||||
|
Use Cloudron CLI from inside the packaging container:
|
||||||
|
```
|
||||||
|
scripts/packaging-enter.sh
|
||||||
|
cloudron login
|
||||||
|
cloudron install --image rathole:dev
|
||||||
|
```
|
41
CloudronPackages/Rathole/start.sh
Normal file
41
CloudronPackages/Rathole/start.sh
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
log() { echo "[rathole] $(date -Is) $*"; }
|
||||||
|
abort() { echo "[rathole] ERROR: $*" >&2; exit 1; }
|
||||||
|
|
||||||
|
: "${APP_PORT:=3000}"
|
||||||
|
: "${RATHOLE_CONFIG_PATH:=/app/data/rathole.toml}"
|
||||||
|
|
||||||
|
# Ensure data dir exists
|
||||||
|
mkdir -p /app/data
|
||||||
|
chown -R cloudron:cloudron /app/data || true
|
||||||
|
|
||||||
|
# If RATHOLE_CONFIG is provided, write it to config path if file not present
|
||||||
|
if [[ ! -f "$RATHOLE_CONFIG_PATH" && -n "${RATHOLE_CONFIG:-}" ]]; then
|
||||||
|
log "Writing config from RATHOLE_CONFIG env to ${RATHOLE_CONFIG_PATH}"
|
||||||
|
printf "%s\n" "${RATHOLE_CONFIG}" > "$RATHOLE_CONFIG_PATH"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If still no config, create a minimal example for server mode
|
||||||
|
if [[ ! -f "$RATHOLE_CONFIG_PATH" ]]; then
|
||||||
|
log "No config found. Writing a minimal example config (server). Adjust in /app/data/rathole.toml"
|
||||||
|
cat > "$RATHOLE_CONFIG_PATH" <<'TOML'
|
||||||
|
# Minimal Rathole server config example
|
||||||
|
[server]
|
||||||
|
bind_addr = "0.0.0.0:2333"
|
||||||
|
|
||||||
|
# Define services below as needed, for example:
|
||||||
|
# [server.services.echo]
|
||||||
|
# type = "tcp"
|
||||||
|
# local_addr = "127.0.0.1:7"
|
||||||
|
TOML
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Background: lightweight HTTP health endpoint
|
||||||
|
python3 -m http.server "$APP_PORT" --bind 0.0.0.0 >/dev/null 2>&1 &
|
||||||
|
HEALTH_PID=$!
|
||||||
|
log "Started health endpoint on :${APP_PORT} (pid ${HEALTH_PID})"
|
||||||
|
|
||||||
|
log "Launching rathole in server mode with config ${RATHOLE_CONFIG_PATH}"
|
||||||
|
exec /app/pkg/rathole server -c "$RATHOLE_CONFIG_PATH"
|
470
LICENSE
470
LICENSE
@@ -1,235 +1,235 @@
|
|||||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
Version 3, 19 November 2007
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Preamble
|
Preamble
|
||||||
|
|
||||||
The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
|
The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
|
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
|
Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
|
A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
|
The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
|
||||||
|
|
||||||
An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
|
An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and modification follow.
|
The precise terms and conditions for copying, distribution and modification follow.
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
0. Definitions.
|
0. Definitions.
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.
|
"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.
|
To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based on the Program.
|
A "covered work" means either the unmodified Program or a work based on the Program.
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
1. Source Code.
|
1. Source Code.
|
||||||
The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.
|
The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those
|
The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those
|
||||||
subprograms and other parts of the work.
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that same work.
|
The Corresponding Source for a work in source code form is that same work.
|
||||||
|
|
||||||
2. Basic Permissions.
|
2. Basic Permissions.
|
||||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
4. Conveying Verbatim Copies.
|
||||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
5. Conveying Modified Source Versions.
|
||||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".
|
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
6. Conveying Non-Source Forms.
|
||||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||||
|
|
||||||
7. Additional Terms.
|
7. Additional Terms.
|
||||||
"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||||
|
|
||||||
8. Termination.
|
8. Termination.
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
11. Patents.
|
11. Patents.
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".
|
A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent
|
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent
|
||||||
license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may
|
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may
|
||||||
not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
|
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
|
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.
|
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||||
|
|
||||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
16. Limitation of Liability.
|
16. Limitation of Liability.
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
|
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
Copyright (C) <year> <name of author>
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
|
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
|
If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see <http://www.gnu.org/licenses/>.
|
You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see <http://www.gnu.org/licenses/>.
|
||||||
|
1
NonCloudron/RandD/Apps/app.ap4ap.org/Dockerfile
Normal file
1
NonCloudron/RandD/Apps/app.ap4ap.org/Dockerfile
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
1
NonCloudron/RandD/Apps/app.ap4ap.org/devcontainer.json
Normal file
1
NonCloudron/RandD/Apps/app.ap4ap.org/devcontainer.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
5
NonCloudron/RandD/Apps/app.ap4ap.org/docker-compose.yml
Normal file
5
NonCloudron/RandD/Apps/app.ap4ap.org/docker-compose.yml
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
1
NonCloudron/RandD/Apps/app.hfnfc.net/Dockerfile
Normal file
1
NonCloudron/RandD/Apps/app.hfnfc.net/Dockerfile
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
1
NonCloudron/RandD/Apps/app.hfnfc.net/devcontainer.json
Normal file
1
NonCloudron/RandD/Apps/app.hfnfc.net/devcontainer.json
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
5
NonCloudron/RandD/Apps/app.hfnfc.net/docker-compose.yml
Normal file
5
NonCloudron/RandD/Apps/app.hfnfc.net/docker-compose.yml
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
1
NonCloudron/RandD/Apps/app.hfnoc.net/Dockerfile
Normal file
1
NonCloudron/RandD/Apps/app.hfnoc.net/Dockerfile
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
5
NonCloudron/RandD/Apps/app.hfnoc.net/docker-compose.yml
Normal file
5
NonCloudron/RandD/Apps/app.hfnoc.net/docker-compose.yml
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
1
NonCloudron/RandD/Apps/app.rackrental.net/Dockerfile
Normal file
1
NonCloudron/RandD/Apps/app.rackrental.net/Dockerfile
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
1
NonCloudron/RandD/Apps/app.sidedoorgroup.org/Dockerfile
Normal file
1
NonCloudron/RandD/Apps/app.sidedoorgroup.org/Dockerfile
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
1
NonCloudron/RandD/Apps/app.teamrental.net/Dockerfile
Normal file
1
NonCloudron/RandD/Apps/app.teamrental.net/Dockerfile
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
@@ -0,0 +1 @@
|
|||||||
|
# dockerfile for an app at tsys
|
@@ -0,0 +1 @@
|
|||||||
|
# dev environment for an app at tsys
|
@@ -0,0 +1,5 @@
|
|||||||
|
# app docker compose file for tsys
|
||||||
|
|
||||||
|
## app name
|
||||||
|
## ports
|
||||||
|
## deps
|
3
NonCloudron/RandD/GIS-backend/README.md
Normal file
3
NonCloudron/RandD/GIS-backend/README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# TSYS GIS Backend
|
||||||
|
|
||||||
|
This folder contains the GIS related backend docker compose files for TSYS GIS stack. HFNOC will own this.
|
1
NonCloudron/RandD/GIS-backend/input-files/info
Normal file
1
NonCloudron/RandD/GIS-backend/input-files/info
Normal file
@@ -0,0 +1 @@
|
|||||||
|
This directory contains template files for the application at FQDN indidicated by the parent directory. They will be processed using mo (bash mustache).
|
1
NonCloudron/RandD/GIS-backend/output-files/info
Normal file
1
NonCloudron/RandD/GIS-backend/output-files/info
Normal file
@@ -0,0 +1 @@
|
|||||||
|
This directory contains final docker compose files for the application at FQDN indidicated by the parent directory.
|
1
NonCloudron/RandD/GIS-backend/vendor-files/info
Normal file
1
NonCloudron/RandD/GIS-backend/vendor-files/info
Normal file
@@ -0,0 +1 @@
|
|||||||
|
This directory contains files from the vendor unmodified. They serve as a base for the input-files sibling directory
|
1
NonCloudron/RandD/portmap.md
Normal file
1
NonCloudron/RandD/portmap.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# Cosmos port map
|
19
NonCloudron/orchestration/TSYSK8S/TSYSK8S.md
Normal file
19
NonCloudron/orchestration/TSYSK8S/TSYSK8S.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# K8S at TSYS
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
In the near future (by end of 2024) we will need to spin our on premise heavy compute facility back online to run K8S.
|
||||||
|
|
||||||
|
This file is where we will document what that looks like. Mostly it will be used by R&D for the entire SDLC.
|
||||||
|
|
||||||
|
## Ecosystem
|
||||||
|
|
||||||
|
Probably
|
||||||
|
|
||||||
|
- https://github.com/spinnaker/spinnaker
|
||||||
|
|
||||||
|
as the overall orchestration layer.
|
||||||
|
|
||||||
|
Various K8S distributions have emerged.
|
||||||
|
|
||||||
|
We are (as of 10/12) a ways out from needing to worry about this in the critical path. We can go a long way with cloudron / cosmos / coolify and off the shelf docker containers (and even making some of our own containers for the tsys line of business application web sites).
|
9
NonCloudron/orchestration/nonk8s.md
Normal file
9
NonCloudron/orchestration/nonk8s.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Non k8s orchestration
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
Sometimes Subo and RR will want to run large workloads on bare metal. Not using k8s. We need to provide an option for that workload type. Probably managed via slurm.
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
- MAAS
|
160
PackagingForCloudronWorkspace/README.md
Normal file
160
PackagingForCloudronWorkspace/README.md
Normal file
@@ -0,0 +1,160 @@
|
|||||||
|
# Cloudron Packaging Workspace
|
||||||
|
|
||||||
|
This workspace contains development tools and upstream source repositories for Cloudron application packaging.
|
||||||
|
|
||||||
|
## 🏗️ Workspace Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
PackagingForCloudronWorkspace/
|
||||||
|
├── README.md # This file
|
||||||
|
├── Docker/ (gitignored) # Upstream application sources (many apps)
|
||||||
|
├── NonDocker/ (gitignored) # Non-Docker application sources
|
||||||
|
├── UpstreamVendor-Clone.sh # Clone all upstream repositories
|
||||||
|
└── UpstreamVendor-Update.sh # Update existing repositories
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚀 Setup Instructions
|
||||||
|
|
||||||
|
### Initial Setup
|
||||||
|
```bash
|
||||||
|
cd PackagingForCloudronWorkspace/
|
||||||
|
|
||||||
|
# Create Docker directory for upstream sources
|
||||||
|
mkdir -p Docker
|
||||||
|
|
||||||
|
# Make scripts executable
|
||||||
|
chmod +x *.sh
|
||||||
|
|
||||||
|
# Clone all upstream vendor repositories
|
||||||
|
./UpstreamVendor-Clone.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
This clones upstream vendor repositories used when packaging applications for Cloudron.
|
||||||
|
|
||||||
|
### Keeping Sources Updated
|
||||||
|
```bash
|
||||||
|
# Update all existing checkouts to latest versions
|
||||||
|
./UpstreamVendor-Update.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📦 Available Applications
|
||||||
|
|
||||||
|
The workspace contains ~56 upstream application repositories including:
|
||||||
|
|
||||||
|
### High Priority Applications
|
||||||
|
- **apisix** - Apache APISIX API Gateway
|
||||||
|
- **jenkins** - Jenkins CI/CD Platform
|
||||||
|
- **grist-core** - Grist Database/Spreadsheet
|
||||||
|
- **rundeck** - Rundeck Job Scheduler
|
||||||
|
- **reviewboard** - ReviewBoard Code Review
|
||||||
|
- **consuldemocracy** - Consul Democracy Platform
|
||||||
|
|
||||||
|
### Development & Infrastructure Tools
|
||||||
|
- **InvenTree** - Inventory Management System
|
||||||
|
- **elabftw** - Laboratory Management
|
||||||
|
- **netbox-docker** - Network Documentation
|
||||||
|
- **signoz** - Observability Platform
|
||||||
|
- **healthchecks** - Health Monitoring
|
||||||
|
- **fleet** - Device Management
|
||||||
|
|
||||||
|
### Productivity & Specialized Applications
|
||||||
|
- **huginn** - Web Automation
|
||||||
|
- **windmill** - Workflow Automation
|
||||||
|
- **docassemble** - Document Assembly
|
||||||
|
- **jamovi** - Statistical Analysis
|
||||||
|
- And many more...
|
||||||
|
|
||||||
|
## 🛠️ Development Workflow
|
||||||
|
|
||||||
|
### Using the Workspace
|
||||||
|
|
||||||
|
1. **Source Access**: All upstream sources are available in `Docker/[appname]/`
|
||||||
|
2. **Development**: Use the `tsys-cloudron-packaging` container for all work
|
||||||
|
3. **Package Creation**: Create packages in separate temporary directories
|
||||||
|
4. **Git Exclusion**: All upstream sources are gitignored to keep repository clean
|
||||||
|
|
||||||
|
### Container Development
|
||||||
|
```bash
|
||||||
|
# Access development container
|
||||||
|
docker exec -it tsys-cloudron-packaging bash
|
||||||
|
|
||||||
|
# Navigate to workspace
|
||||||
|
cd /workspace
|
||||||
|
|
||||||
|
# Access application source
|
||||||
|
cd CloudronPackagingWorkspace/Docker/[appname]/
|
||||||
|
|
||||||
|
# Create new package (outside of workspace)
|
||||||
|
cd /workspace
|
||||||
|
mkdir -p [appname]_package_new
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📋 Workspace Management
|
||||||
|
|
||||||
|
### Adding New Applications
|
||||||
|
1. Update `UpstreamVendor-Clone.sh` with the new repository URL
|
||||||
|
2. Run the clone script to fetch the new application
|
||||||
|
|
||||||
|
### Removing Applications
|
||||||
|
1. Remove directory from `Docker/`
|
||||||
|
2. Update clone script to prevent future re-cloning
|
||||||
|
|
||||||
|
### Repository Updates
|
||||||
|
- Run `./UpstreamVendor-Update.sh` periodically or before starting packaging work
|
||||||
|
- Check for breaking changes in upstream before building
|
||||||
|
|
||||||
|
## ⚠️ Important Notes
|
||||||
|
|
||||||
|
### Git Exclusions
|
||||||
|
- `Docker/` and `NonDocker/` are gitignored (see repo `.gitignore`)
|
||||||
|
- Keeps the repo slim while preserving local sources
|
||||||
|
|
||||||
|
### Repository Integrity
|
||||||
|
- Never commit upstream sources to the repository
|
||||||
|
- Develop packages outside of `Docker/` (e.g., directly under `CloudronPackages/<AppName>`)
|
||||||
|
|
||||||
|
### Source Licenses
|
||||||
|
- Each upstream repository maintains its own license
|
||||||
|
- Review license compatibility before packaging
|
||||||
|
- Include appropriate license information in final packages
|
||||||
|
|
||||||
|
## 🔧 Script Maintenance
|
||||||
|
|
||||||
|
### UpstreamVendor-Clone.sh
|
||||||
|
- Contains git clone commands for all upstream repositories
|
||||||
|
- Handles both GitHub and other git hosting platforms
|
||||||
|
- Includes error handling for failed clones
|
||||||
|
|
||||||
|
### UpstreamVendor-Update.sh
|
||||||
|
- Updates existing repositories to latest versions
|
||||||
|
- Skips missing directories gracefully
|
||||||
|
- Provides summary of update status
|
||||||
|
|
||||||
|
### Customization
|
||||||
|
Edit scripts as needed to:
|
||||||
|
- Add new repository sources
|
||||||
|
- Change clone depth or branch targets
|
||||||
|
- Modify update behavior
|
||||||
|
- Handle special cases
|
||||||
|
|
||||||
|
## 📊 Notes
|
||||||
|
|
||||||
|
- Number of upstream repositories and size vary over time.
|
||||||
|
|
||||||
|
## 🤝 Team Usage
|
||||||
|
|
||||||
|
### For Developers
|
||||||
|
1. Use `./UpstreamVendor-Clone.sh` on first setup
|
||||||
|
2. Run `./UpstreamVendor-Update.sh` weekly or before new package work
|
||||||
|
3. Always work in the containerized environment
|
||||||
|
4. Never commit workspace contents to git
|
||||||
|
|
||||||
|
### For DevOps
|
||||||
|
1. Monitor disk space usage of workspace
|
||||||
|
2. Ensure container environment has access to workspace
|
||||||
|
3. Backup workspace if needed for disaster recovery
|
||||||
|
4. Update scripts when adding/removing applications
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Maintained By**: KNEL/TSYS Development Team
|
229
PackagingForCloudronWorkspace/UpstreamVendor-Clone.sh
Executable file
229
PackagingForCloudronWorkspace/UpstreamVendor-Clone.sh
Executable file
@@ -0,0 +1,229 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
export PS4='(${BASH_SOURCE}:${LINENO}): - [${SHLVL},${BASH_SUBSHELL},$?] $ '
|
||||||
|
|
||||||
|
function error_out()
|
||||||
|
{
|
||||||
|
echo "Bailing out. See above for reason...."
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
function handle_failure() {
|
||||||
|
local lineno=$1
|
||||||
|
local fn=$2
|
||||||
|
local exitstatus=$3
|
||||||
|
local msg=$4
|
||||||
|
local lineno_fns=${0% 0}
|
||||||
|
if [[ "$lineno_fns" != "-1" ]] ; then
|
||||||
|
lineno="${lineno} ${lineno_fns}"
|
||||||
|
fi
|
||||||
|
echo "${BASH_SOURCE[0]}: Function: ${fn} Line Number : [${lineno}] Failed with status ${exitstatus}: $msg"
|
||||||
|
}
|
||||||
|
|
||||||
|
trap 'handle_failure "${BASH_LINENO[*]}" "$LINENO" "${FUNCNAME[*]:-script}" "$?" "$BASH_COMMAND"' ERR
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
set -o functrace
|
||||||
|
|
||||||
|
|
||||||
|
export GIT_REPO_LIST
|
||||||
|
GIT_REPO_LIST=(
|
||||||
|
|
||||||
|
####################
|
||||||
|
# Vp techops stuff
|
||||||
|
####################
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/179
|
||||||
|
https://github.com/apache/apisix.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/204
|
||||||
|
https://github.com/target/goalert.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/189
|
||||||
|
https://github.com/consuldemocracy/consuldemocracy.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/195
|
||||||
|
https://github.com/fleetdm/fleet.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/227
|
||||||
|
https://github.com/fonoster/fonoster.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/192
|
||||||
|
https://github.com/healthchecks/healthchecks.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/209
|
||||||
|
https://github.com/juspay/hyperswitch
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/201
|
||||||
|
https://github.com/netbox-community/netbox-docker.git
|
||||||
|
|
||||||
|
# https://projects.knownelement.com/issues/205
|
||||||
|
https://github.com/openboxes/openboxes-docker.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/316
|
||||||
|
https://github.com/openfiletax/openfile.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/211
|
||||||
|
https://github.com/GemGeorge/SniperPhish-Docker.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/309
|
||||||
|
https://github.com/datahub-project/datahub.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/54
|
||||||
|
https://github.com/wiredlush/easy-gate.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/208
|
||||||
|
https://github.com/Payroll-Engine/PayrollEngine.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/194
|
||||||
|
https://github.com/huginn/huginn.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/191
|
||||||
|
https://github.com/gristlabs/grist-core
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/277
|
||||||
|
https://github.com/jhpyle/docassemble.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/273
|
||||||
|
https://github.com/kazhuravlev/database-gateway.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/217
|
||||||
|
https://github.com/rundeck/rundeck.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/222
|
||||||
|
https://github.com/SchedMD/slurm.git
|
||||||
|
https://github.com/giovtorres/slurm-docker-cluster.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/225
|
||||||
|
https://github.com/rathole-org/rathole.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/234
|
||||||
|
https://github.com/jenkinsci/jenkins.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/322
|
||||||
|
https://github.com/runmedev/runme.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/301
|
||||||
|
https://github.com/apache/seatunnel
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/271
|
||||||
|
https://github.com/thecatlady/docker-webhook
|
||||||
|
|
||||||
|
####################
|
||||||
|
# CTO Stuff
|
||||||
|
####################
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/173
|
||||||
|
https://github.com/inventree/InvenTree.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/180
|
||||||
|
https://github.com/Cloud-RF/tak-server
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/178
|
||||||
|
https://github.com/midday-ai/midday.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/181
|
||||||
|
https://github.com/killbill/killbill.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/184
|
||||||
|
https://github.com/chirpstack/chirpstack.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/185
|
||||||
|
https://github.com/CraigChat/craig.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/188
|
||||||
|
https://github.com/elabftw/elabftw.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/196
|
||||||
|
https://github.com/jamovi/jamovi.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/197
|
||||||
|
https://github.com/INTI-CMNB/KiBot.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/214
|
||||||
|
https://github.com/Resgrid/Core
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/216
|
||||||
|
https://github.com/reviewboard/reviewboard.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/218
|
||||||
|
https://gitlab.com/librespacefoundation/satnogs/docker-kaitai.git
|
||||||
|
https://gitlab.com/librespacefoundation/satnogs/docker-satnogs-webgui.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/219
|
||||||
|
https://github.com/f4exb/sdrangel-docker
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/221
|
||||||
|
https://github.com/SigNoz/signoz.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/228
|
||||||
|
https://github.com/sebo-b/warp.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/272
|
||||||
|
https://github.com/jgraph/docker-drawio
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/274
|
||||||
|
https://github.com/openblocks-dev/openblocks.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/276
|
||||||
|
https://github.com/wireviz/wireviz-web.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/278
|
||||||
|
https://github.com/opulo-inc/autobom.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/279
|
||||||
|
https://github.com/PLMore/PLMore
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/282
|
||||||
|
https://github.com/manyfold3d/manyfold.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/283
|
||||||
|
https://github.com/langfuse/oss-llmops-stack.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/286
|
||||||
|
https://github.com/HeyPuter/puter.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/285
|
||||||
|
https://github.com/windmill-labs/windmill.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/326
|
||||||
|
https://github.com/sbabic/swupdate.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/300
|
||||||
|
https://github.com/mendersoftware/mender-server.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/50
|
||||||
|
https://github.com/vanila-io/wireflow.git
|
||||||
|
|
||||||
|
#https://projects.knownelement.com/issues/226
|
||||||
|
https://github.com/nautechsystems/nautilus_trader.git
|
||||||
|
|
||||||
|
#TBD
|
||||||
|
https://github.com/funmusicplace/mirlo.git
|
||||||
|
|
||||||
|
)
|
||||||
|
|
||||||
|
WORKDIR="$(cd "$(dirname "$0")" && pwd)"
|
||||||
|
TARGET_DIR="${WORKDIR}/Docker"
|
||||||
|
mkdir -p "$TARGET_DIR"
|
||||||
|
|
||||||
|
# If REPOS.txt exists, read additional repos (lines; ignore # and blanks)
|
||||||
|
EXTRA_REPOS_FILE="${WORKDIR}/REPOS.txt"
|
||||||
|
if [[ -f "$EXTRA_REPOS_FILE" ]]; then
|
||||||
|
mapfile -t EXTRA_REPOS < <(sed -e 's/#.*$//' -e '/^\s*$/d' "$EXTRA_REPOS_FILE")
|
||||||
|
else
|
||||||
|
EXTRA_REPOS=()
|
||||||
|
fi
|
||||||
|
|
||||||
|
ALL_REPOS=("${GIT_REPO_LIST[@]}" "${EXTRA_REPOS[@]}")
|
||||||
|
|
||||||
|
echo "Cloning to: $TARGET_DIR"
|
||||||
|
printf ' - %s\n' "${ALL_REPOS[@]}"
|
||||||
|
|
||||||
|
cd "$TARGET_DIR"
|
||||||
|
|
||||||
|
# Parallel clones (default 4 jobs). Avoid failing the whole script on single failures.
|
||||||
|
JOBS="${JOBS:-4}"
|
||||||
|
printf '%s\n' "${ALL_REPOS[@]}" | xargs -n1 -P "$JOBS" -I{} bash -lc 'repo="{}"; name=$(basename -s .git "$repo"); if [[ -d "$name/.git" ]]; then echo "exists: $name"; else git clone --depth 1 "$repo" "$name" || echo "failed: $repo"; fi'
|
47
PackagingForCloudronWorkspace/UpstreamVendor-Update.sh
Executable file
47
PackagingForCloudronWorkspace/UpstreamVendor-Update.sh
Executable file
@@ -0,0 +1,47 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
export PS4='(${BASH_SOURCE}:${LINENO}): - [${SHLVL},${BASH_SUBSHELL},$?] $ '
|
||||||
|
|
||||||
|
function error_out()
|
||||||
|
{
|
||||||
|
echo "Bailing out. See above for reason...."
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
function handle_failure() {
|
||||||
|
local lineno=$1
|
||||||
|
local fn=$2
|
||||||
|
local exitstatus=$3
|
||||||
|
local msg=$4
|
||||||
|
local lineno_fns=${0% 0}
|
||||||
|
if [[ "$lineno_fns" != "-1" ]] ; then
|
||||||
|
lineno="${lineno} ${lineno_fns}"
|
||||||
|
fi
|
||||||
|
echo "${BASH_SOURCE[0]}: Function: ${fn} Line Number : [${lineno}] Failed with status ${exitstatus}: $msg"
|
||||||
|
}
|
||||||
|
|
||||||
|
trap 'handle_failure "${BASH_LINENO[*]}" "$LINENO" "${FUNCNAME[*]:-script}" "$?" "$BASH_COMMAND"' ERR
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
set -o pipefail
|
||||||
|
set -o functrace
|
||||||
|
|
||||||
|
WORKDIR="$(cd "$(dirname "$0")" && pwd)"
|
||||||
|
TARGET_DIR="${WORKDIR}/Docker"
|
||||||
|
|
||||||
|
cd "$TARGET_DIR"
|
||||||
|
|
||||||
|
# Iterate only over directories that are git repos
|
||||||
|
while IFS= read -r -d '' repo_dir; do
|
||||||
|
echo "Updating: ${repo_dir}"
|
||||||
|
pushd "$repo_dir" >/dev/null
|
||||||
|
if [[ -d .git ]]; then
|
||||||
|
git -c advice.detachedHead=false fetch --all --prune || true
|
||||||
|
# Fast-forward only to avoid unintended merges
|
||||||
|
git -c advice.detachedHead=false pull --ff-only || true
|
||||||
|
else
|
||||||
|
echo "Skipping (not a git repo): ${repo_dir}"
|
||||||
|
fi
|
||||||
|
popd >/dev/null
|
||||||
|
done < <(find . -mindepth 1 -maxdepth 1 -type d -print0)
|
118
README.md
118
README.md
@@ -1,3 +1,117 @@
|
|||||||
# ConHost
|
# KNEL Production Containers (Streamlined)
|
||||||
|
|
||||||
Docker compose files for everything running on conhost VM
|
Single-branch, streamlined repository for container work at KNEL. The focus is Cloudron app packaging and a small set of non‑Cloudron artifacts. All work happens directly on `main`.
|
||||||
|
|
||||||
|
## Layout
|
||||||
|
|
||||||
|
- `CloudronPackages/`
|
||||||
|
- Empty scaffold for Cloudron app packages. Create a subfolder per app and add your packaging files there.
|
||||||
|
- Tracked with `.gitkeep` so the directory exists in a clean repo.
|
||||||
|
- `PackagingForCloudronWorkspace/`
|
||||||
|
- Helper scripts and a workspace for interacting with upstream sources.
|
||||||
|
- Subfolders `Docker/` and `NonDocker/` are ignored by git (see `.gitignore`).
|
||||||
|
- Scripts: `UpstreamVendor-Clone.sh`, `UpstreamVendor-Update.sh`.
|
||||||
|
- `NonCloudron/`
|
||||||
|
- Non‑Cloudron experiments and orchestration notes.
|
||||||
|
- `.gitignore`, `LICENSE`, `README.md`
|
||||||
|
|
||||||
|
## Workflow (single branch)
|
||||||
|
|
||||||
|
- Branching: use only `main`.
|
||||||
|
- Commit small, focused changes; push directly to `origin/main`.
|
||||||
|
- No integration/feature branch dance; avoid long‑lived branches.
|
||||||
|
|
||||||
|
## No Host Pollution (containers only)
|
||||||
|
|
||||||
|
- Host requirements: `docker`, `git` (and optionally `tea`). Nothing else.
|
||||||
|
- All packaging work runs inside the packaging container. Do not install build tools on the host.
|
||||||
|
- Use the scripts provided:
|
||||||
|
- `scripts/packaging-up.sh` – build/run the packaging container (mounts repo, docker socket)
|
||||||
|
- `scripts/packaging-enter.sh` – open a shell inside the container
|
||||||
|
- `scripts/packaging-exec.sh <cmd>` – run a command inside the container
|
||||||
|
- `scripts/workspace-clone.sh` – run upstream clone inside the container
|
||||||
|
- `scripts/workspace-update.sh` – run upstream update inside the container
|
||||||
|
|
||||||
|
The container image includes Docker CLI and Cloudron CLI, and accesses the host Docker via `/var/run/docker.sock`.
|
||||||
|
|
||||||
|
Quick start:
|
||||||
|
```
|
||||||
|
# Start container
|
||||||
|
scripts/packaging-up.sh
|
||||||
|
|
||||||
|
# Enter container shell
|
||||||
|
scripts/packaging-enter.sh
|
||||||
|
|
||||||
|
# Clone upstreams inside container
|
||||||
|
scripts/workspace-clone.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
## Add a new Cloudron package
|
||||||
|
|
||||||
|
1) Create the package folder
|
||||||
|
- `mkdir -p CloudronPackages/<AppName>`
|
||||||
|
|
||||||
|
2) Add the required files
|
||||||
|
- `CloudronManifest.json` – app metadata and addon requirements
|
||||||
|
- `Dockerfile` – image build instructions (use cloudron/base as appropriate)
|
||||||
|
- `start.sh` – container entry script
|
||||||
|
- Optional: `nginx.conf`, `supervisord.conf`, `config.yaml`, `logo.png`, build notes
|
||||||
|
|
||||||
|
3) Build/test locally (example)
|
||||||
|
- `docker build -t <app>:dev CloudronPackages/<AppName>`
|
||||||
|
- `docker run --rm -p 8080:8080 <app>:dev`
|
||||||
|
|
||||||
|
4) Commit and push
|
||||||
|
- `git add CloudronPackages/<AppName>/`
|
||||||
|
- `git commit -m "feat(<app>): initial Cloudron package"`
|
||||||
|
- `git push origin main`
|
||||||
|
|
||||||
|
## Packaging workspace tips
|
||||||
|
|
||||||
|
- The workspace under `PackagingForCloudronWorkspace/` is for local convenience and upstream sync.
|
||||||
|
- `Docker/` and `NonDocker/` inside that directory are intentionally gitignored to keep the repo slim.
|
||||||
|
- Keep scripts and minimal config tracked; keep large clones and build outputs out of git.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- This repo was reset to a simplified structure; historical multi‑branch workflows and extensive docs were removed to reduce friction.
|
||||||
|
- If you need legacy materials, refer to your local history/tags or the remote history prior to this cleanup.
|
||||||
|
|
||||||
|
### For KNEL Team Members
|
||||||
|
1. Review [PLAN.md](PLAN.md) for current priorities
|
||||||
|
2. Check [TASKS.md](TASKS.md) for available applications
|
||||||
|
3. Follow the packaging workflow above
|
||||||
|
4. Update documentation as you work
|
||||||
|
5. Create feature branches for each application
|
||||||
|
|
||||||
|
### Code Review Checklist
|
||||||
|
- [ ] Dockerfile follows Cloudron conventions
|
||||||
|
- [ ] All required files present and properly configured
|
||||||
|
- [ ] Health checks implemented
|
||||||
|
- [ ] Logging configured to stdout/stderr
|
||||||
|
- [ ] Security best practices followed
|
||||||
|
- [ ] Documentation updated
|
||||||
|
- [ ] Build notes include testing steps
|
||||||
|
|
||||||
|
## 🐛 Troubleshooting
|
||||||
|
|
||||||
|
### Common Issues
|
||||||
|
- **Container won't start**: Check logs with `cloudron logs --app [appname]`
|
||||||
|
- **Database connection fails**: Verify addon environment variables
|
||||||
|
- **Static files not served**: Check nginx configuration and file permissions
|
||||||
|
- **Health check fails**: Verify health check endpoint returns 200 OK
|
||||||
|
|
||||||
|
### Getting Help
|
||||||
|
- Check build notes in `CloudronPackages/[AppName]/`
|
||||||
|
- Review Cloudron documentation
|
||||||
|
- Examine working examples (EasyGate, InvenTree)
|
||||||
|
- Use `cloudron debug --app [appname]` for interactive debugging
|
||||||
|
|
||||||
|
## 📝 License
|
||||||
|
|
||||||
|
See [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Last Updated**: 2025-01-04
|
||||||
|
**Maintainers**: KNEL/TSYS Development Team
|
||||||
|
17
docker/packaging/Dockerfile
Normal file
17
docker/packaging/Dockerfile
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
FROM docker:26-cli
|
||||||
|
|
||||||
|
# Install tools needed for Cloudron packaging inside the container
|
||||||
|
RUN apk add --no-cache \
|
||||||
|
bash git curl jq \
|
||||||
|
build-base \
|
||||||
|
nodejs npm \
|
||||||
|
openssh-client
|
||||||
|
|
||||||
|
# Cloudron CLI (used for packaging commands)
|
||||||
|
RUN npm i -g cloudron
|
||||||
|
|
||||||
|
WORKDIR /workspace
|
||||||
|
|
||||||
|
# Default command keeps the container running
|
||||||
|
CMD ["sh", "-lc", "tail -f /dev/null"]
|
||||||
|
|
55
scripts/new-package.sh
Executable file
55
scripts/new-package.sh
Executable file
@@ -0,0 +1,55 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
usage() {
|
||||||
|
cat <<'EOF'
|
||||||
|
Usage: scripts/new-package.sh <AppName> [--id <com.example.app>] [--title <Title>] [--port <port>]
|
||||||
|
|
||||||
|
Creates CloudronPackages/<AppName> from PackageTemplate and replaces placeholders:
|
||||||
|
__APP_ID__, __APP_TITLE__, __HTTP_PORT__
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
scripts/new-package.sh MyApp --id com.example.myapp --title "My App" --port 3000
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
if [[ $# -lt 1 ]]; then
|
||||||
|
usage; exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
APP_NAME="$1"; shift
|
||||||
|
APP_ID="com.example.${APP_NAME,,}"
|
||||||
|
APP_TITLE="$APP_NAME"
|
||||||
|
HTTP_PORT="3000"
|
||||||
|
BASE_TAG="5.0.0"
|
||||||
|
|
||||||
|
while [[ $# -gt 0 ]]; do
|
||||||
|
case "$1" in
|
||||||
|
--id) APP_ID="$2"; shift 2;;
|
||||||
|
--title) APP_TITLE="$2"; shift 2;;
|
||||||
|
--port) HTTP_PORT="$2"; shift 2;;
|
||||||
|
--base) BASE_TAG="$2"; shift 2;;
|
||||||
|
-h|--help) usage; exit 0;;
|
||||||
|
*) echo "Unknown argument: $1"; usage; exit 1;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
SRC_DIR="CloudronPackages/PackageTemplate"
|
||||||
|
DEST_DIR="CloudronPackages/${APP_NAME}"
|
||||||
|
|
||||||
|
[[ -d "$SRC_DIR" ]] || { echo "Template not found: $SRC_DIR"; exit 1; }
|
||||||
|
[[ -e "$DEST_DIR" ]] && { echo "Destination already exists: $DEST_DIR"; exit 1; }
|
||||||
|
|
||||||
|
mkdir -p "$DEST_DIR"
|
||||||
|
cp -a "$SRC_DIR"/. "$DEST_DIR"/
|
||||||
|
|
||||||
|
# Replace placeholders in text files
|
||||||
|
find "$DEST_DIR" -type f \( -name "*" ! -name "*.png" \) -print0 | while IFS= read -r -d '' f; do
|
||||||
|
sed -i "s#__APP_ID__#${APP_ID}#g" "$f"
|
||||||
|
sed -i "s#__APP_TITLE__#${APP_TITLE}#g" "$f"
|
||||||
|
sed -i "s#__HTTP_PORT__#${HTTP_PORT}#g" "$f"
|
||||||
|
sed -i "s#__CLOUDRON_BASE__#${BASE_TAG}#g" "$f"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "Created package at: $DEST_DIR"
|
||||||
|
echo "Next steps: edit Dockerfile and start.sh to run your app. Add logo.png if desired."
|
10
scripts/packaging-enter.sh
Executable file
10
scripts/packaging-enter.sh
Executable file
@@ -0,0 +1,10 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
NAME=${PACKAGING_CONTAINER_NAME:-tsys-cloudron-packaging}
|
||||||
|
|
||||||
|
if ! docker ps --format '{{.Names}}' | grep -qx "$NAME"; then
|
||||||
|
scripts/packaging-up.sh >/dev/null
|
||||||
|
fi
|
||||||
|
|
||||||
|
exec docker exec -it "$NAME" bash
|
||||||
|
|
15
scripts/packaging-exec.sh
Executable file
15
scripts/packaging-exec.sh
Executable file
@@ -0,0 +1,15 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
NAME=${PACKAGING_CONTAINER_NAME:-tsys-cloudron-packaging}
|
||||||
|
|
||||||
|
if [[ $# -lt 1 ]]; then
|
||||||
|
echo "Usage: scripts/packaging-exec.sh <command...>" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! docker ps --format '{{.Names}}' | grep -qx "$NAME"; then
|
||||||
|
scripts/packaging-up.sh >/dev/null
|
||||||
|
fi
|
||||||
|
|
||||||
|
exec docker exec -it "$NAME" sh -lc "$*"
|
||||||
|
|
30
scripts/packaging-up.sh
Executable file
30
scripts/packaging-up.sh
Executable file
@@ -0,0 +1,30 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
NAME=${PACKAGING_CONTAINER_NAME:-tsys-cloudron-packaging}
|
||||||
|
IMAGE=${PACKAGING_IMAGE:-knel/packaging:latest}
|
||||||
|
DOCKERFILE=${PACKAGING_DOCKERFILE:-docker/packaging/Dockerfile}
|
||||||
|
|
||||||
|
if ! docker image inspect "$IMAGE" >/dev/null 2>&1; then
|
||||||
|
echo "Building packaging image: $IMAGE"
|
||||||
|
docker build -t "$IMAGE" -f "$DOCKERFILE" .
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! docker ps -a --format '{{.Names}}' | grep -qx "$NAME"; then
|
||||||
|
echo "Creating container: $NAME"
|
||||||
|
docker run -d \
|
||||||
|
--name "$NAME" \
|
||||||
|
-v "$PWD":/workspace \
|
||||||
|
-w /workspace \
|
||||||
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||||
|
"$IMAGE"
|
||||||
|
else
|
||||||
|
# Ensure it is running
|
||||||
|
if ! docker ps --format '{{.Names}}' | grep -qx "$NAME"; then
|
||||||
|
echo "Starting container: $NAME"
|
||||||
|
docker start "$NAME"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Packaging container ready: $NAME (image: $IMAGE)"
|
||||||
|
|
6
scripts/workspace-clone.sh
Executable file
6
scripts/workspace-clone.sh
Executable file
@@ -0,0 +1,6 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Run the clone script inside the packaging container
|
||||||
|
scripts/packaging-exec.sh "cd PackagingForCloudronWorkspace && chmod +x *.sh && ./UpstreamVendor-Clone.sh"
|
||||||
|
|
6
scripts/workspace-update.sh
Executable file
6
scripts/workspace-update.sh
Executable file
@@ -0,0 +1,6 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Run the update script inside the packaging container
|
||||||
|
scripts/packaging-exec.sh "cd PackagingForCloudronWorkspace && chmod +x *.sh && ./UpstreamVendor-Update.sh"
|
||||||
|
|
Reference in New Issue
Block a user