mirror of
https://github.com/YunoHost-Apps/flohmarkt_ynh.git
synced 2024-09-03 18:36:30 +02:00
READMEs, screenshot smaller
This commit is contained in:
Chris Vogel
parent
0a83f19729
commit
05559f55b3
8 changed files with 488 additions and 56 deletions
7
ALL_README.md
Normal file
7
ALL_README.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# All available README files by language
|
||||
|
||||
- [Read the README in English](README.md)
|
||||
- [Irakurri README euskaraz](README_eu.md)
|
||||
- [Lire le README en français](README_fr.md)
|
||||
- [Le o README en galego](README_gl.md)
|
||||
- [阅读中文（简体）的 README](README_zh_Hans.md)
|
||||
81
README.manual.md
Normal file
81
README.manual.md
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
## status
|
||||
|
||||
These are my notes about questions and ideas regarding packaging [flohmarkt](https://codeberg.org/flohmarkt/flohmarkt) for yunohost.
|
||||
|
||||
### installs
|
||||
|
||||
flohmarkt will only install if there's not yet a couchdb installed as .dep or running otherwise.
|
||||
|
||||
### removes
|
||||
|
||||
**Warning:** This will probably break any existing installation of couchdb (there's an couchdb app to install just couchdb and expose its port via nginx reverse-proxy).
|
||||
|
||||
### no backup, yet
|
||||
|
||||
**Another warning:** When installing flohmarkt on a a domain and letting it talk to other ActivityPub instances it will propagate a key associated to your domain. If you remove your flohmarkt from that domain and loose that key other instances might not want to talk to you anymore after you installed flohmarkt again on the same domain generating a new key.
|
||||
|
||||
**This is really strictly for testing only - don't install on a production yunohost.**
|
||||
|
||||
### Go ahead…
|
||||
|
||||
…test, break stuff and open issues :) !
|
||||
|
||||
## help welcome
|
||||
|
||||
You're welcome to take part by opening issues or sending pull requests. You can also reach me on Matrix in [Yunohost Apps development](https://matrix.to/#/%23yunohost-apps:matrix.org) as @chrichri:librem.one .
|
||||
|
||||
I also announced this work on the [yunohost forum](https://forum.yunohost.org/t/ynh-flohmarkt-flohmarkt-as-an-app-for-yunohost/28455?u=chrichri).
|
||||
|
||||
## roadmap
|
||||
|
||||
* ~~use couchdb installation from ynh_couchdb~~: no
|
||||
* ~~why shouldn't~~ two apps install the same os dependency: no problem
|
||||
* ~~stop the couchdb deb from being de-installed if one of the two apps is de-installed → pseudo deb with depency~~ This is already achived by `ynh_install_extra_app_dependencies` in the install script
|
||||
|
||||
|
||||
* email
|
||||
* ~~how to make flohmarkt send email per port 25 without login?~~ not: install generates an smpt account for flohmarkt to login with and puts it into flohmarkt.conf
|
||||
* ~~postfix virtual-user table: allow flohmarkt to send email with 'mail from: <flohmarkt-email>'~~ works
|
||||
* ~~define a custom setting `mail_user` and `mail_domain` using ynh_app_setting_set (or .toml?) if necessary~~ done
|
||||
|
||||
* make first ynh_package
|
||||
* ~~nginx just reverse proxy~~ done
|
||||
* ~~disable http (without s)~~ this is a general yunohost setting
|
||||
* ~~remove script~~
|
||||
* backup script
|
||||
* export flohmarkt data from couchdb
|
||||
* backup yunohost.app/$app
|
||||
* check whether app settings are stored by yunohost framework (password, etc.)
|
||||
|
||||
### → 0.1 alpha
|
||||
* ~~disable path selection and mark it that it needs its own domain.~~
|
||||
* tag 0.1 alpha
|
||||
* write limitations in README.md (copy from `antifeatures` in manifest.toml)
|
||||
* fail2ban configuration
|
||||
|
||||
### → 0.2 beta
|
||||
* restore script
|
||||
* upgrade script
|
||||
* fail2ban config
|
||||
|
||||
### later
|
||||
|
||||
* couchdb
|
||||
* check if already installed
|
||||
* if installed by flohmarkt: create couchdb user
|
||||
* check if install results in the same configuration as with couchdb_ynh
|
||||
|
||||
* try to get a filter that stops registration
|
||||
* in general
|
||||
* for users without permission (sso)
|
||||
|
||||
* is it possible to have multiple flohmarkt instances in one couchdb
|
||||
* database name could contain domain name
|
||||
|
||||
## ideas
|
||||
|
||||
For the time being I'd not like to integrate into ldap. I'd like to let the admin choose whether registration is open to anybody, to yunohost user group (sso) or nobody. _anybody_ and _nobody_ is what flohmarkt already offers.
|
||||
|
||||
For 'yunohost user group' I'd like to have the registration urls rewritten by nginx to some `you're not allowed to registered`-page if no user with permission is logged in. Is there an example somewhere or is it even possible at all?
|
||||
|
||||
|
||||
112
README.md
112
README.md
|
|
@ -1,81 +1,85 @@
|
|||
## status
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
These are my notes about questions and ideas regarding packaging [flohmarkt](https://codeberg.org/flohmarkt/flohmarkt) for yunohost.
|
||||
# flohmarkt for YunoHost
|
||||
|
||||
### installs
|
||||
[](https://dash.yunohost.org/appci/app/flohmarkt)  
|
||||
|
||||
flohmarkt will only install if there's not yet a couchdb installed as .dep or running otherwise.
|
||||
[](https://install-app.yunohost.org/?app=flohmarkt)
|
||||
|
||||
### removes
|
||||
*[Read this README in other languages.](./ALL_README.md)*
|
||||
|
||||
**Warning:** This will probably break any existing installation of couchdb (there's an couchdb app to install just couchdb and expose its port via nginx reverse-proxy).
|
||||
> *This package allows you to install flohmarkt 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.*
|
||||
|
||||
### no backup, yet
|
||||
## Overview
|
||||
|
||||
**Another warning:** When installing flohmarkt on a a domain and letting it talk to other ActivityPub instances it will propagate a key associated to your domain. If you remove your flohmarkt from that domain and loose that key other instances might not want to talk to you anymore after you installed flohmarkt again on the same domain generating a new key.
|
||||
## A decentral federated small advertisement platform
|
||||
|
||||
**This is really strictly for testing only - don't install on a production yunohost.**
|
||||
flohmarkt provides its own http server that can be used stand-alone to show small ads that registered users may publish.
|
||||
|
||||
### Go ahead…
|
||||
Registration works through the server itself and can be switched off (to run a server for e.g. only one person or only the persons that had been registered until that moment).
|
||||
|
||||
…test, break stuff and open issues :) !
|
||||
To register it's necessary to provide an email address to which a confirmation link is send.
|
||||
|
||||
## help welcome
|
||||
Registered users can access a simple form to publish there small ads. The small ads can be looked at by anybody who is able to reach the website.
|
||||
|
||||
You're welcome to take part by opening issues or sending pull requests. You can also reach me on Matrix in [Yunohost Apps development](https://matrix.to/#/%23yunohost-apps:matrix.org) as @chrichri:librem.one .
|
||||
## Federation
|
||||
|
||||
I also announced this work on the [yunohost forum](https://forum.yunohost.org/t/ynh-flohmarkt-flohmarkt-as-an-app-for-yunohost/28455?u=chrichri).
|
||||
To communicate with someone who published a small ad the server hints to an unregistred user _"To answer this offer please log in or create an account. OR use another fediverse-account".
|
||||
|
||||
## roadmap
|
||||
The small add visited turns out to be a _note_ in the fediverse. It's url can be opened with your favourite fediverse client at the server you're already registered to. You then can boost the small ad like any other note you read.
|
||||
|
||||
* ~~use couchdb installation from ynh_couchdb~~: no
|
||||
* ~~why shouldn't~~ two apps install the same os dependency: no problem
|
||||
* ~~stop the couchdb deb from being de-installed if one of the two apps is de-installed → pseudo deb with depency~~ This is already achived by `ynh_install_extra_app_dependencies` in the install script
|
||||
Or you can use your account to answer the author of the small ad if - and only if - you mark your note as 'private' aka 'direct'. This way you can contact the person.
|
||||
|
||||
It's also possible to follow accounts on flohmarkt servers like any other account in the fediverse to get new small ads published by that account in your timeline.
|
||||
|
||||
## Federation between flohmarkts
|
||||
|
||||
At time of installation the software asks for the coordinates of the community it should be for and the radius it should be used in.
|
||||
|
||||
This is an offer to help make the goods that might be offered travel less far. A flohmarkt can manually federate with other flohmarkts in its range showing all their goods on its page.
|
||||
|
||||
This is not ment to be a restriction, but a nudging to build local communities. These would have the advantage that people could trust each other more, because trades face-to-face could be more common.
|
||||
|
||||
## More information
|
||||
|
||||
Generally the [wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki) is a good source of information.
|
||||
|
||||
* [presentation at ChaosCamp 2023](https://media.ccc.de/v/camp2023-57168-flohmarkt#l=eng&t=213)
|
||||
* [list of known instances on the wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki/flohmarkt-instances)
|
||||
* [Service compatibility chart](https://codeberg.org/flohmarkt/flohmarkt/wiki/Service-compatibility-chart)
|
||||
|
||||
|
||||
* email
|
||||
* ~~how to make flohmarkt send email per port 25 without login?~~ not: install generates an smpt account for flohmarkt to login with and puts it into flohmarkt.conf
|
||||
* ~~postfix virtual-user table: allow flohmarkt to send email with 'mail from: <flohmarkt-email>'~~ works
|
||||
* ~~define a custom setting `mail_user` and `mail_domain` using ynh_app_setting_set (or .toml?) if necessary~~ done
|
||||
**Shipped version:** 1.0~ynh2
|
||||
|
||||
* make first ynh_package
|
||||
* ~~nginx just reverse proxy~~ done
|
||||
* ~~disable http (without s)~~ this is a general yunohost setting
|
||||
* ~~remove script~~
|
||||
* backup script
|
||||
* export flohmarkt data from couchdb
|
||||
* backup yunohost.app/$app
|
||||
* check whether app settings are stored by yunohost framework (password, etc.)
|
||||
**Demo:** <https://flohmarkt.ween.de/>
|
||||
|
||||
### → 0.1 alpha
|
||||
* ~~disable path selection and mark it that it needs its own domain.~~
|
||||
* tag 0.1 alpha
|
||||
* write limitations in README.md (copy from `antifeatures` in manifest.toml)
|
||||
* fail2ban configuration
|
||||
## Screenshots
|
||||
|
||||
### → 0.2 beta
|
||||
* restore script
|
||||
* upgrade script
|
||||
* fail2ban config
|
||||
|
||||
|
||||
### later
|
||||
## Documentation and resources
|
||||
|
||||
* couchdb
|
||||
* check if already installed
|
||||
* if installed by flohmarkt: create couchdb user
|
||||
* check if install results in the same configuration as with couchdb_ynh
|
||||
- Official app website: <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- Official user documentation: <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Official admin documentation: <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Upstream app code repository: <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- YunoHost Store: <https://apps.yunohost.org/app/flohmarkt>
|
||||
- Report a bug: <https://github.com/YunoHost-Apps/flohmarkt_ynh/issues>
|
||||
|
||||
* try to get a filter that stops registration
|
||||
* in general
|
||||
* for users without permission (sso)
|
||||
## Developer info
|
||||
|
||||
* is it possible to have multiple flohmarkt instances in one couchdb
|
||||
* database name could contain domain name
|
||||
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing).
|
||||
|
||||
## ideas
|
||||
|
||||
For the time being I'd not like to integrate into ldap. I'd like to let the admin choose whether registration is open to anybody, to yunohost user group (sso) or nobody. _anybody_ and _nobody_ is what flohmarkt already offers.
|
||||
|
||||
For 'yunohost user group' I'd like to have the registration urls rewritten by nginx to some `you're not allowed to registered`-page if no user with permission is logged in. Is there an example somewhere or is it even possible at all?
|
||||
To try the `testing` branch, please proceed like that:
|
||||
|
||||
```bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade flohmarkt -u https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
|
|
|||
85
README_eu.md
Normal file
85
README_eu.md
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
<!--
|
||||
Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
|
||||
EZ editatu eskuz.
|
||||
-->
|
||||
|
||||
# flohmarkt YunoHost-erako
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/flohmarkt)  
|
||||
|
||||
[](https://install-app.yunohost.org/?app=flohmarkt)
|
||||
|
||||
*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
|
||||
|
||||
> *Pakete honek flohmarkt YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*
|
||||
> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
|
||||
|
||||
## Aurreikuspena
|
||||
|
||||
## A decentral federated small advertisement platform
|
||||
|
||||
flohmarkt provides its own http server that can be used stand-alone to show small ads that registered users may publish.
|
||||
|
||||
Registration works through the server itself and can be switched off (to run a server for e.g. only one person or only the persons that had been registered until that moment).
|
||||
|
||||
To register it's necessary to provide an email address to which a confirmation link is send.
|
||||
|
||||
Registered users can access a simple form to publish there small ads. The small ads can be looked at by anybody who is able to reach the website.
|
||||
|
||||
## Federation
|
||||
|
||||
To communicate with someone who published a small ad the server hints to an unregistred user _"To answer this offer please log in or create an account. OR use another fediverse-account".
|
||||
|
||||
The small add visited turns out to be a _note_ in the fediverse. It's url can be opened with your favourite fediverse client at the server you're already registered to. You then can boost the small ad like any other note you read.
|
||||
|
||||
Or you can use your account to answer the author of the small ad if - and only if - you mark your note as 'private' aka 'direct'. This way you can contact the person.
|
||||
|
||||
It's also possible to follow accounts on flohmarkt servers like any other account in the fediverse to get new small ads published by that account in your timeline.
|
||||
|
||||
## Federation between flohmarkts
|
||||
|
||||
At time of installation the software asks for the coordinates of the community it should be for and the radius it should be used in.
|
||||
|
||||
This is an offer to help make the goods that might be offered travel less far. A flohmarkt can manually federate with other flohmarkts in its range showing all their goods on its page.
|
||||
|
||||
This is not ment to be a restriction, but a nudging to build local communities. These would have the advantage that people could trust each other more, because trades face-to-face could be more common.
|
||||
|
||||
## More information
|
||||
|
||||
Generally the [wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki) is a good source of information.
|
||||
|
||||
* [presentation at ChaosCamp 2023](https://media.ccc.de/v/camp2023-57168-flohmarkt#l=eng&t=213)
|
||||
* [list of known instances on the wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki/flohmarkt-instances)
|
||||
* [Service compatibility chart](https://codeberg.org/flohmarkt/flohmarkt/wiki/Service-compatibility-chart)
|
||||
|
||||
|
||||
**Paketatutako bertsioa:** 1.0~ynh2
|
||||
|
||||
**Demoa:** <https://flohmarkt.ween.de/>
|
||||
|
||||
## Pantaila-argazkiak
|
||||
|
||||
|
||||
|
||||
## Dokumentazioa eta baliabideak
|
||||
|
||||
- Aplikazioaren webgune ofiziala: <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- Erabiltzaileen dokumentazio ofiziala: <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Administratzaileen dokumentazio ofiziala: <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Jatorrizko aplikazioaren kode-gordailua: <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- YunoHost Denda: <https://apps.yunohost.org/app/flohmarkt>
|
||||
- Eman errore baten berri: <https://github.com/YunoHost-Apps/flohmarkt_ynh/issues>
|
||||
|
||||
## Garatzaileentzako informazioa
|
||||
|
||||
Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing).
|
||||
|
||||
`testing` abarra probatzeko, ondorengoa egin:
|
||||
|
||||
```bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
edo
|
||||
sudo yunohost app upgrade flohmarkt -u https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>
|
||||
85
README_fr.md
Normal file
85
README_fr.md
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
<!--
|
||||
Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||
Il NE doit PAS être modifié à la main.
|
||||
-->
|
||||
|
||||
# flohmarkt pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/flohmarkt)  
|
||||
|
||||
[](https://install-app.yunohost.org/?app=flohmarkt)
|
||||
|
||||
*[Lire le README dans d'autres langues.](./ALL_README.md)*
|
||||
|
||||
> *Ce package vous permet d’installer flohmarkt 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
|
||||
|
||||
## A decentral federated small advertisement platform
|
||||
|
||||
flohmarkt provides its own http server that can be used stand-alone to show small ads that registered users may publish.
|
||||
|
||||
Registration works through the server itself and can be switched off (to run a server for e.g. only one person or only the persons that had been registered until that moment).
|
||||
|
||||
To register it's necessary to provide an email address to which a confirmation link is send.
|
||||
|
||||
Registered users can access a simple form to publish there small ads. The small ads can be looked at by anybody who is able to reach the website.
|
||||
|
||||
## Federation
|
||||
|
||||
To communicate with someone who published a small ad the server hints to an unregistred user _"To answer this offer please log in or create an account. OR use another fediverse-account".
|
||||
|
||||
The small add visited turns out to be a _note_ in the fediverse. It's url can be opened with your favourite fediverse client at the server you're already registered to. You then can boost the small ad like any other note you read.
|
||||
|
||||
Or you can use your account to answer the author of the small ad if - and only if - you mark your note as 'private' aka 'direct'. This way you can contact the person.
|
||||
|
||||
It's also possible to follow accounts on flohmarkt servers like any other account in the fediverse to get new small ads published by that account in your timeline.
|
||||
|
||||
## Federation between flohmarkts
|
||||
|
||||
At time of installation the software asks for the coordinates of the community it should be for and the radius it should be used in.
|
||||
|
||||
This is an offer to help make the goods that might be offered travel less far. A flohmarkt can manually federate with other flohmarkts in its range showing all their goods on its page.
|
||||
|
||||
This is not ment to be a restriction, but a nudging to build local communities. These would have the advantage that people could trust each other more, because trades face-to-face could be more common.
|
||||
|
||||
## More information
|
||||
|
||||
Generally the [wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki) is a good source of information.
|
||||
|
||||
* [presentation at ChaosCamp 2023](https://media.ccc.de/v/camp2023-57168-flohmarkt#l=eng&t=213)
|
||||
* [list of known instances on the wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki/flohmarkt-instances)
|
||||
* [Service compatibility chart](https://codeberg.org/flohmarkt/flohmarkt/wiki/Service-compatibility-chart)
|
||||
|
||||
|
||||
**Version incluse :** 1.0~ynh2
|
||||
|
||||
**Démo :** <https://flohmarkt.ween.de/>
|
||||
|
||||
## Captures d’écran
|
||||
|
||||
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
- Site officiel de l’app : <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- Documentation officielle utilisateur : <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Documentation officielle de l’admin : <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Dépôt de code officiel de l’app : <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- YunoHost Store : <https://apps.yunohost.org/app/flohmarkt>
|
||||
- Signaler un bug : <https://github.com/YunoHost-Apps/flohmarkt_ynh/issues>
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche `testing`, procédez comme suit :
|
||||
|
||||
```bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade flohmarkt -u https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||
85
README_gl.md
Normal file
85
README_gl.md
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
<!--
|
||||
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||
NON debe editarse manualmente.
|
||||
-->
|
||||
|
||||
# flohmarkt para YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/flohmarkt)  
|
||||
|
||||
[](https://install-app.yunohost.org/?app=flohmarkt)
|
||||
|
||||
*[Le este README en outros idiomas.](./ALL_README.md)*
|
||||
|
||||
> *Este paquete permíteche instalar flohmarkt 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
|
||||
|
||||
## A decentral federated small advertisement platform
|
||||
|
||||
flohmarkt provides its own http server that can be used stand-alone to show small ads that registered users may publish.
|
||||
|
||||
Registration works through the server itself and can be switched off (to run a server for e.g. only one person or only the persons that had been registered until that moment).
|
||||
|
||||
To register it's necessary to provide an email address to which a confirmation link is send.
|
||||
|
||||
Registered users can access a simple form to publish there small ads. The small ads can be looked at by anybody who is able to reach the website.
|
||||
|
||||
## Federation
|
||||
|
||||
To communicate with someone who published a small ad the server hints to an unregistred user _"To answer this offer please log in or create an account. OR use another fediverse-account".
|
||||
|
||||
The small add visited turns out to be a _note_ in the fediverse. It's url can be opened with your favourite fediverse client at the server you're already registered to. You then can boost the small ad like any other note you read.
|
||||
|
||||
Or you can use your account to answer the author of the small ad if - and only if - you mark your note as 'private' aka 'direct'. This way you can contact the person.
|
||||
|
||||
It's also possible to follow accounts on flohmarkt servers like any other account in the fediverse to get new small ads published by that account in your timeline.
|
||||
|
||||
## Federation between flohmarkts
|
||||
|
||||
At time of installation the software asks for the coordinates of the community it should be for and the radius it should be used in.
|
||||
|
||||
This is an offer to help make the goods that might be offered travel less far. A flohmarkt can manually federate with other flohmarkts in its range showing all their goods on its page.
|
||||
|
||||
This is not ment to be a restriction, but a nudging to build local communities. These would have the advantage that people could trust each other more, because trades face-to-face could be more common.
|
||||
|
||||
## More information
|
||||
|
||||
Generally the [wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki) is a good source of information.
|
||||
|
||||
* [presentation at ChaosCamp 2023](https://media.ccc.de/v/camp2023-57168-flohmarkt#l=eng&t=213)
|
||||
* [list of known instances on the wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki/flohmarkt-instances)
|
||||
* [Service compatibility chart](https://codeberg.org/flohmarkt/flohmarkt/wiki/Service-compatibility-chart)
|
||||
|
||||
|
||||
**Versión proporcionada:** 1.0~ynh2
|
||||
|
||||
**Demo:** <https://flohmarkt.ween.de/>
|
||||
|
||||
## Capturas de pantalla
|
||||
|
||||
|
||||
|
||||
## Documentación e recursos
|
||||
|
||||
- Web oficial da app: <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- Documentación oficial para usuarias: <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Documentación oficial para admin: <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- Repositorio de orixe do código: <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- Tenda YunoHost: <https://apps.yunohost.org/app/flohmarkt>
|
||||
- Informar dun problema: <https://github.com/YunoHost-Apps/flohmarkt_ynh/issues>
|
||||
|
||||
## Info de desenvolvemento
|
||||
|
||||
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing).
|
||||
|
||||
Para probar a rama `testing`, procede deste xeito:
|
||||
|
||||
```bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade flohmarkt -u https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>
|
||||
85
README_zh_Hans.md
Normal file
85
README_zh_Hans.md
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
<!--
|
||||
注意：此 README 由 <https://github.com/YunoHost/apps/tree/master/tools/readme_generator> 自动生成
|
||||
请勿手动编辑。
|
||||
-->
|
||||
|
||||
# YunoHost 的 flohmarkt
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/flohmarkt)  
|
||||
|
||||
[](https://install-app.yunohost.org/?app=flohmarkt)
|
||||
|
||||
*[阅读此 README 的其它语言版本。](./ALL_README.md)*
|
||||
|
||||
> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 flohmarkt。*
|
||||
> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。*
|
||||
|
||||
## 概况
|
||||
|
||||
## A decentral federated small advertisement platform
|
||||
|
||||
flohmarkt provides its own http server that can be used stand-alone to show small ads that registered users may publish.
|
||||
|
||||
Registration works through the server itself and can be switched off (to run a server for e.g. only one person or only the persons that had been registered until that moment).
|
||||
|
||||
To register it's necessary to provide an email address to which a confirmation link is send.
|
||||
|
||||
Registered users can access a simple form to publish there small ads. The small ads can be looked at by anybody who is able to reach the website.
|
||||
|
||||
## Federation
|
||||
|
||||
To communicate with someone who published a small ad the server hints to an unregistred user _"To answer this offer please log in or create an account. OR use another fediverse-account".
|
||||
|
||||
The small add visited turns out to be a _note_ in the fediverse. It's url can be opened with your favourite fediverse client at the server you're already registered to. You then can boost the small ad like any other note you read.
|
||||
|
||||
Or you can use your account to answer the author of the small ad if - and only if - you mark your note as 'private' aka 'direct'. This way you can contact the person.
|
||||
|
||||
It's also possible to follow accounts on flohmarkt servers like any other account in the fediverse to get new small ads published by that account in your timeline.
|
||||
|
||||
## Federation between flohmarkts
|
||||
|
||||
At time of installation the software asks for the coordinates of the community it should be for and the radius it should be used in.
|
||||
|
||||
This is an offer to help make the goods that might be offered travel less far. A flohmarkt can manually federate with other flohmarkts in its range showing all their goods on its page.
|
||||
|
||||
This is not ment to be a restriction, but a nudging to build local communities. These would have the advantage that people could trust each other more, because trades face-to-face could be more common.
|
||||
|
||||
## More information
|
||||
|
||||
Generally the [wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki) is a good source of information.
|
||||
|
||||
* [presentation at ChaosCamp 2023](https://media.ccc.de/v/camp2023-57168-flohmarkt#l=eng&t=213)
|
||||
* [list of known instances on the wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki/flohmarkt-instances)
|
||||
* [Service compatibility chart](https://codeberg.org/flohmarkt/flohmarkt/wiki/Service-compatibility-chart)
|
||||
|
||||
|
||||
**分发版本：** 1.0~ynh2
|
||||
|
||||
**演示：** <https://flohmarkt.ween.de/>
|
||||
|
||||
## 截图
|
||||
|
||||
|
||||
|
||||
## 文档与资源
|
||||
|
||||
- 官方应用网站： <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- 官方用户文档： <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- 官方管理文档： <https://codeberg.org/flohmarkt/flohmarkt/wiki>
|
||||
- 上游应用代码库： <https://codeberg.org/flohmarkt/flohmarkt>
|
||||
- YunoHost 商店： <https://apps.yunohost.org/app/flohmarkt>
|
||||
- 报告 bug： <https://github.com/YunoHost-Apps/flohmarkt_ynh/issues>
|
||||
|
||||
## 开发者信息
|
||||
|
||||
请向 [`testing` 分支](https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing) 发送拉取请求。
|
||||
|
||||
如要尝试 `testing` 分支，请这样操作：
|
||||
|
||||
```bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
或
|
||||
sudo yunohost app upgrade flohmarkt -u https://github.com/YunoHost-Apps/flohmarkt_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**有关应用打包的更多信息：** <https://yunohost.org/packaging_apps>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.2 MiB After Width: | Height: | Size: 334 KiB |
Loading…
Reference in a new issue