3.4. couch_peruser — Apache CouchDB® 3.2 Documentation

# 3.4. couch_peruser

## 3.4.1. couch_peruser Options

`[couch_peruser]`
  `enable`

  If set to `true`, couch_peruser ensures that a private per-user database exists for each document in `_users`. These databases are writable only by the corresponding user. Databases are in the following form: `userdb-{hex encoded username}`.

      [couch_peruser]
      enable = false

  Note

  The `_users` database must exist before couch_peruser can be enabled.

  `delete_dbs`

  If set to `true` and a user is deleted, the respective database gets deleted as well.

      [couch_peruser]
      delete_dbs = false

  Note: When using JWT authorization, the provided token must include a custom `_couchdb.roles=['_admin']` claim to for the peruser database to be properly created and accessible for the user provided in the `sub=` claim.

  `q`

  If set, specify the sharding value for per-user databases. If unset, the cluster default value will be used.

  > [couch_peruser] q = 1