mirror of
https://github.com/YunoHost-Apps/lemmy_ynh.git
synced 2024-09-03 19:36:09 +02:00
Auto-update README
This commit is contained in:
parent
daa63c8e20
commit
ebac8ae545
2 changed files with 75 additions and 45 deletions
68
README.md
68
README.md
|
@ -1,70 +1,52 @@
|
|||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
|
||||
# Lemmy app for YunoHost
|
||||
# lemmy for YunoHost
|
||||
|
||||
[![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)
|
||||
|
||||
[![Install Lemmy with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=lemmy)
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
|
||||
> *This package allows you to install Lemmy quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install lemmy 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
|
||||
Lemmy is similar to sites like Reddit, Lobste.rs, Raddle, or Hacker News: you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the Fediverse.
|
||||
|
||||
**Shipped version:** 0.9.9
|
||||
A link aggregator / Reddit clone for the fediverse.
|
||||
|
||||
**Shipped version:** 0.9.9~ynh1
|
||||
|
||||
**Demo:** https://join.lemmy.ml/join/
|
||||
|
||||
## Screenshots
|
||||
|
||||
![](https://raw.githubusercontent.com/LemmyNet/joinlemmy-site/main/static/images/main_img.webp)
|
||||
![](./doc/screenshots/screenshot1.webp)
|
||||
|
||||
## Demo
|
||||
## Disclaimers / important information
|
||||
|
||||
* [Official demo](https://join.lemmy.ml/join/)
|
||||
|
||||
## Configuration
|
||||
|
||||
Lemmy require full domain path to be instlled. Eg. lemmy.domain.tld
|
||||
|
||||
The admin username and password will be sent to the admin of the YunoHost through mail.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://join.lemmy.ml/docs/en/index.html
|
||||
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
Are LDAP and HTTP auth supported? No
|
||||
Can the app be used by multiple users? Yes
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/lemmy%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/lemmy/)
|
||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/lemmy%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/lemmy/)
|
||||
|
||||
## Links
|
||||
* 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
|
||||
|
||||
* 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
|
||||
* App website: https://join.lemmy.ml
|
||||
* Upstream app repository: https://github.com/LemmyNet/lemmy
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
## Developer info
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
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
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
48
README_fr.md
Normal file
48
README_fr.md
Normal file
|
@ -0,0 +1,48 @@
|
|||
# lemmy pour YunoHost
|
||||
|
||||
[![Niveau d'intégration](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)
|
||||
[![Installer lemmy avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=lemmy)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer lemmy rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
|
||||
|
||||
**Version incluse :** 0.9.9~ynh1
|
||||
|
||||
**Démo :** https://join.lemmy.ml/join/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
![](./doc/screenshots/screenshot1.webp)
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* 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.
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://join-lemmy.org/
|
||||
* Documentation officielle de l'admin : https://join-lemmy.org/docs/en/
|
||||
* Dépôt de code officiel de l'app : https://github.com/LemmyNet/lemmy
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_lemmy
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/lemmy_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/lemmy_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/lemmy_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade lemmy -u https://github.com/YunoHost-Apps/lemmy_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
Loading…
Reference in a new issue