Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cheminfo/rest-on-couch
Interface to couchDB with user rights management
https://github.com/cheminfo/rest-on-couch
couchdb
Last synced: 5 days ago
JSON representation
Interface to couchDB with user rights management
- Host: GitHub
- URL: https://github.com/cheminfo/rest-on-couch
- Owner: cheminfo
- License: mit
- Created: 2015-11-24T09:34:30.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T08:39:56.000Z (about 2 months ago)
- Last Synced: 2024-09-18T11:26:26.539Z (about 2 months ago)
- Topics: couchdb
- Language: JavaScript
- Homepage: https://github.com/cheminfo/rest-on-couch/blob/main/API.md
- Size: 8.95 MB
- Stars: 13
- Watchers: 5
- Forks: 2
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - cheminfo/rest-on-couch - Interface to couchDB with user rights management (others)
README
# rest-on-couch
[![NPM version][npm-image]][npm-url]
[![build status][ci-image]][ci-url]
[![codecov][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
Interface to CouchDB that allows the control of permissions on the documents.
## REST API
[API documentation](API.md)
## Configuration
The configuration is being read on load from many sources, in the following order (ascending priority):
1. Default configuration. Some configuration elements have default values. They are defined in the [source code](./src/config/default.js)
2. Main configuration file (`config.js` or `config.json` in ROC's home directory)
3. Database configuration file (`config.js` in database's subdirectory)
4. Environment variable (uppercase snake-case with `REST_ON_COUCH_` prefix)
5. Custom config file passed with `--config` in the CLI
### Main options
#### url
Type: string
Default: `'http://localhost:5984'`
URL of the CouchDB server.
#### username
Type: string
Default: `undefined`
Username for CouchDB connection.
#### password
Type: string
Default: `undefined`
Password for CouchDB connection.
#### logLevel
Type: string
Default: `'WARN'`
Level of the logs stored in the database. Possible values are FATAL (1), ERROR (2), WARN (3), INFO (4), DEBUG (5) and TRACE (6).
Logs are only inserted if the current level is equal or higher to the log's level.
#### authRenewal
Type: number
Default: `570`
Time in seconds that the application waits before revalidating the session with CouchDB.
This number should be smaller than the session's cookie life.
### Server options
#### port
Type: number
Default: `3000`
Port used by the rest-on-couch server.
#### auth
Type: object
Default: `{couchdb:{}}`
Object describing the authentication strategies that are available and providing options to them.
#### proxy
Type: boolean
Default: `true`
Set to `true` if your application is behind a proxy and needs to trust `X-Forwarded-` headers.
#### proxyPrefix
Type: string
Default: `'/'`
If the proxy is not at the root level of the URL, set this value to the corresponding prefix.
#### allowedOrigins
Type: array\
Default: `[]`
If cross-origin calls need to be done, set the list of trusted origins here.
#### sessionDomain
Type: string
Default: `undefined`
Domain of the session cookie.
#### sessionKey
Type: string
Default: `'roc:sess'`
Key of the session cookie.
#### sessionPath
Type: string
Default: `'/'`
Path of the session cookie.
#### sessionSecure
Type: boolean
Default: `false`
Set to `true` if the cookie should only be valid on secure URLs.
#### sessionSameSite
Type: string
Default: `'lax'`
Value of the ["SameSite"](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite) cookie option. Set to `'strict'`, `'lax'`, or `'none'`.
#### debugrest
Type: boolean
Default: `false`
If set to `true`, a stack trace will be print to the body of the response when an error occurs.
Do not use this in production!
### Zenodo options
#### zenodo
Type: boolean
Default: `false`
If set to `true`, enables the Zenodo API.
#### zenodoName
Type: string
Name of this application/database. This will be used in the keywords for each
entry that is created. For example, if `zenodoName` is `'db123'`, entries will
contain the keyword `'from:db123'`.
This option is mandatory if `zenodo` is `true`.
#### zenodoToken
Type: string
API token for Zenodo.
This option is mandatory if `zenodo` is `true`.
#### zenodoSandboxToken
Type: string
API token for Zenodo's sandbox.
#### zenodoVisualizationUrl
Type: string
URL prefix for entry visualization. If set, the Zenodo entry ID will be appended
to this, optionally with a `?sandbox=1` query string. A link will be added at the
end of the entry's description.
#### zenodoReadme
Type: string
Default contents of the `_README.md` that is published in the Zenodo entry.
#### zenodoAttachments
Type: function
Function that is called with each ROC entry's contents and must return a list of
attachments to add to the Zenodo entry. It can also return an object if a single
attachment is to be added
```js
function zenodoAttachments(content) {
if (content.general && content.general.molfile) {
return {
filename: 'molfile.mol',
contentType: 'chemical/x-mdl-molfile',
data: content.general.molfile,
};
} else {
return [];
}
}
```
## Setup environment with Docker (for running tests)
```bash
docker-compose up -d
```
Go to http://localhost:5984/\_utils/#setup
- Single node
- username: admin, password: admin
- bind address: 0.0.0.0
- Execute the bash script `/setupDatabase.sh`
- Execute the tests: `npm t`
## Automatic importation
`rest-on-couch` is able to watch folders and to automatically import data in the database.
A specific userguide is available [here](import.md).
## License
[MIT](./LICENSE)
[npm-image]: https://img.shields.io/npm/v/rest-on-couch.svg
[npm-url]: https://www.npmjs.com/package/rest-on-couch
[ci-image]: https://github.com/mljs/matrix/workflows/Node.js%20CI/badge.svg?branch=main
[ci-url]: https://github.com/mljs/matrix/actions?query=workflow%3A%22Node.js+CI%22
[codecov-image]: https://codecov.io/gh/cheminfo/rest-on-couch/branch/main/graph/badge.svg?token=Uw2cOqZUg0
[codecov-url]: https://codecov.io/gh/cheminfo/rest-on-couch
[download-image]: https://img.shields.io/npm/dm/rest-on-couch.svg
[download-url]: https://www.npmjs.com/package/rest-on-couch