From d88a6559e0704848f9216b0d2c3b819584be065c Mon Sep 17 00:00:00 2001 From: superengine Date: Wed, 23 Apr 2025 19:26:20 +0000 Subject: [PATCH] Initial commit --- LICENSE.txt | 10 ++++++ NOTICE.txt | 4 +++ README.md | 19 ++++++++++++ compose.yaml.hbs | 18 +++++++++++ manifest.json | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 130 insertions(+) create mode 100644 LICENSE.txt create mode 100644 NOTICE.txt create mode 100644 README.md create mode 100644 compose.yaml.hbs create mode 100644 manifest.json diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..c324e29 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,10 @@ +This software is licensed under the Software License Agreement for Ports available at the URI bellow: +https://www.superengine.tech/legal/software-license-agreement-for-ports +If, for any reason, the URI provided in this file to the Software License Agreement for Ports does not redirect to the website of the copyright owner of this software, and, to the correct page on this website, you may not use this software. + +This license does not apply to the files not under Superengine copyright as detailed in the NOTICE.txt file. +The picture.png file is licenced under the Creative Commons CC BY-SA 4.0 license (https://creativecommons.org/licenses/by-sa/4.0/). + +This software uses the following third-party software: +- the mariadb image with the tag 11.7.2 from Docker Hub +Third-party software have a different copyright owner and license. \ No newline at end of file diff --git a/NOTICE.txt b/NOTICE.txt new file mode 100644 index 0000000..f4a8104 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1,4 @@ +Copyright 2025 Superengine, except for the following files: +- picture.png + +For the picture.png file: material by the MariaDB Foundation, licensed under the Creative Commons CC BY-SA 4.0 license (https://creativecommons.org/licenses/by-sa/4.0/). \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0171d2e --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# MariaDB Port for Superengine + +This port uses the `mariadb` image which is the ["official" MariaDB Docker image](https://hub.docker.com/_/mariadb/) with the tag `11.7.2`. The port may be updated to use a newer tag in the future. + +## Installation + +Open Superengine, click `Install app` and enter the following app installation code: `0M4Qxo2zdzDLKbQyanw5hvpYgg1PL1d3wRSWii7vbVBB3iZbXfUKxhYeBaMNpVHvpfMnATbpFVLFM93K4` + +## Configuration + +The database name, user, password and root password for MariaDB are randomly generated by Superengine. The port number is static and provided by Superengine. The values for these configuration settings are displayed in the application page in Superengine. + +## Data + +Data is saved in the application data folder. + +## Copyright and License + +See the NOTICE.txt file for copyright information and the LICENSE.txt file for information about the license. \ No newline at end of file diff --git a/compose.yaml.hbs b/compose.yaml.hbs new file mode 100644 index 0000000..e6c11e2 --- /dev/null +++ b/compose.yaml.hbs @@ -0,0 +1,18 @@ +services: + {{app_id}}-mariadb: + image: mariadb:11.7.2 + restart: always + environment: + MARIADB_USER: {{entitlements.db-user}} + MARIADB_PASSWORD: {{entitlements.db-password}} + MARIADB_DATABASE: {{entitlements.db-name}} + MARIADB_ROOT_PASSWORD: {{entitlements.db-root-password}} + volumes: + - {{entitlements.folder-path}}:/var/lib/mysql + ports: + - {{entitlements.port-number}}:3306 + {{#unless (eq entitlements.os "windows")}} + user: {{entitlements.uid}}:{{entitlements.gid}} + {{/unless}} + logging: + driver: local diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..e0bc110 --- /dev/null +++ b/manifest.json @@ -0,0 +1,79 @@ +{ + "spec-version": "1.1", + "subject": { + "name": { + "en": "MariaDB" + }, + "version": "11.7.2-5" + }, + "entitlements": [ + { + "type": "RandomAlphanumericString30Characters", + "name": "db-user", + "description": { + "en": "Name of the database user." + } + }, + { + "type": "RandomAlphanumericString30Characters", + "name": "db-password", + "description": { + "en": "Password of the database user." + } + }, + { + "type": "RandomAlphanumericString30Characters", + "name": "db-name", + "description": { + "en": "Database name." + } + }, + { + "type": "RandomAlphanumericString30Characters", + "name": "db-root-password", + "description": { + "en": "Root password of the database." + } + }, + { + "type": "ApplicationDataDirectoryPath", + "name": "folder-path", + "description": { + "en": "Folder used by the database to store data." + } + }, + { + "type": "PortUnspecifiedStaticNumber", + "name": "port-number", + "description": { + "en": "Number of the port used by the database." + } + }, + { + "type": "OperatingSystem", + "name": "os", + "description": { + "en": "Operating system." + } + }, + { + "type": "IDUserNumber", + "name": "uid", + "description": { + "en": "User ID number." + } + }, + { + "type": "IDGroupNumber", + "name": "gid", + "description": { + "en": "Group ID number." + } + } + ], + "templates": [ + "compose.yaml.hbs", + "embedded_ui/overview.html.hbs" + ], + "actions": [] +}