1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/listmonk_ynh.git synced 2024-09-03 19:36:15 +02:00
listmonk_ynh/README.md

51 lines
2 KiB
Markdown
Raw Normal View History

2022-03-28 11:33:36 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2022-03-28 11:33:44 +02:00
# Listmonk for YunoHost
2022-03-28 11:33:36 +02:00
2023-02-15 14:26:51 +01:00
[![Integration level](https://dash.yunohost.org/integration/listmonk.svg)](https://dash.yunohost.org/appci/app/listmonk) ![Working status](https://ci-apps.yunohost.org/ci/badges/listmonk.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/listmonk.maintain.svg)
2022-03-28 11:33:44 +02:00
[![Install Listmonk with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=listmonk)
2022-03-28 11:33:36 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-03-28 11:33:44 +02:00
> *This package allows you to install Listmonk quickly and simply on a YunoHost server.
2022-03-28 11:33:36 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-03-28 11:41:51 +02:00
Listmonk is a standalone, self-hosted, newsletter and mailing list manager. It is fast, feature-rich, and packed into a single binary. It uses a PostgreSQL (⩾ v9.4) database as its data store.
2022-03-28 11:33:36 +02:00
2023-01-20 03:00:27 +01:00
**Shipped version:** 2.3.0~ynh3
2022-08-07 23:40:00 +02:00
2022-03-28 11:33:44 +02:00
**Demo:** https://demo.listmonk.app/
2022-03-28 11:33:36 +02:00
2022-03-28 11:33:44 +02:00
## Screenshots
2022-03-28 11:33:36 +02:00
2022-07-09 18:39:03 +02:00
![Screenshot of Listmonk](./doc/screenshots/screenshot.png)
2022-03-28 11:33:36 +02:00
## Documentation and resources
2022-07-09 18:39:03 +02:00
* Official app website: <https://listmonk.app/>
* Official admin documentation: <https://listmonk.app/docs/>
* Upstream app code repository: <https://github.com/knadh/listmonk>
* YunoHost documentation for this app: <https://yunohost.org/app_listmonk>
* Report a bug: <https://github.com/YunoHost-Apps/listmonk_ynh/issues>
2022-03-28 11:33:36 +02:00
## Developer info
2022-03-28 11:33:44 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/listmonk_ynh/tree/testing).
2022-03-28 11:33:36 +02:00
To try the testing branch, please proceed like that.
2022-07-09 18:39:03 +02:00
``` bash
2022-03-28 11:33:44 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/listmonk_ynh/tree/testing --debug
2022-03-28 11:33:36 +02:00
or
2022-03-28 11:33:44 +02:00
sudo yunohost app upgrade listmonk -u https://github.com/YunoHost-Apps/listmonk_ynh/tree/testing --debug
2022-03-28 11:33:36 +02:00
```
2022-07-09 18:39:03 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>