From 1171ac482644d1c111c583aa1a5d3d7bb5992201 Mon Sep 17 00:00:00 2001 From: superengine Date: Tue, 6 May 2025 20:16:30 +0000 Subject: [PATCH] Initial commit --- LICENSE.txt | 11 +++++++ NOTICE.txt | 2 ++ README.md | 15 +++++++++ compose.yaml.hbs | 43 +++++++++++++++++++++++++ manifest.json | 81 ++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 152 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..2ab7d66 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,11 @@ +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. + +This software uses the following third-party software: +- the docmost/docmost image with the tag 0.20.4 from Docker Hub +- the postgres image with the tag 17.4 from Docker Hub +- the redis image with the tag 8.0.0 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..55c0657 --- /dev/null +++ b/NOTICE.txt @@ -0,0 +1,2 @@ +Copyright 2025 Superengine, except for the following files: +- picture.png \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b5a875f --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Docmost Port for Superengine + +This port uses the [docmost/docmost image](https://hub.docker.com/r/docmost/docmost/) with the tag `0.20.4` and includes PostgreSQL and Redis databases. The port may be updated to use newer tags in the future. + +## Installation + +Open Superengine, click `Install app` and enter the following app installation code: `0oCbUABbeQdGUGEEjYw5hvpYgg1PL1d3wRSWii7vbVBB3iZbXfUKxhYeBaMNpVHvpfMnATbpFVLFM93K4` + +## 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..1544885 --- /dev/null +++ b/compose.yaml.hbs @@ -0,0 +1,43 @@ +services: + {{app_id}}-docmost: + image: docmost/docmost:0.20.4 + restart: always + environment: + APP_SECRET: {{entitlements.docmost-app-secret}} + DATABASE_URL: postgres://docmost:{{entitlements.postgresql-password}}@{{app_id}}-postgresql/docmost + REDIS_URL: redis://{{app_id}}-redis:6379 + volumes: + - {{entitlements.folder-path}}{{#if (eq entitlements.os "windows")}}\\{{else}}/{{/if}}/docmost:/app/data/storage + ports: + - {{entitlements.port-number}}:3000 + logging: + driver: local + depends_on: + - {{app_id}}-postgresql + - {{app_id}}-redis + + {{app_id}}-postgresql: + image: postgres:17.4 + restart: always + environment: + POSTGRES_USER: docmost + POSTGRES_PASSWORD: {{entitlements.postgresql-password}} + POSTGRES_DB: docmost + volumes: + - {{entitlements.folder-path}}{{#if (eq entitlements.os "windows")}}\\{{else}}/{{/if}}postgresql:/var/lib/postgresql/data + {{#unless (eq entitlements.os "windows")}} + user: {{entitlements.uid}}:{{entitlements.gid}} + {{/unless}} + logging: + driver: local + + {{app_id}}-redis: + image: redis:8.0.0 + restart: always + volumes: + - {{entitlements.folder-path}}{{#if (eq entitlements.os "windows")}}\\{{else}}/{{/if}}redis:/data + {{#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..0c743c5 --- /dev/null +++ b/manifest.json @@ -0,0 +1,81 @@ +{ + "app-spec-version": "1.1", + "subject": { + "name": { + "en": "Docmost" + }, + "version": "0.20.4" + }, + "entitlements": [ + { + "type": "RandomAlphanumericString40Characters", + "name": "docmost-app-secret", + "description": { + "en": "Docmost app secret." + } + }, + { + "type": "RandomAlphanumericString30Characters", + "name": "postgresql-password", + "description": { + "en": "Password for the PostgreSQL database." + } + }, + { + "type": "ApplicationDataDirectoryPath", + "name": "folder-path", + "description": { + "en": "Folder used to store data." + } + }, + { + "type": "PortUnspecifiedStaticNumber", + "name": "port-number", + "description": { + "en": "Number of the port used by Docmost." + } + }, + { + "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": [ + { + "type": "CreateDirectory", + "in": "ApplicationDataDirectory", + "name": "docmost" + }, + { + "type": "CreateDirectory", + "in": "ApplicationDataDirectory", + "name": "postgresql" + }, + { + "type": "CreateDirectory", + "in": "ApplicationDataDirectory", + "name": "redis" + } + ] +}