mirror of
https://github.com/YunoHost-Apps/couchdb_ynh.git
synced 2024-09-03 18:16:11 +02:00
Auto-update README
This commit is contained in:
parent
809f0ea116
commit
a966c6b17b
2 changed files with 41 additions and 86 deletions
64
README.md
64
README.md
|
@ -1,68 +1,44 @@
|
||||||
# Couchdb for YunoHost
|
<!--
|
||||||
|
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
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg)
|
[![Integration level](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg)
|
||||||
[![Install couchdb with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchdb)
|
[![Install CouchDB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchdb)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allows you to install couchdb quickly and simply on a YunoHost server.
|
> *This package allows you to install CouchDB 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.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Couchdb is a database system, where entries are json objects (allowing attachments), and that you can access and synchronize via simple http requests.
|
An open-source document-oriented NoSQL database
|
||||||
|
|
||||||
As explained in wikipedia:
|
**Shipped version:** 3.1.1~ynh2
|
||||||
> Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
**Shipped version:** 3.1.1
|
|
||||||
|
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
![](https://upload.wikimedia.org/wikipedia/commons/c/c5/Apache_CouchDB_v2.1.1_Fauxton_Console.png)
|
![](./doc/screenshots/Apache_CouchDB_v2.1.1_Fauxton_Console.png)
|
||||||
|
|
||||||
|
## Disclaimers / important information
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
You can do most configuration of couchdb from fauxton, the web interface, accessible at the domain you specified: https://domain.tld/_utils/index.html
|
You can do most configuration of CouchDB from fauxton, the web interface, accessible at the domain you specified: https://domain.tld/_utils/index.html
|
||||||
|
|
||||||
|
## Documentation and resources
|
||||||
|
|
||||||
## Documentation
|
* Official app website: https://couchdb.apache.org/
|
||||||
|
* Official user documentation: https://yunohost.org/apps
|
||||||
* Official documentation: https://docs.couchdb.org/en/stable/index.html
|
* Official admin documentation: https://docs.couchdb.org/en/stable/
|
||||||
|
* Upstream app code repository: https://github.com/apache/couchdb
|
||||||
|
* YunoHost documentation for this app: https://yunohost.org/app_couchdb
|
||||||
## YunoHost specific features
|
|
||||||
|
|
||||||
#### Multi-user support
|
|
||||||
|
|
||||||
Couchdb has it's own users management system, so LDAP is not supported.
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/couchdb%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/couchdb/)
|
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/couchdb%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/couchdb/)
|
|
||||||
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
By default this package installs couchdb as single node, if you need a different setup, please contribute with pull requests to improve the package :)
|
|
||||||
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/couchdb_ynh/issues
|
* Report a bug: https://github.com/YunoHost-Apps/couchdb_ynh/issues
|
||||||
* App website: Link to the official website of this app.
|
|
||||||
* Upstream app repository: Link to the official repository of the upstream app.
|
|
||||||
* YunoHost website: https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
|
@ -74,3 +50,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/couchdb_ynh/tree/test
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade couchdb -u https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug
|
sudo yunohost app upgrade couchdb -u https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
61
README_fr.md
61
README_fr.md
|
@ -1,65 +1,40 @@
|
||||||
# Couchdb pour YunoHost
|
# CouchDB pour YunoHost
|
||||||
|
|
||||||
[![Niveau d'intégration](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg)
|
[![Niveau d'intégration](https://dash.yunohost.org/integration/couchdb.svg)](https://dash.yunohost.org/appci/app/couchdb) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/couchdb.maintain.svg)
|
||||||
[![Installer couchdb avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchdb)
|
[![Installer CouchDB avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=couchdb)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *Ce package vous permet d'installer couchdb rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d'installer CouchDB rapidement et simplement sur un serveur YunoHost.
|
||||||
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
## Vue d'ensemble
|
## Vue d'ensemble
|
||||||
|
|
||||||
Couchdb est un gestionnaire de bases de données dans lesquelles les entrées sont des documents jsons (avec possibilité de pièces jointes), qui peuvent être manipulées par de simples requêtes http.
|
Système de gestion de base de données orienté documents
|
||||||
|
|
||||||
Comme le présente wikipédia:
|
**Version incluse :** 3.1.1~ynh2
|
||||||
> Apache CouchDB est un système de gestion de base de données orienté documents, écrit en langage Erlang et distribué sous licence Apache.
|
|
||||||
> Conçu pour le Web, il fait partie de la mouvance NoSQL, et a été conçu pour pouvoir être réparti sur une grappe de serveurs.
|
|
||||||
|
|
||||||
**Version incluse :** 3.1.1
|
|
||||||
|
|
||||||
|
|
||||||
## Captures d'écran
|
## Captures d'écran
|
||||||
|
|
||||||
![](https://upload.wikimedia.org/wikipedia/commons/c/c5/Apache_CouchDB_v2.1.1_Fauxton_Console.png)
|
![](./doc/screenshots/Apache_CouchDB_v2.1.1_Fauxton_Console.png)
|
||||||
|
|
||||||
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Couchdb peut-être configuré via fauxton, l'interface web accessible sur le domaine que vous avez spécifié: https://domain.tld/_utils/index.html
|
Vous pouvez effectuer la plupart des configurations de CouchDB à partir de fauxton, l'interface Web, accessible sur le domaine que vous avez spécifié : https://domain.tld/_utils/index.html
|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
## Documentation
|
* Site officiel de l'app : https://couchdb.apache.org/
|
||||||
|
* Documentation officielle utilisateur : https://yunohost.org/apps
|
||||||
* Documentation officielle : https://docs.couchdb.org/en/stable/index.html
|
* Documentation officielle de l'admin : https://docs.couchdb.org/en/stable/
|
||||||
|
* Dépôt de code officiel de l'app : https://github.com/apache/couchdb
|
||||||
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_couchdb
|
||||||
## Caractéristiques spécifiques YunoHost
|
* Signaler un bug : https://github.com/YunoHost-Apps/couchdb_ynh/issues
|
||||||
|
|
||||||
#### Support multi-utilisateur
|
|
||||||
|
|
||||||
Couchdb a sa propre gestion d'utilisateurs, donc LDAP n'est pas supporté.
|
|
||||||
|
|
||||||
#### Architectures supportées
|
|
||||||
|
|
||||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/couchdb%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/couchdb/)
|
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/couchdb%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/couchdb/)
|
|
||||||
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
Par défaut, ce paquet install couchdb comme nœud simple. Si vous souhaitez permettre des installations plus avancées les contributions sont bienvenues :)
|
|
||||||
|
|
||||||
|
|
||||||
## Liens
|
|
||||||
|
|
||||||
* Signaler un bug : https://github.com/YunoHost-Apps/couchdb_ynh/issues
|
|
||||||
* Site de l'application : Lien vers le site officiel de cette application.
|
|
||||||
* Dépôt de l'application principale : Lien vers le dépôt officiel de l'application principale.
|
|
||||||
* Site web YunoHost : https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
@ -71,3 +46,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/couchdb_ynh/tree/test
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade couchdb -u https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug
|
sudo yunohost app upgrade couchdb -u https://github.com/YunoHost-Apps/couchdb_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
Loading…
Reference in a new issue