diff --git a/ALL_README.md b/ALL_README.md deleted file mode 100644 index df3708b..0000000 --- a/ALL_README.md +++ /dev/null @@ -1,11 +0,0 @@ -# All available README files by language - -- [Read the README in English](README.md) -- [Lea el README en español](README_es.md) -- [Irakurri README euskaraz](README_eu.md) -- [Lire le README en français](README_fr.md) -- [Le o README en galego](README_gl.md) -- [Baca README dalam bahasa bahasa Indonesia](README_id.md) -- [Lees de README in het Nederlands](README_nl.md) -- [Прочитать README на русский](README_ru.md) -- [阅读中文(简体)的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index f2c3406..b207478 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,44 @@ -# Docmost for YunoHost +

+ Logo of Docmost + Docmost, packaged for YunoHost +

-[![Integration level](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Working status](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) +Collaborative wiki and documentation -[![Install Docmost with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) +[![🌐 Official app website](https://img.shields.io/badge/Official_app_website-darkgreen?style=for-the-badge)](https://docmost.com/) +[![Version: 0.80.2~ynh1](https://img.shields.io/badge/Version-0.80.2~ynh1-rgb(18,138,11)?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/docmost/) -*[Read this README in other languages.](./ALL_README.md)* +
+ + +
-> *This package allows you to install Docmost quickly and simply on a YunoHost server.* -> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.* - -## Overview - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Shipped version:** 0.3.1~ynh1 ## Screenshots - ![Screenshot of Docmost](./doc/screenshots/screenshot.png) -## Documentation and resources +## 📦 Developer info -- Official app website: -- Official admin documentation: -- Upstream app code repository: -- YunoHost Store: -- Report a bug: +[![Automatic tests level](https://apps.yunohost.org/badge/cilevel/docmost)](https://ci-apps.yunohost.org/ci/apps/docmost/) -## Developer info +🛠️ Upstream Docmost repository: -Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). +Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). -To try the `testing` branch, please proceed like that: +The `testing` branch can be tested using: +``` +# fresh install: +sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -or -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug +# upgrade an existing install: +sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing ``` -**More info regarding app packaging:** +### 📚 App packaging documentation + +Please see for more information. \ No newline at end of file diff --git a/README_es.md b/README_es.md deleted file mode 100644 index 4b741e6..0000000 --- a/README_es.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Docmost para Yunohost - -[![Nivel de integración](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![Instalar Docmost con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[Leer este README en otros idiomas.](./ALL_README.md)* - -> *Este paquete le permite instalarDocmost rapidamente y simplement en un servidor YunoHost.* -> *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.* - -## Descripción general - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Versión actual:** 0.3.1~ynh1 - -## Capturas - -![Captura de Docmost](./doc/screenshots/screenshot.png) - -## Documentaciones y recursos - -- Sitio web oficial: -- Documentación administrador oficial: -- Repositorio del código fuente oficial de la aplicación : -- Catálogo YunoHost: -- Reportar un error: - -## Información para desarrolladores - -Por favor enviar sus correcciones a la [rama `testing`](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). - -Para probar la rama `testing`, sigue asÍ: - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -o -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**Mas informaciones sobre el empaquetado de aplicaciones:** diff --git a/README_eu.md b/README_eu.md deleted file mode 100644 index 22ecbc8..0000000 --- a/README_eu.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Docmost YunoHost-erako - -[![Integrazio maila](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![Instalatu Docmost YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* - -> *Pakete honek Docmost YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* -> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* - -## Aurreikuspena - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Paketatutako bertsioa:** 0.3.1~ynh1 - -## Pantaila-argazkiak - -![Docmost(r)en pantaila-argazkia](./doc/screenshots/screenshot.png) - -## Dokumentazioa eta baliabideak - -- Aplikazioaren webgune ofiziala: -- Administratzaileen dokumentazio ofiziala: -- Jatorrizko aplikazioaren kode-gordailua: -- YunoHost Denda: -- Eman errore baten berri: - -## Garatzaileentzako informazioa - -Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). - -`testing` abarra probatzeko, ondorengoa egin: - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -edo -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md deleted file mode 100644 index bfd660d..0000000 --- a/README_fr.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Docmost pour YunoHost - -[![Niveau d’intégration](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![Installer Docmost avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[Lire le README dans d'autres langues.](./ALL_README.md)* - -> *Ce package vous permet d’installer Docmost rapidement et simplement sur un serveur YunoHost.* -> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* - -## Vue d’ensemble - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Version incluse :** 0.3.1~ynh1 - -## Captures d’écran - -![Capture d’écran de Docmost](./doc/screenshots/screenshot.png) - -## Documentations et ressources - -- Site officiel de l’app : -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : - -## Informations pour les développeurs - -Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). - -Pour essayer la branche `testing`, procédez comme suit : - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -ou -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md deleted file mode 100644 index 658f51b..0000000 --- a/README_gl.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Docmost para YunoHost - -[![Nivel de integración](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![Instalar Docmost con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[Le este README en outros idiomas.](./ALL_README.md)* - -> *Este paquete permíteche instalar Docmost de xeito rápido e doado nun servidor YunoHost.* -> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* - -## Vista xeral - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Versión proporcionada:** 0.3.1~ynh1 - -## Capturas de pantalla - -![Captura de pantalla de Docmost](./doc/screenshots/screenshot.png) - -## Documentación e recursos - -- Web oficial da app: -- Documentación oficial para admin: -- Repositorio de orixe do código: -- Tenda YunoHost: -- Informar dun problema: - -## Info de desenvolvemento - -Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). - -Para probar a rama `testing`, procede deste xeito: - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -ou -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**Máis info sobre o empaquetado da app:** diff --git a/README_id.md b/README_id.md deleted file mode 100644 index 2049e86..0000000 --- a/README_id.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Docmost untuk YunoHost - -[![Tingkat integrasi](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Status kerja](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Status pemeliharaan](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![Pasang Docmost dengan YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[Baca README ini dengan bahasa yang lain.](./ALL_README.md)* - -> *Paket ini memperbolehkan Anda untuk memasang Docmost secara cepat dan mudah pada server YunoHost.* -> *Bila Anda tidak mempunyai YunoHost, silakan berkonsultasi dengan [panduan](https://yunohost.org/install) untuk mempelajari bagaimana untuk memasangnya.* - -## Ringkasan - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Versi terkirim:** 0.3.1~ynh1 - -## Tangkapan Layar - -![Tangkapan Layar pada Docmost](./doc/screenshots/screenshot.png) - -## Dokumentasi dan sumber daya - -- Website aplikasi resmi: -- Dokumentasi admin resmi: -- Depot kode aplikasi hulu: -- Gudang YunoHost: -- Laporkan bug: - -## Info developer - -Silakan kirim pull request ke [`testing` branch](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). - -Untuk mencoba branch `testing`, silakan dilanjutkan seperti: - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -atau -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**Info lebih lanjut mengenai pemaketan aplikasi:** diff --git a/README_nl.md b/README_nl.md deleted file mode 100644 index 5410de7..0000000 --- a/README_nl.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Docmost voor Yunohost - -[![Integratieniveau](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Mate van functioneren](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Onderhoudsstatus](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![Docmost met Yunohost installeren](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[Deze README in een andere taal lezen.](./ALL_README.md)* - -> *Met dit pakket kun je Docmost snel en eenvoudig op een YunoHost-server installeren.* -> *Als je nog geen YunoHost hebt, lees dan [de installatiehandleiding](https://yunohost.org/install), om te zien hoe je 'm installeert.* - -## Overzicht - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Geleverde versie:** 0.3.1~ynh1 - -## Schermafdrukken - -![Schermafdrukken van Docmost](./doc/screenshots/screenshot.png) - -## Documentatie en bronnen - -- Officiele website van de app: -- Officiele beheerdersdocumentatie: -- Upstream app codedepot: -- YunoHost-store: -- Meld een bug: - -## Ontwikkelaarsinformatie - -Stuur je pull request alsjeblieft naar de [`testing`-branch](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). - -Om de `testing`-branch uit te proberen, ga als volgt te werk: - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -of -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**Verdere informatie over app-packaging:** diff --git a/README_ru.md b/README_ru.md deleted file mode 100644 index 645247d..0000000 --- a/README_ru.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Docmost для YunoHost - -[![Уровень интеграции](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![Состояние работы](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![Состояние сопровождения](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![Установите Docmost с YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[Прочтите этот README на других языках.](./ALL_README.md)* - -> *Этот пакет позволяет Вам установить Docmost быстро и просто на YunoHost-сервер.* -> *Если у Вас нет YunoHost, пожалуйста, посмотрите [инструкцию](https://yunohost.org/install), чтобы узнать, как установить его.* - -## Обзор - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**Поставляемая версия:** 0.3.1~ynh1 - -## Снимки экрана - -![Снимок экрана Docmost](./doc/screenshots/screenshot.png) - -## Документация и ресурсы - -- Официальный веб-сайт приложения: -- Официальная документация администратора: -- Репозиторий кода главной ветки приложения: -- Магазин YunoHost: -- Сообщите об ошибке: - -## Информация для разработчиков - -Пришлите Ваш запрос на слияние в [ветку `testing`](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing). - -Чтобы попробовать ветку `testing`, пожалуйста, сделайте что-то вроде этого: - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -или -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**Больше информации о пакетировании приложений:** diff --git a/README_zh_Hans.md b/README_zh_Hans.md deleted file mode 100644 index 28e6131..0000000 --- a/README_zh_Hans.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# YunoHost 上的 Docmost - -[![集成程度](https://dash.yunohost.org/integration/docmost.svg)](https://ci-apps.yunohost.org/ci/apps/docmost/) ![工作状态](https://ci-apps.yunohost.org/ci/badges/docmost.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/docmost.maintain.svg) - -[![使用 YunoHost 安装 Docmost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=docmost) - -*[阅读此 README 的其它语言版本。](./ALL_README.md)* - -> *通过此软件包,您可以在 YunoHost 服务器上快速、简单地安装 Docmost。* -> *如果您还没有 YunoHost,请参阅[指南](https://yunohost.org/install)了解如何安装它。* - -## 概况 - -### Features - -- Real-time collaboration -- Diagrams (Draw.io, Excalidraw and Mermaid) -- Spaces -- Permissions management -- Groups -- Comments -- Page history -- Search -- File attachment - - -**分发版本:** 0.3.1~ynh1 - -## 截图 - -![Docmost 的截图](./doc/screenshots/screenshot.png) - -## 文档与资源 - -- 官方应用网站: -- 官方管理文档: -- 上游应用代码库: -- YunoHost 商店: -- 报告 bug: - -## 开发者信息 - -请向 [`testing` 分支](https://github.com/YunoHost-Apps/docmost_ynh/tree/testing) 发送拉取请求。 - -如要尝试 `testing` 分支,请这样操作: - -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -或 -sudo yunohost app upgrade docmost -u https://github.com/YunoHost-Apps/docmost_ynh/tree/testing --debug -``` - -**有关应用打包的更多信息:** diff --git a/conf/.env b/conf/.env index 1c74c5f..8a21f19 100644 --- a/conf/.env +++ b/conf/.env @@ -1,14 +1,22 @@ # your domain, e.g https://example.com -APP_URL: "http://__DOMAIN__" +APP_URL=https://__DOMAIN____PATH__ PORT=__PORT__ -# make sure to replace this. -APP_SECRET= "__KEY__" +# minimum of 32 characters. Generate one with: openssl rand -hex 32 +APP_SECRET=__AUTH_SECRET__ JWT_TOKEN_EXPIRES_IN=30d -DATABASE_URL: "postgresql://__DB_USER__:__DB_PWD__@db:5432/__DB_NAME__?schema=public" +DATABASE_URL=postgres://__DB_USER__:__DB_PWD__@localhost/__DB_NAME__ +DATABASE_PASSWORD=__DB_PWD__ +DATABASE_USER=__DB_USER__ +DATABASE_NAME=__DB_NAME__ +DATABASE_HOST=localhost + REDIS_URL=redis://127.0.0.1:6379 +REDIS_PASSWORD= +REDIS_HOST=localhost +REDIS_PORT=6379 # options: local | s3 STORAGE_DRIVER=local @@ -19,19 +27,39 @@ AWS_S3_SECRET_ACCESS_KEY= AWS_S3_REGION= AWS_S3_BUCKET= AWS_S3_ENDPOINT= -AWS_S3_FORCE_PATH_STYLE= +AWS_S3_FORCE_PATH_STYLE=true + +# default: 50mb +FILE_UPLOAD_SIZE_LIMIT=__MAX_UPLOAD_SIZE__mb +FILE_IMPORT_SIZE_LIMIT=__MAX_UPLOAD_SIZE__mb # options: smtp | postmark MAIL_DRIVER=smtp -MAIL_FROM_ADDRESS=hello@example.com -MAIL_FROM_NAME=Docmost +MAIL_FROM_ADDRESS=docmost@__DOMAIN__ +MAIL_FROM_NAME=no-reply # SMTP driver config -SMTP_HOST=127.0.0.1 -SMTP_PORT=587 -SMTP_USERNAME= -SMTP_PASSWORD= +SMTP_HOST=__EMAIL_SMTP_HOST__ +SMTP_PORT=__EMAIL_SMTP_PORT__ +SMTP_USERNAME=__EMAIL_SMTP_USER__ +SMTP_PASSWORD="__EMAIL_SMTP_PASSWORD__" SMTP_SECURE=false +SMTP_IGNORETLS=false +APP_BASE_URL=https://__DOMAIN____PATH__ # Postmark driver config POSTMARK_TOKEN= + +# for custom drawio server +DRAWIO_URL= + +DISABLE_TELEMETRY=false + +# Enable debug logging in production (default: false) +DEBUG_MODE=false + +# Log database queries +DEBUG_DB=false + +# Log http requests +LOG_HTTP=false \ No newline at end of file diff --git a/conf/nginx.conf b/conf/nginx.conf index 10aee75..222b8b3 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,17 +1,13 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; -location __PATH__/ { - - proxy_pass http://127.0.0.1:__PORT__/; - proxy_set_header Host $host; - proxy_pass_header Server; - - proxy_buffering off; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $remote_addr; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $host; - proxy_http_version 1.1; - # setup for image upload - client_max_body_size 256M; +location /api/ { + proxy_pass http://127.0.0.1:__PORT__; + include proxy_params_no_auth; + client_max_body_size __MAX_UPLOAD_SIZE__M; } + +location __PATH__/ { + proxy_pass http://127.0.0.1:__PORT__; + include proxy_params_no_auth; + client_max_body_size __MAX_UPLOAD_SIZE__M; +} \ No newline at end of file diff --git a/conf/settings.example.json b/conf/settings.example.json deleted file mode 100644 index 5afd239..0000000 --- a/conf/settings.example.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "protocol": "http", - "host": "127.0.0.1", - "desired_port": "__PORT__", - "contentPath": "__DATA_DIR__", - - "api": { - "enabled": false, - "allow_all_domains": false, - "domains_whitelist": ["127.0.0.1"] - } -} diff --git a/conf/systemd.service b/conf/systemd.service index cd2179c..be3b2b1 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,5 +1,5 @@ [Unit] -Description=do•doc: documentation tool for creativity +Description=Docmost After=network.target [Service] @@ -7,10 +7,47 @@ Type=simple User=__APP__ Group=__APP__ Environment="PATH=__PATH_WITH_NODEJS__" -Environment="NODE_ENV=production" WorkingDirectory=__INSTALL_DIR__/ -ExecStart=__NODEJS_DIR__/node start +EnvironmentFile=__INSTALL_DIR__/.env +ExecStart=__NODEJS_DIR__/pnpm start +StandardOutput=append:/var/log/__APP__/__APP__.log +StandardError=inherit Restart=on-failure +RestartSec=5 +StartLimitInterval=600s +StartLimitBurst=10 + +# Sandboxing options to harden security +# Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html +NoNewPrivileges=yes +PrivateTmp=yes +PrivateDevices=yes +RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK +RestrictNamespaces=yes +RestrictRealtime=yes +DevicePolicy=closed +ProtectClock=yes +ProtectHostname=yes +ProtectProc=invisible +ProtectSystem=full +ProtectControlGroups=yes +ProtectKernelModules=yes +ProtectKernelTunables=yes +LockPersonality=yes +SystemCallArchitectures=native +SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @raw-io @reboot @swap _sysctl acct bpf capset fanotify_init fanotify_mark nfsservctl open_by_handle_at pivot_root quotactl quotactl_fd setdomainname setfsuid setfsuid32 sethostname vhangup chown chown32 fchown32 fchownat lchown lchown32 + +# Denying access to capabilities that should not be relevant for webapps +# Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html +CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD +CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE +CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT +CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK +CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM +CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG +CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE +CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW +CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG [Install] WantedBy=multi-user.target \ No newline at end of file diff --git a/config_panel.toml b/config_panel.toml new file mode 100644 index 0000000..19ab169 --- /dev/null +++ b/config_panel.toml @@ -0,0 +1,105 @@ +version = "1.0" + +[main] +name.en = "Configuration panel" +name.fr = "Panneau de configuration" +services = ["__APP__", "nginx"] + +[main.uploads] +name.en = "Upload limit size" +name.fr = "Téléchargement de fichiers" + + [main.uploads.max_upload_size] + ask.fr = "Taille limite pour le téléchargement des fichiers en Mo" + ask.en = "Size limit file upload (Mb)" + type = "number" + bind = "null" + +[main.smtp] +name.en = "SMTP configuration" +name.fr = "Paramètres SMTP" + + [main.smtp.smtp_user] + ask.en = "The SMTP user id" + ask.fr = "Id d'utilisateur SMTP" + type = "string" + bind = "SMTP_USERNAME:__INSTALL_DIR__/.env" + + [main.smtp.smtp_password] + ask.en = "user password or application token" + ask.fr = "Mot de passe ou jeton d’application SMTP." + type = "password" + bind = "SMTP_PASSWORD:__INSTALL_DIR__/.env" + + [main.smtp.smtp_host] + ask.en = "SMTP host" + ask.fr = "Nom d’hôte du serveur SMTP" + type = "string" + bind = "SMTP_HOST:__INSTALL_DIR__/.env" + + [main.smtp.smtp_port] + ask.en = "SMTP port" + ask.fr = "Port du serveur SMTP" + type = "select" + choices = ["25", "465", "587", "2525"] + optional = true + bind = "SMTP_PORT:__INSTALL_DIR__/.env" + + [main.smtp.smtp_secure] + ask.en = "SMTP secure" + ask.fr = "Sécurité SMTP" + type = "boolean" + optional = true + bind = "SMTP_SECURE:__INSTALL_DIR__/.env" + +[main.storage] +name.en = "Storage" +name.fr = "Stockage" + + [main.storage.doc_storage_driver] + ask.en = "Storage driver" + ask.fr = "Storage driver" + type = "select" + choices = ["local", "s3"] + bind = "STORAGE_DRIVER:__INSTALL_DIR__/.env" + +[main.storage_s3] +name.en = "S3 storage" +name.fr = "Stockage S3" + + [main.storage_s3.storage_driver] + ask.en = "Storage driver" + ask.fr = "stockage" + type = "select" + choices = ["local", "s3"] + bind = "STORAGE_DRIVER:__INSTALL_DIR__/.env" + + [main.storage_s3.aws_endpoint] + ask.en = "S3 endpoint" + ask.fr = "S3 endpoint" + type = "string" + bind = "AWS_S3_ENDPOINT:__INSTALL_DIR__/.env" + + [main.storage_s3.aws_region] + ask.en = "S3 region" + ask.fr = "S3 region" + type = "string" + bind = "AWS_S3_REGION:__INSTALL_DIR__/.env" + + [main.storage_s3.aws_bucket_name] + ask.en = "Bucket name" + ask.fr = "Nom du bucket" + type = "string" + bind = "AWS_S3_BUCKET:__INSTALL_DIR__/.env" + + [main.storage_s3.aws_key_id] + ask.en = "S3 key id" + ask.fr = "S3 key id" + type = "string" + bind = "AWS_S3_ACCESS_KEY_ID:__INSTALL_DIR__/.env" + + [main.storage_s3.aws_secret_key] + ask.en = "S3 secret key" + ask.fr = "S3 secret key" + type = "password" + bind = "AWS_S3_SECRET_ACCESS_KEY:__INSTALL_DIR__/.env" diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 4dba164..03c0202 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,3 +1,5 @@ +Docmost is an open-source, enterprise-ready collaborative wiki and documentation software. Designed for seamless real-time collaboration, multiple users can work on the same page at the same time in real-time without overwriting each other. + ### Features - Real-time collaboration diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 4dba164..c0808e9 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -1,3 +1,5 @@ +Docmost est un logiciel de wiki et de documentation collaboratif open source, adapté aux entreprises. Conçu pour permettre une collaboration fluide en temps réel, il permet à plusieurs utilisateurs de travailler simultanément sur la même page sans se marquer mutuellement. + ### Features - Real-time collaboration diff --git a/doc/screenshots/screenshot.png b/doc/screenshots/screenshot.png index 7055295..aba36a0 100644 Binary files a/doc/screenshots/screenshot.png and b/doc/screenshots/screenshot.png differ diff --git a/manifest.toml b/manifest.toml index 942a313..44a62a9 100644 --- a/manifest.toml +++ b/manifest.toml @@ -1,35 +1,33 @@ -#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json +#:schema https://raw.githubusercontent.com/YunoHost/apps/main/schemas/manifest.v2.schema.json packaging_format = 2 - id = "docmost" name = "Docmost" -description.en = "Create, collaborate, and share knowledge" -description.fr = "Créez, collaborez et partagez vos connaissances" +description.en = "Collaborative wiki and documentation" +description.fr = "Wiki collaboratif et documentation" -version = "0.3.1~ynh1" +version = "0.80.2~ynh1" -maintainers = ["eric_G"] +maintainers = ["otm33GH", "eric_G"] [upstream] -license = "AGPL-3.0-only" +license = "GPL-3.0-only" website = "https://docmost.com/" admindoc = "https://docmost.com/docs/" code = "https://github.com/docmost/docmost" [integration] -yunohost = ">= 11.2.30" +yunohost = ">= 12.1.39" helpers_version = "2.1" architectures = "all" multi_instance = true ldap = false - sso = false -disk = "512M" -ram.build = "1000M" -ram.runtime = "512M" +disk = "2000M" +ram.build = "1500M" +ram.runtime = "500M" [install] [install.domain] @@ -40,17 +38,15 @@ ram.runtime = "512M" default = "visitors" [resources] - [resources.sources] [resources.sources.main] - - url = "https://github.com/docmost/docmost/archive/refs/tags/v0.5.0.tar.gz" - sha256 = "3afd949252afc65a3759e7c0ac41f92a619da7b1be46aae4ca96ad0fa28f2033" - - #autoupdate.strategy = "latest_github_tag" + url = "https://github.com/docmost/docmost/archive/refs/tags/v0.80.2.tar.gz" + sha256 = "6dc76b49b42fe658bebca167d1a11202e84ee48bde8886a7edee7cdf23f54cbe" + autoupdate.strategy = "latest_github_tag" [resources.system_user] + allow_email = true [resources.install_dir] @@ -58,6 +54,7 @@ ram.runtime = "512M" [resources.permissions] main.url = "/" + main.auth_header = false [resources.ports] @@ -66,3 +63,6 @@ ram.runtime = "512M" [resources.database] type = "postgresql" + + [resources.nodejs] + version = "22" diff --git a/scripts/_common.sh b/scripts/_common.sh deleted file mode 100644 index e4f53e2..0000000 --- a/scripts/_common.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash - -#================================================= -# COMMON VARIABLES AND CUSTOM HELPERS -#================================================= - -nodejs_version="20" \ No newline at end of file diff --git a/scripts/backup b/scripts/backup index d19654a..1936b5d 100755 --- a/scripts/backup +++ b/scripts/backup @@ -1,6 +1,9 @@ #!/bin/bash -source ../settings/scripts/_common.sh +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + source /usr/share/yunohost/helpers ynh_print_info "Declaring files to be backed up..." @@ -18,22 +21,30 @@ ynh_backup "$install_dir" ynh_backup "$data_dir" #================================================= -# SYSTEM CONFIGURATION +# BACKUP THE POSTGRESQL DATABASE #================================================= +ynh_print_info "Backing up the PostgreSQL database..." + +ynh_psql_dump_db > db.sql +#================================================= +# BACKUP SYSTEM CONFIGURATION +#================================================= + +# Backup the NGINX configuration ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" +# Backup the systemd service unit ynh_backup "/etc/systemd/system/$app.service" -#================================================= -# BACKUP THE POSTGRESQL DATABASE -#================================================= -ynh_print_info "Backing up the PostgreSQL database..." +# Backup the logrotate configuration +ynh_backup "/etc/logrotate.d/$app" -ynh_psql_dump_db > db.sql +# Backup the logs +ynh_backup "/var/log/$app/$app.log" #================================================= # END OF SCRIPT #================================================= -ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." +ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." \ No newline at end of file diff --git a/scripts/change_url b/scripts/change_url index 6977c19..b50d9a6 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -1,6 +1,5 @@ #!/bin/bash -source _common.sh source /usr/share/yunohost/helpers #================================================= @@ -8,7 +7,7 @@ source /usr/share/yunohost/helpers #================================================= ynh_script_progression "Stopping $app's systemd service..." -ynh_systemctl --service="$app" --action="stop" --log_path="systemd" +ynh_systemctl --service="$app" --action="stop" #================================================= # MODIFY URL IN NGINX CONF @@ -22,7 +21,7 @@ ynh_config_change_url_nginx #================================================= ynh_script_progression "Starting $app's systemd service..." -ynh_systemctl --service="$app" --action="start" --log_path="systemd" +ynh_systemctl --service="$app" --action="start" #================================================= # END OF SCRIPT diff --git a/scripts/config b/scripts/config new file mode 100644 index 0000000..250efae --- /dev/null +++ b/scripts/config @@ -0,0 +1,31 @@ +#!/bin/bash + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source /usr/share/yunohost/helpers + +ynh_abort_if_errors + +#================================================= +# RETRIEVE ARGUMENTS +#================================================= + +BACKEND_ENV="${install_dir}/.env" + +get__max_upload_size() { +ynh_app_setting_get --key=max_upload_size +} + +set__max_upload_size() { + ynh_replace --match='client_max_body_size [^"]*' --replace="client_max_body_size ${max_upload_size}M ;" --file="/etc/nginx/conf.d/$domain.d/$app.conf" + ynh_replace --match='FILE_UPLOAD_SIZE_LIMIT=[^"]*' --replace="FILE_UPLOAD_SIZE_LIMIT=${max_upload_size}mb" --file="$BACKEND_ENV" + ynh_replace --match='FILE_IMPORT_SIZE_LIMIT=[^"]*' --replace="FILE_IMPORT_SIZE_LIMIT=${max_upload_size}mb" --file="$BACKEND_ENV" + ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" + ynh_app_setting_set --key=max_upload_size --value="$max_upload_size" + ynh_print_info "The nginx config has been edited" +} + +#================================================= +ynh_app_config_run "$1" \ No newline at end of file diff --git a/scripts/install b/scripts/install index fa32571..f1edb0e 100755 --- a/scripts/install +++ b/scripts/install @@ -1,16 +1,26 @@ #!/bin/bash -source _common.sh -source /usr/share/yunohost/helpers +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -key=$(ynh_string_random --length=32) +source /usr/share/yunohost/helpers #================================================= -# INSTALL DEPENDENCIES +# INITIALIZE AND STORE SETTINGS #================================================= -ynh_script_progression "Installing dependencies..." -ynh_nodejs_install +max_upload_size=50 +auth_secret=$(ynh_string_random --length=32) +ynh_app_setting_set --key=auth_secret --value="$auth_secret" + +ynh_app_setting_set --key=max_upload_size --value=$max_upload_size + +email_smtp_host=$(cat /etc/yunohost/current_host) +email_smtp_user="$app" +email_smtp_password="$mail_pwd" +email_smtp_port=587 +storage_driver=local #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -20,12 +30,26 @@ ynh_script_progression "Setting up source files..." ynh_setup_source --dest_dir="$install_dir" #================================================= -# APP INITIAL CONFIGURATION +# ADD A CONFIGURATION #================================================= -ynh_script_progression "Adding $app's configuration files..." +ynh_script_progression "Adding $app's configuration..." ynh_config_add --template=".env" --destination="$install_dir/.env" +#================================================= +# INSTALLATION +#================================================= +ynh_script_progression "Building $app..." + +pushd "$install_dir" + ynh_hide_warnings corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@10.4.0 --activate + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" pnpm install --frozen-lockfile + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" NX_DAEMON=false NX_DISABLE_NX_CACHE=true pnpm run editor-ext:build + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" NX_DAEMON=false NX_DISABLE_NX_CACHE=true pnpm run server:build + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" NX_DAEMON=false NX_DISABLE_NX_CACHE=true pnpm run client:build + pnpm store prune +popd + #================================================= # SYSTEM CONFIGURATION #================================================= @@ -33,27 +57,22 @@ ynh_script_progression "Adding system configurations related to $app..." ynh_config_add_nginx -ynh_config_add_systemd +ynh_config_add_systemd --service="$app" -yunohost service add "$app" --description="Create, collaborate, and share knowledge" --log="/var/log/$app/$app.log" +yunohost service add "$app" --description="Docmost" --log="/var/log/$app/$app.log" -#================================================= -# INSTALL DODOC -#================================================= -ynh_script_progression "Installing $app..." +ynh_config_add_logrotate -pushd $install_dir - ynh_hide_warnings corepack enable && corepack prepare pnpm@latest --activate - ynh_hide_warnings pnpm install --frozen-lockfile --prod - ynh_hide_warnings pnpm build -popd +ln -s "$data_dir" "$install_dir/data" #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression "Starting $app's systemd service..." -ynh_systemctl --service="$app" --action="start" --log_path="systemd" +ynh_systemctl --service="$app" --action="start" + +ynh_systemctl --service=postfix --action="restart" #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index eec7780..d368a21 100755 --- a/scripts/remove +++ b/scripts/remove @@ -1,13 +1,19 @@ #!/bin/bash -source _common.sh +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + source /usr/share/yunohost/helpers #================================================= -# REMOVE SYSTEM CONFIGURATIONS +# REMOVE SYSTEM CONFIGURATION #================================================= ynh_script_progression "Removing system configurations related to $app..." +ynh_config_remove_logrotate + +# Remove the service from the list of services known by YunoHost (added from `yunohost service add`) if ynh_hide_warnings yunohost service status "$app" >/dev/null; then yunohost service remove "$app" fi @@ -16,10 +22,8 @@ ynh_config_remove_systemd ynh_config_remove_nginx -ynh_nodejs_remove - #================================================= # END OF SCRIPT #================================================= -ynh_script_progression "Removal of $app completed" +ynh_script_progression "Removal of $app completed" \ No newline at end of file diff --git a/scripts/restore b/scripts/restore index c5d92e7..b73a5e0 100755 --- a/scripts/restore +++ b/scripts/restore @@ -1,6 +1,9 @@ #!/bin/bash -source ../settings/scripts/_common.sh +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + source /usr/share/yunohost/helpers #================================================= @@ -10,10 +13,12 @@ ynh_script_progression "Restoring the app main directory..." ynh_restore "$install_dir" +ynh_hide_warnings corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@latest --activate + #================================================= # RESTORE THE DATA DIRECTORY #================================================= -ynh_script_progression "Restoring the data directory..." +ynh_script_progression "Restoring data directory..." ynh_restore "$data_dir" @@ -25,14 +30,7 @@ ynh_script_progression "Restoring the PostgreSQL database..." ynh_psql_db_shell < ./db.sql #================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression "Reinstalling dependencies..." - -ynh_nodejs_install - -#================================================= -# RESTORE SYSTEM CONFIGURATIONS +# RESTORE SYSTEM CONFIGURATION #================================================= ynh_script_progression "Restoring system configurations related to $app..." @@ -41,14 +39,17 @@ ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore "/etc/systemd/system/$app.service" systemctl enable "$app.service" --quiet -yunohost service add "$app" --description="Create, collaborate, and share knowledge" --log="/var/log/$app/$app.log" +yunohost service add "$app" --description=Docmost --log="/var/log/$app/$app.log" + +ynh_restore "/etc/logrotate.d/$app" +ynh_restore "/var/log/$app/$app.log" #================================================= -# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE +# RELOAD NGINX AND THE APP SERVICE #================================================= ynh_script_progression "Reloading NGINX web server and $app's service..." -ynh_systemctl --service="$app" --action="start" --log_path="systemd" +ynh_systemctl --service="$app" --action="start" ynh_systemctl --service=nginx --action=reload diff --git a/scripts/upgrade b/scripts/upgrade index 42c9498..1ddfb0e 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,21 +1,17 @@ #!/bin/bash -source _common.sh -source /usr/share/yunohost/helpers - #================================================= -# STOP SYSTEMD SERVICE +# IMPORT GENERIC HELPERS #================================================= -ynh_script_progression "Stopping $app's systemd service..." -ynh_systemctl --service="$app" --action="stop" --log_path="systemd" +source /usr/share/yunohost/helpers #================================================= -# INSTALL DEPENDENCIES +# STOP SYSTEMD SERVICE #================================================= -ynh_script_progression "Installing dependencies..." +ynh_script_progression "Stopping $app's systemd service..." -ynh_nodejs_install +ynh_systemctl --service="$app" --action="stop" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -25,26 +21,23 @@ ynh_script_progression "Upgrading source files..." ynh_setup_source --dest_dir="$install_dir" --full_replace --keep=".env" #================================================= -# UPDATE A CONFIG FILE -#================================================= -ynh_script_progression "Updating $app's configuration files..." - -ynh_config_add --template=".env" --destination="$install_dir/.env" - -#================================================= -# INSTALL DODOC +# INSTALLATION #================================================= -ynh_script_progression "Installing $app..." +ynh_script_progression "Building $app..." -pushd $install_dir - ynh_hide_warnings corepack enable && corepack prepare pnpm@latest --activate - ynh_hide_warnings pnpm nx run @docmost/editor-ext:build - ynh_hide_warnings pnpm install --frozen-lockfile --prod - ynh_hide_warnings pnpm build +pushd "$install_dir" + ynh_hide_warnings corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@10.4.0 --activate + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" pnpm install --frozen-lockfile + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" NX_DAEMON=false NX_DISABLE_NX_CACHE=true pnpm run editor-ext:build + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" NX_DAEMON=false NX_DISABLE_NX_CACHE=true pnpm run server:build + ynh_exec_as_app NODE_OPTIONS="--max-old-space-size=4096" NX_DAEMON=false NX_DISABLE_NX_CACHE=true pnpm run client:build + pnpm store prune popd +ln -s "$data_dir" "$install_dir/data" + #================================================= -# REAPPLY SYSTEM CONFIGURATIONS +# REAPPLY SYSTEM CONFIGURATION #================================================= ynh_script_progression "Upgrading system configurations related to $app..." @@ -52,14 +45,14 @@ ynh_config_add_nginx ynh_config_add_systemd -yunohost service add "$app" --description="Create, collaborate, and share knowledge" --log="/var/log/$app/$app.log" +yunohost service add "$app" --description="Docmost" --log="/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression "Starting $app's systemd service..." -ynh_systemctl --service="$app" --action="start" --log_path="systemd" +ynh_systemctl --service="$app" --action="start" #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml index 76f5804..bf86636 100644 --- a/tests.toml +++ b/tests.toml @@ -11,68 +11,12 @@ test_format = 1.0 # ------------------------------------------------------------------------------- # EVERYTHING PAST THIS POINT IS OPTIONAL AND MOST LIKELY UNNECESSARY FOR NEW APPS #-------------------------------------------------------------------------------- - ## Conventions in this sample: - ## <- An actual comment - # <- uncommenting this should be a valid entry in 'tests.toml' - - ## NB: the tests to run are automatically deduced by the CI script according to the - ## content of the app's manifest. The declarations below allow to customize which - ## tests are ran, possibly add special test suite to test special args, or - ## declare which commits to test upgrade from. - ## - ## You can also decide (though this is discouraged!) to ban/ignore some tests, - ## The test IDs to be used in only/exclude statements are: - ## * install.root - ## * install.subdir - ## * install.nourl - ## * install.multi - ## * backup_restore - ## * upgrade - ## * upgrade.someCommitId - ## * change_url - ## NB: you should NOT need this except if you really have a good reason... - - # exclude = ["install.private", "install.multi"] - - ## For special usecases, sometimes you need to setup other things on the machine - ## prior to installing the app (such as installing another app) - ## (Remove this key entirely if not needed) - - # preinstall = """ - # sudo yunohost app install foobar - # sudo yunohost user list - # """ # ------------------------------- # Default args to use for install # ------------------------------- - ## By default, the CI will automagically fill the 'standard' args - ## such as domain, path, admin, is_public and password with relevant values - ## and also install args with a "default" provided in the manifest.. - ## It should only make sense to declare custom args here for args with no default values - ## NB: you should NOT need those lines unless for custom questions with no obvious/default value - - # args.language = "fr_FR" - # args.multisite = 0 - # ------------------------------- # Commits to test upgrade from # ------------------------------- - - ## 00a1a6e7 is part of commit SHA, preferrably from 'master' branch - ## that points to valid install of previous version - - # test_upgrade_from.00a1a6e7.name = "Upgrade from 5.4" - # test_upgrade_from.00a1a6e7.args.foo = "bar" - - -## This is an additional test suite -# [some_additional_testsuite] - - ## On additional tests suites, you can decide to run only specific tests - - # only = ["install.subdir"] - - # args.language = "en_GB" - # args.multisite = 1 + \ No newline at end of file