mirror of
https://github.com/YunoHost-Apps/streams_ynh.git
synced 2024-09-03 20:26:20 +02:00
Added README
This commit is contained in:
parent
7a3d64df8e
commit
a339e10851
3 changed files with 138 additions and 0 deletions
69
README.md
Normal file
69
README.md
Normal file
|
@ -0,0 +1,69 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Streams for YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/streams)  
|
||||||
|
|
||||||
|
[](https://install-app.yunohost.org/?app=streams)
|
||||||
|
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
> *This package allows you to install Streams 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
|
||||||
|
|
||||||
|
[Streams](https://codeberg.org/streams/streams/) is an open source fediverse server with a long history of innovation. See [FEATURES](https://codeberg.org/streams/streams/src/branch/dev/FEATURES.md).
|
||||||
|
|
||||||
|
This software is dedicated to the public domain to the extent permissable by law and is not associated with any consumer brand or product.
|
||||||
|
|
||||||
|
Compatible with **Mastodon**, **Pleroma**, **Pixelfed**, **Friendica**, **Hubzilla**, **Funkwhale**, **Peertube**, **Plume**, **WriteFreely** and many, many more.
|
||||||
|
|
||||||
|
## Unique Features of Streams
|
||||||
|
|
||||||
|
- **Federated Single Sign-on** : Makes private/protected resources on external sites as accessible as on local sites.
|
||||||
|
- **Federated Access Control** : Works with Federated Single Sign-on to provide private/protected media and web resources to anybody, including those visiting from different sites.
|
||||||
|
- **Groups** : Public, private, and moderated. These work across nearly all fediverse platforms.
|
||||||
|
- **Events** : Calendar and attendance; automatic timezone adjusted birthday notifications for friends using this feature.
|
||||||
|
- **Permissions** : Because not everybody wishes to converse with and share intimate facets of their life with random strangers.
|
||||||
|
- **Cloud storage** : Built-in network file storage integrated with federated access control and social networking access/permissions. Available over WebDAV.
|
||||||
|
- **Editor** : Supports markdown, html, and bbcode. Use any or all of these in any post to create a media rich experience. Post editing and preview are supported. It is somewhat unlikely that in normal use you will exceed the federated post length limits (roughly 100 printed pages of text). There are no arbitrary limits placed on the number of attached photos, files, or poll responses.
|
||||||
|
- **Share** : Drag-and-drop a number of different things such as files, photos, videos, webpages, maps, fediverse articles, and phone numbers to share them.
|
||||||
|
- **Lists** : Sometimes referred to as circles or aspects, this lets you define your own groups of related friends and communicate with them as a private group.
|
||||||
|
- **Extend** : Change or upgrade your software functionality as desired by installing additional features from addons and the free app collection.
|
||||||
|
- **Guest Pass** : Provide special guest access to private resources and media - on your terms.
|
||||||
|
- **Friend Zoom** : Set your degree of closeness to any connection and then interactively zoom in to filter your stream to close friends; or zoom out to see posts by casual acquaintances.
|
||||||
|
- **Location Services** : Check-in, check-out, and search by distance
|
||||||
|
- **Delivery Reports** : In a decentralised multi-platform world, stuff happens. Sites and networks sometimes go down. Project developers sometimes introduce bugs and incompatibilities. This allows you to determine what happened to your post or comment and where it actually went once you published it.
|
||||||
|
- **Failsafe** : Because the best time to have a current backup of your data is 10 seconds ago. Clone your online identity and content to multiple sites using the Nomad protocol and mirror any changes in near realtime. Then, if your chosen site goes down (either temporarily or permanently) or you get booted off of it for some reason, your online life doesn't have to come to an end or force you to start over. All your friends and all your content are available on any of your cloned instances - at any time.
|
||||||
|
- **ActivityPub** : Provides the ActivityPub "Client to Server" API for use with external apps.
|
||||||
|
|
||||||
|
|
||||||
|
**Shipped version:** 23.08.02~ynh5
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Documentation and resources
|
||||||
|
|
||||||
|
* Upstream app code repository: <https://codeberg.org/streams/streams>
|
||||||
|
* YunoHost documentation for this app: <https://yunohost.org/app_streams>
|
||||||
|
* Report a bug: <https://github.com/YunoHost-Apps/streams_ynh/issues>
|
||||||
|
|
||||||
|
## Developer info
|
||||||
|
|
||||||
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/streams_ynh/tree/testing).
|
||||||
|
|
||||||
|
To try the testing branch, please proceed like that.
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/streams_ynh/tree/testing --debug
|
||||||
|
or
|
||||||
|
sudo yunohost app upgrade streams -u https://github.com/YunoHost-Apps/streams_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
69
README_fr.md
Normal file
69
README_fr.md
Normal file
|
@ -0,0 +1,69 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Streams pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/streams)  
|
||||||
|
|
||||||
|
[](https://install-app.yunohost.org/?app=streams)
|
||||||
|
|
||||||
|
*[Read this readme in english.](./README.md)*
|
||||||
|
|
||||||
|
> *Ce package vous permet d’installer Streams 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
|
||||||
|
|
||||||
|
[Streams](https://codeberg.org/streams/streams/) est un serveur fediverse open source qui a une longue histoire d'innovation. Voir [FEATURES](https://codeberg.org/streams/streams/src/branch/dev/FEATURES.md).
|
||||||
|
|
||||||
|
Ce logiciel appartient au domaine public dans les limites autorisées par la loi et n'est pas associé à une marque ou à un produit.
|
||||||
|
|
||||||
|
Compatible avec **Mastodon**, **Pleroma**, **Pixelfed**, **Friendica**, **Hubzilla**, **Funkwhale**, **Peertube**, **Plume**, **WriteFreely** et bien d'autres encore.
|
||||||
|
|
||||||
|
## Caractéristiques uniques de Streams
|
||||||
|
|
||||||
|
- **Signature unique fédérée** : Rend les ressources privées/protégées sur des sites externes aussi accessibles que sur des sites locaux.
|
||||||
|
- **Contrôle d'accès fédéré** : Permet l'authentification unique fédérée pour fournir des ressources multimédias et web privées/protégées à n'importe qui, y compris à ceux qui visitent le site depuis d'autres sites.
|
||||||
|
- **Groupes** : Publics, privés et modérés. Ils fonctionnent sur presque toutes les plateformes fediverse.
|
||||||
|
- **Événements** : Calendrier et présence ; notifications automatiques d'anniversaire ajustées au fuseau horaire pour les amis utilisant cette fonctionnalité.
|
||||||
|
- **Permissions** : Parce que tout le monde ne souhaite pas converser et partager des aspects intimes de sa vie avec des inconnus.
|
||||||
|
- **Stockage en ligne** : Stockage en ligne de fichiers intégré au logiciel, avec contrôle d'accès fédéré et accès/permissions aux réseaux sociaux. Accessible via le protocole WebDAV.
|
||||||
|
- **Éditeur** : Supporte le markdown, le html et le bbcode. Utilisez l'un ou l'autre de ces éléments dans un message y intégrer des médias. L'édition et la prévisualisation des messages sont disponibles. Il est peu probable que, dans le cadre d'une utilisation normale, vous dépassiez les limites de longueur des messages fédérés (environ 100 pages imprimées de texte). Il n'y a pas de limites arbitraires imposées au nombre de photos, de fichiers ou de réponses à des sondages joints à vos publications.
|
||||||
|
- **Partager** : Glissez-déposez un certain nombre de choses différentes telles que des fichiers, des photos, des vidéos, des pages web, des cartes, des articles de fediverse et des numéros de téléphone pour les partager.
|
||||||
|
- **Listes** : Parfois appelées cercles ou aspects, elles vous permettent de définir vos propres groupes d'amis et de communiquer avec eux en tant que groupe privé.
|
||||||
|
- **Extension** : Modifiez ou mettez à niveau les fonctionnalités de votre logiciel en installant des fonctions supplémentaires à partir de modules complémentaires et de la collection d'applications gratuites.
|
||||||
|
- **Guest Pass** : Fournissez à des invités un accès unique à des ressources et à des médias privés - vous fixez les conditions.
|
||||||
|
- **Zoom sur les amis** : Définissez votre degré de proximité avec n'importe quelle connexion, puis effectuez un zoom avant interactif pour filtrer votre flux vers vos amis proches, ou un zoom arrière pour voir les messages de vos simples connaissances.
|
||||||
|
- **Services de localisation** : Activation et désactivation, départ et recherche en fonction de la distance.
|
||||||
|
- **Rapports de distribution** : Dans un monde de plateforme multiples et décentralisées, il y a des imprévus. Les sites et les réseaux tombent parfois en panne. Les développeurs de projets introduisent parfois des bogues et des incompatibilités. Cette fonction vous permet de savoir ce qu'il est advenu de votre message ou de votre commentaire et où il est réellement passé une fois que vous l'avez publié.
|
||||||
|
- **Sécurité des données** : Parce que le meilleur moment pour faire une sauvegarde à jour de vos données, c'était il y a 10 secondes. Clonez votre identité et votre contenu en ligne sur plusieurs sites à l'aide du protocole Nomad et reproduisez tout changement en temps quasi réel. Ainsi, si le site qui héberge votre compte tombe en panne (temporairement ou définitivement) ou si vous en êtes expulsé pour une raison quelconque, votre vie en ligne n'est pas perdue et vous n'êtes pas obligé de la reprendre à zéro. Tous vos amis et tout votre contenu sont disponibles sur n'importe laquelle de vos instances clonées - à tout moment.
|
||||||
|
- **ActivityPub** : Fournit l'API ActivityPub "Client to Server" pour une utilisation avec des applications externes.
|
||||||
|
|
||||||
|
|
||||||
|
**Version incluse :** 23.08.02~ynh5
|
||||||
|
|
||||||
|
## Captures d’écran
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
|
* Dépôt de code officiel de l’app : <https://codeberg.org/streams/streams>
|
||||||
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_streams>
|
||||||
|
* Signaler un bug : <https://github.com/YunoHost-Apps/streams_ynh/issues>
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/streams_ynh/tree/testing).
|
||||||
|
|
||||||
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/streams_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade streams -u https://github.com/YunoHost-Apps/streams_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
BIN
doc/screenshots/example.png
Normal file
BIN
doc/screenshots/example.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 420 KiB |
Loading…
Add table
Reference in a new issue