From 84aefa2d5add334a451af1aede4e2f583ff7ccfd Mon Sep 17 00:00:00 2001 From: Juergen Kunz Date: Thu, 7 May 2026 20:22:12 +0000 Subject: [PATCH] docs: refresh readme and legal info --- license | 21 +++++++++ readme.md | 133 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 154 insertions(+) create mode 100644 license create mode 100644 readme.md diff --git a/license b/license new file mode 100644 index 0000000..6f1b27d --- /dev/null +++ b/license @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) Task Venture Capital GmbH + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..ea7cc62 --- /dev/null +++ b/readme.md @@ -0,0 +1,133 @@ +# serve.zone App Store App Templates + +This repository is the curated template catalog consumed by the Onebox App Store. It is intentionally data-only: the repo contains catalog metadata plus per-app version configuration for deployable containers and their platform requirements. + +## Issue Reporting and Security + +For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly. + +## What Is In This Repo + +| File or directory | Purpose | +| --- | --- | +| `catalog.json` | Top-level catalog index with app IDs, display names, descriptions, categories, icons, latest versions, and tags. | +| `apps//app.json` | App-specific metadata, maintained version list, and optional links. | +| `apps//versions//config.json` | Deployable version definition: image, internal port, environment variables, platform requirements, and compatibility metadata. | + +No source code, package manifest, test runner, or build step exists here today. Changes are reviewed by reading the JSON data and by testing the affected templates in Onebox. + +## Current Catalog + +The catalog currently lists 17 app templates. + +| App ID | Name | Catalog category | Image | Port | +| --- | --- | --- | --- | --- | +| `adminer` | Adminer | Dev Tools | `adminer:latest` | `8080` | +| `cloudly` | Cloudly | Dev Tools | `code.foss.global/serve.zone/cloudly:latest` | `80` | +| `ghost` | Ghost | CMS | `ghost:latest` | `2368` | +| `gitea` | Gitea | Dev Tools | `gitea/gitea:latest` | `3000` | +| `grafana` | Grafana | Monitoring | `grafana/grafana:latest` | `3000` | +| `mariadb` | MariaDB | Database | `mariadb:latest` | `3306` | +| `mattermost` | Mattermost | Communication | `mattermost/mattermost-team-edition:latest` | `8065` | +| `n8n` | N8N | Automation | `n8nio/n8n:latest` | `5678` | +| `nextcloud` | Nextcloud | Storage | `nextcloud:latest` | `80` | +| `nginx` | Nginx | Web Server | `nginx:alpine` | `80` | +| `plausible` | Plausible Analytics | Analytics | `plausible/analytics:latest` | `8000` | +| `portainer` | Portainer | Dev Tools | `portainer/portainer-ce:latest` | `9000` | +| `postgres` | PostgreSQL | Database | `postgres:16-alpine` | `5432` | +| `redis` | Redis | Database | `redis:alpine` | `6379` | +| `uptime-kuma` | Uptime Kuma | Monitoring | `louislam/uptime-kuma:latest` | `3001` | +| `vaultwarden` | Vaultwarden | Security | `vaultwarden/server:latest` | `80` | +| `wordpress` | WordPress | CMS | `wordpress:latest` | `80` | + +## Platform Requirements + +Some templates ask Onebox to provision local platform services and inject connection variables into the workload. + +| App ID | Requirements | Notes | +| --- | --- | --- | +| `cloudly` | MongoDB, S3 | Requires Onebox `1.24.2` or newer. Uses provisioned MongoDB and MinIO/S3 values for Cloudly state and registry storage. | +| `ghost` | MariaDB | Uses MySQL-style `database__connection__*` environment variables. | +| `gitea` | MariaDB | Uses Gitea database environment variables with `${MARIADB_*}` placeholders. | +| `nextcloud` | MariaDB, Redis | Uses MySQL-compatible database variables. Redis is declared as a platform requirement. | +| `plausible` | ClickHouse | Declares ClickHouse as a platform requirement. | +| `wordpress` | MariaDB | Uses standard WordPress database environment variables. | + +Standalone templates such as `nginx`, `adminer`, `redis`, `portainer`, `mattermost`, `n8n`, `uptime-kuma`, and `vaultwarden` currently define only image and port unless their version config adds explicit environment variables. + +## Template Schema In Practice + +Version configs use a small, pragmatic schema understood by Onebox: + +```jsonc +{ + "image": "container/image:tag", + "port": 8080, + "envVars": [ + { + "key": "ENV_NAME", + "value": "${PLACEHOLDER_OR_DEFAULT}", + "description": "Shown in the App Store UI", + "required": true + } + ], + "platformRequirements": { + "mariadb": true, + "mongodb": true, + "s3": true, + "redis": true, + "clickhouse": true + }, + "minOneboxVersion": "1.24.2" +} +``` + +Only include keys that are actually needed by a template. For example, `nginx` is currently just: + +```json +{ + "image": "nginx:alpine", + "port": 80 +} +``` + +## Working With Templates + +- Keep `catalog.json`, `apps//app.json`, and each version config in sync when adding or changing an app. +- Prefer explicit environment variable descriptions because Onebox surfaces them to users during installation. +- Use platform placeholders such as `${MARIADB_HOST}`, `${MARIADB_PORT}`, `${MARIADB_DATABASE}`, `${MARIADB_USER}`, `${MARIADB_PASSWORD}`, `${MONGODB_URI}`, `${S3_BUCKET}`, `${S3_ACCESS_KEY}`, and `${S3_SECRET_KEY}` only when the matching platform service is declared. +- Keep template images boring and operationally safe unless there is a reason to pin a more specific upstream tag. +- Validate non-trivial templates by installing them through Onebox instead of only checking JSON syntax. + +## Project Map + +```text +appstore-apptemplates/ +├── catalog.json +└── apps/ + ├── cloudly/ + │ ├── app.json + │ └── versions/1.0.0/config.json + └── ... +``` + +## License and Legal Information + +This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file. + +**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file. + +### Trademarks + +This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein. + +Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar. + +### Company Information + +Task Venture Capital GmbH +Registered at District Court Bremen HRB 35230 HB, Germany + +For any legal inquiries or further information, please contact us via email at hello@task.vc. + +By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.