1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/couchdb_ynh.git synced 2024-09-03 18:16:11 +02:00
couchdb_ynh/README.md

55 lines
2.2 KiB
Markdown
Raw Normal View History

2021-07-23 10:08:07 +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.
-->
# CouchDB for YunoHost
2021-03-07 19:51:22 +01:00
2023-10-31 15:02:20 +01:00
[![Integration level](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![Working status](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg)
2021-07-23 10:08:07 +02:00
[![Install CouchDB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchdb)
2021-03-07 19:51:22 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-07-23 10:08:07 +02:00
> *This package allows you to install CouchDB quickly and simply on a YunoHost server.
2021-03-07 19:51:22 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-07-16 19:14:50 +02:00
Couchdb is a database system, where entries are json objects (allowing attachments), and that you can access and synchronize via simple http requests.
2021-03-07 19:51:22 +01:00
2022-07-16 19:14:50 +02:00
As explained in wikipedia:
> Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang.
2021-03-07 19:51:22 +01:00
2022-07-16 19:14:50 +02:00
And as described in the couchdb official website:
> Seamless multi-master sync, that scales from Big Data to Mobile, with an Intuitive HTTP/JSON API and designed for Reliability.
2021-03-07 19:51:22 +01:00
2022-10-21 19:46:22 +02:00
**Shipped version:** 3.2.2~ynh2
2022-08-15 01:07:53 +02:00
2021-03-07 19:51:22 +01:00
## Screenshots
2022-07-16 19:14:50 +02:00
![Screenshot of CouchDB](./doc/screenshots/Apache_CouchDB_v2.1.1_Fauxton_Console.png)
2021-03-07 19:51:22 +01:00
2021-07-23 10:08:07 +02:00
## Documentation and resources
2021-03-07 19:51:22 +01:00
2022-07-16 19:14:50 +02:00
* Official app website: <https://couchdb.apache.org/>
* Official admin documentation: <https://docs.couchdb.org/en/stable/>
* Upstream app code repository: <https://github.com/apache/couchdb>
2023-10-31 15:02:20 +01:00
* YunoHost Store: <https://apps.yunohost.org/app/couchdb>
2022-07-16 19:14:50 +02:00
* Report a bug: <https://github.com/YunoHost-Apps/couchdb_ynh/issues>
2021-03-07 19:51:22 +01:00
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing).
To try the testing branch, please proceed like that.
2022-07-16 19:14:50 +02:00
``` bash
2021-03-07 19:51:22 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug
or
sudo yunohost app upgrade couchdb -u https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug
```
2021-07-23 10:08:07 +02:00
2022-07-16 19:14:50 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>