docs(couchdb): Apply suggestions from @spantaleev
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
This commit is contained in:
parent
a4c96916b7
commit
3291b102ab
2 changed files with 7 additions and 4 deletions
|
@ -1,10 +1,12 @@
|
|||
# CouchDB
|
||||
|
||||
CouchDB is a NoSQL database that uses JSON for documents.
|
||||
[CouchDB](https://couchdb.apache.org/) is a NoSQL database that uses JSON for documents.
|
||||
This Ansible role is designed to install and configure CouchDB for using the [official CouchDB Docker image](https://github.com/apache/couchdb-docker) via the [ansible-role-couchdb](https://github.com/Bergruebe/ansible-role-couchdb).
|
||||
|
||||
**Warning**: This role will not delete or modify existing databases or users. It will only create new databases and users if they do not already exist.
|
||||
|
||||
**Warning**: This role **does not automatically integrate with Traefik** yet (see details below). PRs are welcome!
|
||||
|
||||
## Features
|
||||
|
||||
- Sets up CouchDB in a Docker container.
|
||||
|
@ -24,7 +26,7 @@ To use this role with the MASH playbook, add following lines to your inventory f
|
|||
# #
|
||||
########################################################################
|
||||
|
||||
couchdb_enabled:: true
|
||||
couchdb_enabled: true
|
||||
|
||||
couchdb_hostname: couchdb.example.com
|
||||
|
||||
|
@ -54,7 +56,7 @@ couchdb_tables_custom:
|
|||
|
||||
########################################################################
|
||||
# #
|
||||
# /cocuhdb #
|
||||
# /couchdb #
|
||||
# #
|
||||
########################################################################
|
||||
```
|
||||
|
@ -73,6 +75,8 @@ For more information on possible configuration, refer to the comments in the [`d
|
|||
By default, this role **will not expose the CouchDB port** to the host machine. If you want to access CouchDB from outside the Docker container, you will need to expose the port in your playbook via the `couchdb_container_http_host_bind_port` variable. Or you can just add the container to another docker network via the `couchdb_container_additional_networks_custom` variable.
|
||||
Please consider the use of a reverse proxy for secure access to CouchDB.
|
||||
|
||||
Currently, the [ansible-role-couchdb](https://github.com/Bergruebe/ansible-role-couchdb) Ansible role **does not automatically integrate with Traefik**. PRs are welcome!
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to review the [ansible-role-couchdb](https://github.com/Bergruebe/ansible-role-couchdb) repository and submit a Pull Request.
|
||||
|
|
|
@ -1704,7 +1704,6 @@ couchdb_config_uuid: "{{ '%s' | format(mash_playbook_generic_secret_key) | passw
|
|||
|
||||
couchdb_config_couch_chttpd_auth_secret: "{{ '%s' | format(mash_playbook_generic_secret_key) | password_hash('sha512', 'secret.couchdb', rounds=655555) | to_uuid }}"
|
||||
|
||||
|
||||
########################################################################
|
||||
# #
|
||||
# /couchdb #
|
||||
|
|
Loading…
Reference in a new issue