Code Monkey home page Code Monkey logo

couchdb's Introduction

couchdb

Table of Contents

  1. Description
  2. Setup - The basics of getting started with couchdb
  3. Usage - Configuration options and additional functionality
  4. Reference - Available parameters
  5. Limitations - OS compatibility, etc.
  6. Dependencies - Other requiered puppet modules

Description

The couchdb module installs and configures a CouchDB single-node-instance.

Setup

To install couchdb with the default paramters, declare the couchdb class.

include couchdb

Usage

Let CouchDB listen on any available IP addresses:

class {'couchdb':
  bind_address => '0.0.0.0',
}

Disable 'admin party' and set a password for the admin account:

class {'couchdb':
  admin_password => 'MySecretPassword',
}

For more configuration examples, se the reference section below

Reference

The couchdb class accepts these parameters, all of which are optional.

Parameter: $file_compression

Method used to compress everything that is appended to the database and view index files, except for attachments.
Data type: Enum/Pattern Available options:

  • none
  • snappy
  • deflate_1 - deflate_9

Parameter: $max_dbs_open

This option places an upper bound on the number of databases that can be open at once.
Data type: Ìnteger


Parameter: $max_document_size

Limit maximum document body size.
Data type: Integer


Parameter: $couch_peruser_enable

If set to 'true', couch_peruser ensures that a private per-user database exists for each document in _users.
Data type: Boolean
Available options:

  • true
  • false

Parameter: $couch_peruser_delete

If set to 'true' and a user is deleted, the respective database gets deleted as well.
Data type: Boolean
Available options:

  • true
  • false

Parameter: $default_security

Default security object for databases.
Data type: Enum
Available options:

  • everyone - (Anyone can perform reads and writes)
  • admin_only - (Only admins can read and write)
  • admin_local - (Sharded databases can be read and written by anyone but the shards can only be read and written by admins)

Parameter: $require_valid_user

When set to 'true', no requests are allowed from anonymous users. Everyone must be authenticated.
Data type: Boolean
Available options:

  • true
  • false

Parameter: $bind_address

Defines the IP address by which the clustered port is available.
Data type: String


Parameter: $port

Defines the port number to listen.
Data type: Integer


Parameter: $admin_password

Enables the admin account and sets the admin password. This crashes the 'admin party' (everyone is a admin).
Data type: String


Parameter: $allow_persistent_cookies

Makes cookies persistent if set to 'true'.
Data type: Boolean
Available options:

  • true
  • false

Limitations

This module runs on Ubuntu 18.04.

Dependencies

  • Puppet >= 4.8.0 < 7.0.0
  • puppetlabs/inifile >= 2.3.0 < 2.4.0
  • puppetlabs/stdlib = 5.1.0
  • puppetlabs/apt = 6.1.1

couchdb's People

Contributors

isberg1 avatar mats93 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.