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

52 lines
2.1 KiB
Markdown
Raw Normal View History

2021-07-07 16:42:12 +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.
-->
2021-02-21 06:08:46 +01:00
2021-07-07 16:42:12 +02:00
# lemmy for YunoHost
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
[![Integration level](https://dash.yunohost.org/integration/lemmy.svg)](https://dash.yunohost.org/appci/app/lemmy) ![](https://ci-apps.yunohost.org/ci/badges/lemmy.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/lemmy.maintain.svg)
[![Install lemmy with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=lemmy)
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
> *This package allows you to install lemmy quickly and simply on a YunoHost server.
2021-02-21 21:55:33 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2021-07-07 16:42:12 +02:00
A link aggregator / Reddit clone for the fediverse.
2021-02-21 21:55:33 +01:00
2021-08-22 14:24:34 +02:00
**Shipped version:** 0.11.3~ynh1
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
**Demo:** https://join.lemmy.ml/join/
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
## Screenshots
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
![](./doc/screenshots/screenshot1.webp)
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
## Disclaimers / important information
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* Lemmy require full domain path to be installed. Eg. lemmy.domain.tld
* The admin username and password will be sent to the admin of the YunoHost through mail.
## Documentation and resources
2021-02-21 21:55:33 +01:00
2021-07-07 16:42:12 +02:00
* Official app website: https://join-lemmy.org/
* Official admin documentation: https://join-lemmy.org/docs/en/
* Upstream app code repository: https://github.com/LemmyNet/lemmy
* YunoHost documentation for this app: https://yunohost.org/app_lemmy
* Report a bug: https://github.com/YunoHost-Apps/lemmy_ynh/issues
2021-02-21 21:55:33 +01:00
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/lemmy_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/lemmy_ynh/tree/testing --debug
or
sudo yunohost app upgrade lemmy -u https://github.com/YunoHost-Apps/lemmy_ynh/tree/testing --debug
```
2021-07-07 16:42:12 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps