Components

Every service, middleware, and driver in reva, generated from the source code.

Reva is a set of plugins compiled into one binary, revad. A configuration file picks which services run in a process and which driver each one uses. These pages are generated from the source code, so they list exactly what a build contains.

gRPC services

Services that implement the CS3 APIs. The gateway is the entry point; the others are providers it routes to.

HTTP services

Services that expose reva over HTTP: WebDAV, OCS, Graph, OCM, data transfer, and more.

HTTP middlewares

Handlers that wrap every HTTP request: authentication, CORS, logging, tracing.

gRPC interceptors

Handlers that wrap every gRPC call.

Serverless services

Services that run in the background without a listener: jobs, notifications, reconciliation.

Drivers

Pluggable back ends. A service picks one driver per family in its configuration.

Apps

App providers

Authentication

App password managers

Auth managers

Auth registries

HTTP credential strategies

HTTP token strategies

HTTP token writers

Login flow stores

Signed URL strategies

Token managers

Core

Service registries

Federation (OCM)

Data transfer managers

Data transfer repositories

OCM invite repositories

OCM provider authorizers

OCM share repositories

Rclone transfer repositories

Operations

Prometheus collectors

Sharing

Permission managers

Public share managers

Share cache warmers

Share caches

Share managers

Storage

Project space managers

Storage drivers

Storage registries

Upload protocols

User settings

Label stores

Preference stores

Users and groups

Group managers

User managers

Libraries

Shared packages that are not plugins but have their own documentation or configuration.

Other documented packages

Packages with a doc comment but no settings. Their documentation is on the Go reference.

internal/grpc/controlImplements the per-process control channel (reva.control.v1beta1): a gRPC service that … internal/grpc/services/gateway/ratelimitersHolds the rate limiters the gateway applies to the PublishEvent flow, keyed by the … internal/http/services/owncloud/ocs/conversionsSits between CS3 type definitions and OCS API Responses internal/http/services/owncloud/ocs/handlers/cloud/capabilitiesContains the capabilities handler. internal/http/services/owncloud/ocs/handlers/cloud/usersContains the users handler. pkg/activityTracks one service instance's request activity: how many requests are in flight right now, … pkg/adminHolds the primitives specific to the reva Admin API: the audit helper and the service … pkg/appauth/loginflowHolds the persistent state for the login flow. pkg/auth/scope/ocmshareReads code-flow OCM share scopes without importing the parent scope package or the JWT … pkg/errtypesContains definitions for common errors. pkg/invokeThe process-wide invocation framework: services opt into the Invokable capability, and … pkg/invoke/clientResolves invocation targets through the service registry and runs invocations over the … pkg/logtailKeeps a bounded, in-memory ring of a process's recent log lines, with a live tap for … pkg/messagequeueHolds the shared message-queue infrastructure used across Reva, such as the resilient NATS … pkg/notifications/accumulationStores accepted notification events that share a deduplication key and coordinates, … pkg/ocm/clientProvides shared HTTP transports for outbound OCM calls. pkg/ocm/httpsigImplements the OCM profile of RFC 9421 HTTP Message Signatures. pkg/ocm/invite/repository/internal/contracttestHolds the shared behavioral suite for invite repository adapters. pkg/ocm/launcherRenders the page that hands a user over to a web application with a POST request. pkg/openapiDescribes a reva deployment's HTTP surface as an OpenAPI document, built from the routes … pkg/permissionsSits between CS3 type definitions and OCS API Responses pkg/rgrpc/mtlsBuilds the credentials for mutual TLS between reva's gRPC services. pkg/rgrpc/statusContains helpers functions to create grpc Status with contextual information, like traces. pkg/rhttp/datatxProvides a library to abstract the complexity of using various data transfer protocols. pkg/rhttp/datatx/utils/downloadProvides a library to handle file download requests. pkg/rhttp/routerThe HTTP routing API reva services use to declare the URLs they serve. pkg/rjobsProvides a framework to run background work in reva, both periodically and once on demand. pkg/rjobs/store/natsImplements the rjobs.Store on top of NATS JetStream. pkg/rjobs/store/sqlImplements the rjobs.StatusStore on top of a relational database via GORM. pkg/rjobs/store/sql/modelHolds the GORM model for the SQL job status store. pkg/rversionHolds reva's build/version metadata. pkg/serviceHosts the registry-backed peer resolver embedded by every reva service across all … pkg/sharehierarchyImplements the hierarchical share consistency algorithm described in ADR-0005-P01. pkg/statsDefines the self-describing statistics payload a service can expose through its `stats` … pkg/storage/registry/dynamic/rewriterContains the route rewriters pkg/storage/registry/dynamic/routingtreeContains the routing tree implementation. pkg/storage/registry/utilsContains utilities for storage registries pkg/storage/utils/templatesContains data-driven templates for path layouts.