couchdb_ynh/README.md

Couchdb for YunoHost

Lire ce readme en français.

This package allows you to install couchdb quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Couchdb is a database system, where entries are json objects (allowing attachments), and that you can access via simple http requests.

As explained in wikipedia:

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

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

Documentation

• Official documentation: https://docs.couchdb.org/en/stable/index.html

YunoHost specific features

Multi-user support

Couchdb has it's own users management system, so LDAP is not supported.

Supported architectures

• x86-64 -
• ARMv8-A -

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
• 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

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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