Categorygithub.com/go-kivik/kivikd/v3
modulepackage
3.0.0
Repository: https://github.com/go-kivik/kivikd.git
Documentation: pkg.go.dev

# README

Build Status Codecov Go Report Card GoDoc

Kivikd

Package kivikd aims to provide a CouchDB-compatible daemon, backed by the Kivik v3 suite of drivers. The primary goal is to provide a simple stand-alone server process for testing.

What is the development status?

Kivikd is in early-stage development. Very little functionality is complete.

What license is Kivikd released under?

This software is released under the terms of the Apache 2.0 license. See LICENCE.md, or read the full license.

# Packages

No description provided by the author
Package authdb provides a standard interface to an authentication user store to be used by AuthHandlers.
No description provided by the author
No description provided by the author
Package couchserver aims to provide a CouchDB-compatible HTTP server interface to a kivik.Client.
No description provided by the author
No description provided by the author

# Functions

BindParams binds the request form or JSON body to the provided struct.
GetService extracts the Kivik service from the request.
MustGetSession returns the user context for the currently authenticated user.
StringQueryParam extracts a query parameter as string.

# Constants

DefaultInsecureSecret is the hash secret used if couch_httpd_auth.secret is unconfigured.
DefaultSessionTimeout is the default session timeout, in seconds, used if couch_httpd_auth.timeout is inuset.

# Variables

ClientContextKey is a context key used to access the kivik client.
ServiceContextKey is a context key used to access the serve.Service struct.
SessionKey is a context key used to access the authenticated session.

# Structs

Service defines a CouchDB-like service to serve.