YunoHost-Apps/flohmarkt_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/flohmarkt_ynh.git synced 2024-09-03 18:36:30 +02:00
Code Issues Activity Actions

cleaning

Browse source
This commit is contained in:
Éric Gaspar 2024-05-10 11:27:14 +02:00
parent 20a2a0ffdf
commit 3af81bfb43
6 changed files with 34 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
conf/systemd.service
View file

@ -1,5 +1,5 @@
[Unit]
Description=flohmarkt server
Description=Flohmarkt server
After=network.target couchdb.service
[Service]

6
doc/ADMIN.md
View file

@ -6,19 +6,19 @@ Flohmarkt is not initialized yet. Please go to
in order to complete the setup process
```
## support
## Support
For questions about running flohmarkt on yunohost please use the [yunohost support matrix channel](https://yunohost.org/en/chat_rooms#help-and-support-chat-roo) or the [forum](https://forum.yunohost.org/t/ynh-flohmarkt-flohmarkt-as-an-app-for-yunohost/28455?u=chrichri).
To get help for **flohmarkt** itself please look at its [wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki), [open an issue](https://codeberg.org/flohmarkt/flohmarkt/issues) with your request or join the [IRC channel flohmarkt](https://web.libera.chat/?nick=GithubGuest?#flohmarkt) on [libera.chat](https://libera.chat/).
## bugs, requesting features
## Bugs, requesting features
Please use the issue tracker at https://codeberg.org/flohmarkt/flohmarkt_ynh/issues
## upstream repository
The yunohost integration of **flohmarkt** is developed by the flohmarkt organization on https://codeberg.org/ .
The YunoHost integration of **flohmarkt** is developed by the flohmarkt organization on https://codeberg.org/ .
Please refer to https://codeberg.org/flohmarkt/flohmarkt_ynh/ to take part in development.

10
doc/DESCRIPTION.md
View file

@ -1,10 +1,10 @@
## 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.
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.
To register it's necessary to provide an e-mail 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.
@ -16,13 +16,13 @@ The small add visited turns out to be a _note_ in the fediverse. It's url can be
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.
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
## 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 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.

20
doc/DEVELOPMENT.md
View file

@ -1,27 +1,27 @@
## flohmarkt lives on codeberg
## Flohmarkt lives on codeberg
The flohmarkt team decided to use https://codeberg.org/ as its home. As we embrace the yunohost integration of **flohmarkt** we want to keep its development close to the core team in a repository under its organisation on Codeberg.
The Flohmarkt team decided to use https://codeberg.org/ as its home. As we embrace YunoHost integration of **Flohmarkt** we want to keep its development close to the core team in a repository under its organisation on Codeberg.
We acknowledge that this is unusual for an yunohost app and are aware that this decision might lead to problems and additional organizational effort.
But as much as we value yunohost and are willing to accept its decision to live on github we kindly ask everybody to accept and support our decision to organize the flohmarkt project on a different service.
But as much as we value YunoHost and are willing to accept its decision to live on github we kindly ask everybody to accept and support our decision to organize the flohmarkt project on a different service.
We hope that in the end the proximity between home repository and repository for yunohost integretion will be benefitial. If not there'll always be the option to move the repo completely into the yunohost-apps organization on github.
We hope that in the end the proximity between home repository and repository for YunoHost integretion will be benefitial. If not there'll always be the option to move the repo completely into the yunohost-apps organization on GitHub.
Your opinion is appreciated on this topic.
## development workflow
## Development workflow
**subject to change and discussion - think of this as an RFC**
### development on codeberg
### Development on codeberg
* clone the [repo](https://codeberg.org/flohmarkt/flohmarkt_ynh) on codeberg
* create your working branch
* once done with your changes / additions open a pull request to the main repo
* your request will be reviewed, discussed and probably merged
The codeberg repository is meant to be bleeding edge and we'll try to follow the HEAD of [flohmarkts](https://codeberg.org/flohmarkt/flohmarkt) repository closely.
The Codeberg repository is meant to be bleeding edge and we'll try to follow the HEAD of [Flohmarkts](https://codeberg.org/flohmarkt/flohmarkt) repository closely.
Once in a while we'll reach the point to tag a new `~ynhX` version for changes of the yunohost integration or we'll want to release a new version of flohmarkt or both.
@ -29,15 +29,15 @@ To do so we'll push the according changes to the [flohmarkt repository at github
One **pitfall** doing so is that we can't rely on the yunohost CI for testing for our codeberg repository this way. If need'll be and developers would like to use yunohost as their base for active work on flohmarkt we might release another app **flohmarkt-devel_ynh** in future that closely follows the repository we use for development.
#### master, main and testing
#### Master, main and testing
The development startet on codeberg on a branch named **main**. That worked all the way until the repository got mirrored to github to be included into the yunohost app catalog. The last change that needed to be done for flohmarkt to appear on the catalog has been to change the name of the branch to **master** for the workflows on github to recognize it for catalog inclusion.
The development startet on codeberg on a branch named **main**. That worked all the way until the repository got mirrored to GitHub to be included into the yunohost app catalog. The last change that needed to be done for flohmarkt to appear on the catalog has been to change the name of the branch to **master** for the workflows on GitHub to recognize it for catalog inclusion.
Short: for **historic** reason we use the branch **main** on codeberg and publish the versions for the catalog as **master** on github.
Because of https://github.com/YunoHost-Apps/flohmarkt_ynh/pull/2#issuecomment-2081108150 we decided to name the working branch on codeberg **testing** which also signals that this is not the place to install from if testing and development is not wanted.
### pushing to github
### pushing to GitHub
* make sure the local git and the codeberg git are in sync on their testing branch
* tag a new version on codeberg `<major>.<minor>~ynh<X>`, e.g. `0.01~ynh5`. `<major>.<minor>` is the flohmarkt version. `ynhX` is the version of the integration into flohmarkt (this repo).

4
doc/POST_INSTALL.md
View file

@ -1,6 +1,6 @@
## finishing setup
## Finishing setup
To finish your flohmarkt setup you'll need to open its setup URL.
To finish your Flohmarkt setup you'll need to open its setup URL.
You can find the setup URL in the logfile __FLOHMARKT_LOGFILE__ if you look for entries like this:

26
doc/PRE_INSTALL.md
View file

@ -1,42 +1,42 @@
## use of couchdb
## Use of couchdb
flohmarkt expects to install CouchDB from the Apache repository for its use. Installation of flohmarkt might break already existing installs of CouchDB.
**flohmarkt will probably not install if you're already running an instance of a couchdb**
**flohmarkt will probably not install if you're already running an instance of a CouchDB**
https://codeberg.org/flohmarkt/flohmarkt_ynh/src/commit/7721103bac61787f31a4b2f2ae695c65d4f26fc9/scripts/install#L9
https://codeberg.org/ChriChri/flohmarkt_ynh/issues/9
## multiple flohmarkt on the same subdomain
## Multiple Flohmarkt on the same subdomain
The installation will allow you to **test** this. The feature is not well tested, yet, and installing multiple productive flohmarkts in the same domain might not work on the fediverse.
Feedback is more than welcome!
## No integration in yunohost user database"
## No integration in yunohost user database
flohmarkt mainanins its own user database in CouchDB. Users have to register to flohmarkt to get an account. Registration cannot be restricted to yunohost users.
Flohmarkt mainanins its own user database in CouchDB. Users have to register to flohmarkt to get an account. Registration cannot be restricted to yunohost users.
https://codeberg.org/ChriChri/flohmarkt_ynh/issues/5 .
## removing
## Removing
**Warning:** This might break any existing installation of couchdb (there's an couchdb app to install just couchdb and expose its port via nginx reverse-proxy and possibly other software installing a couchdb). This could happen if you installed the couchdb app after you installed flohmarkt.
**Warning:** This might break any existing installation of CouchDB (there's an CouchDB app to install just CouchDB and expose its port via NGINX reverse-proxy and possibly other software installing a CouchDB). This could happen if you installed the CouchDB app after you installed flohmarkt.
https://codeberg.org/flohmarkt/flohmarkt_ynh/src/commit/7721103bac61787f31a4b2f2ae695c65d4f26fc9/scripts/remove#L44
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.
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.
## list of instances
## List of instances
We apreciate a lot if you run an instance of flohmarkt and will publish your [instance on the wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki/flohmarkt-instances) if you [open an issue](https://codeberg.org/flohmarkt/flohmarkt/issues) asking us to do so.
We apreciate a lot if you run an instance of Flohmarkt and will publish your [instance on the wiki](https://codeberg.org/flohmarkt/flohmarkt/wiki/flohmarkt-instances) if you [open an issue](https://codeberg.org/flohmarkt/flohmarkt/issues) asking us to do so.
If you're looking for another instance to federate with the list on the wiki is a good starting point also.
# help welcome
# 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 .
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).
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).
Look at [DEVELOPMENT.md](doc/DEVELOPMENT.md) for more information.