Riposo is a JSON document store written in Go, based on the design of Kinto. It implements v1.22 of the Kinto API and aims to be fully compatible with the client libraries kinto-http.js, kinto-http.py as well as higher-level, offline-first abstraction kinto.js.

The easiest way to deploy Riposo is via Docker.

To launch a test instance (on port 8888):

docker run --rm -p 8888:8888 riposo/riposo server

You can use environment variables to configure all aspects of your instance, including persistence. For more information, please see the Configuration section.

docker run --rm \
    -e RIPOSO_STORAGE_URL=postgres://postgres:postgres@database/riposo?timezone=UTC \
    -e RIPOSO_PERMISSION_URL=postgres://postgres:postgres@database/riposo?timezone=UTC \
    -e RIPOSO_CACHE_URL=postgres://postgres:postgres@database/riposo?timezone=UTC \
    riposo/riposo:0.1.0 server

Plugins can also be loaded dynamically by referencing the plugin ID. In order to enable a plugin, the server binary must have been built with it. For more information, please see the Plugins section.

# list plugins
docker run --rm riposo/riposo plugins

# run server with plugins
docker run --rm \
    -v $(pwd):/data
    -e RIPOSO_PLUGINS=accounts,default-bucket \
    -e RIPOSO_PERMISSION_DEFAULTS='{"account:create":[system.Everyone], "bucket:create":[system.Authenticated]}' \
    riposo/riposo server

The server instance can be configured via environment variables or an optional YAML configuration file which can be passed via -config flag.

Environment variable names must be prefixed by RIPOSO_ and can be inferred by capitalising the option name and replacing . with _. Examples:

# Set project.version
RIPOSO_PROJECT_VERSION=0.9.1

# Adjust server.shutdown_timeout
RIPOSO_SERVER_SHUTDOWN_TIMEOUT=30s

# Set permission defaults
RIPOSO_PERMISSION_DEFAULTS='{"bucket:create":[system.Authenticated], "other":[comma,separated,principals]}'

ID factories are used to generate random, non-colliding, human-readable IDs for records in the system. The two built-in methods are:

• nanoid - tiny, secure, URL-friendly, unique, see Nano ID
• uuid - v4 of the universally unique identifier, see Wikipedia

Backends can be configured through URLs By default, your server comes with support for two data backends:

• :memory: - purely in-memory, only use this for testing
• postgres:// - PostgreSQL support, use this for production

Additional backends are available as plugins.

Authentication methods are available as plugins. By default only basic auth is supported but additional methods are available as plugins.

Default permissions will take precedence over those stored permanently in the permission backend. For example:

permission:
  defaults:
    # Allow all users to create new accounts
    account:create: [system.Everyone]
    # Allow authenticated users to create buckets
    bucket:create: [system.Authenticated]
    # Allow admin user to read all buckets
    bucket:read: [account:admin]
    # Grant admin user full access
    write: [account:admin]

The equivalent setting as env variable would be:

RIPOSO_PERMISSION_DEFAULT='{ account:create: [system.Everyone], bucket:create: [system.Authenticated], bucket:read: [account:admin], write: [account:admin] }'

Plugins can be loaded at runtime by referencing them via RIPOSO_PLUGINS environment variable. To see a list of bundled plugins, please run riposo plugins. By default, the following plugins are available:

• accounts
• default-bucket
• flush

To build a custom release with additional plugins, please see instructions on the cmd page. More plugins are available on GitHub.

Copyright 2021 Black Square Media Ltd

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this material except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.