Customer Resources

In this space you will find documents, files and guides for the installation and support of the Pryv.io enterprise version.

In February 2025, the closed-sourced version of Pryv.io was released under BSD-3-Clause license. Open-Pryv.io and the Enterprise version share the same codebase but are substantially different to be kept alongside. The name “Enterprise version”, is kept to distinguish the two distributions.

The source code of the different Entreprise version components:

• service-core: Main API component
• service-register: Register and DNS
• service-mail: E-mail & template service
• service-mfa: Mutli-factor authentication service
• service-config-leader: Configuration management centralization
• service-config-follower: Subscribe to config-leader
• service-ssl-certificate: Let’s encrypt automated certificate request

Documents

• Functional Requirement Specification: pryv.github.io/functional-specifications

  Functional specifications for the Pryv.io middleware system: the capabilities and functions that the system must be capable of performing.

• Tests Results: tests

  Result of tests suite on service-core for the latest Pryv.io version

Files

• Pryv.io configuration files: HTML

  Configuration files to install Pryv.io Entrepise Version.

Guides

• Pryv.io platform setup guide: HTML

• Infrastructure procurement (Previously “Deployment design guide”): HTML

  This document describes how to deploy a Pryv.io platform as well as essential information to help you decide on your infrastructure and sizing needs. You will also find information about how to operate your Pryv.io platform.

• Generate SSL certificate: HTML

  This document describes how to obtain a wildcard SSL certificate for your running Pryv.io platform using Let’s Encrypt.

• Installation validation: HTML

  This document describes the steps to validate that a Pryv.io platform is up and running after deployment.

• System monitoring: HTML

  This document describes the steps to perform regular healthchecks on a running Pryv.io platform.

• System streams: HTML

  This document describes how to setup and configure your platform’s system streams.

• DNS configuration: HTML

  This document describes how to add entries in your Pryv.io associated domain DNS zone.

• Emails configuration: HTML

  This document describes how to configure the sending of Pryv.io emails for welcoming new users or resetting lost passwords.

• Audit configuration: HTML

  This document describes how to setup audit capabilities for your Pryv.io platform.

• Core migration: HTML

  This document describes how to migrate a Pryv.io core service to a different machine.

• Register migration: HTML

  This document describes how to migrate a Pryv.io register service to a different machine.

• Single-node to Cluster upgrade: HTML

  This document describes how to upgrade a Pryv.io single-node installation to a cluster one.

• (deprecated) User deletion: PDF

  This document presents a tool which allows to delete Pryv.io users. From Pryv.io 1.6, user deletion is available through the admin API

• How to backup: HTML

  This document describes how to perform a backup of your Pryv.io platform and how to restore it.

• MFA configuration: HTML

  This document describes how to enable and configure multi-factor authentication on top of the Pryv.io login.

Contact and support

You can get in touch with Pryv’s support at Open Pryv - Issues and question