platform setup guide

In this guide we address IT operators that wish to install their platform. It walks you through the different steps that have to be performed in order to set up your platform.

Table of contents

Set up the machines

You need first to define which hardware or virtual machines you will provision to host your instance.

The Infrastructure procurement guide for the middleware from the Customer Resources page will guide you for the provisioning and deployment of your machines.

It will help you with the choice of your deployment (single node or cluster), and provide you with resources sizing considerations.

The system requirements for each machine are also specified.

Obtain a domain name

Now that your machines are ordered, you need to register your own domain name.

You can either:

You will have to define the following DNS Records:

dns2-pryv 1800 IN A ${YOUR-REG-SLAVE-IP-ADDRESS}
pryv 1800 IN NS dns1-pryv.${YOUR-DOMAIN}.
pryv 1800 IN NS dns2-pryv.${YOUR-DOMAIN}.

Your platform domain will then be pryv.${YOUR-DOMAIN}. For other environments such as staging, we suggest to define a similar subdomain:

dns1-pryv-staging 1800 IN A ${YOUR-REG-MASTER-IP-ADDRESS}
dns2-pryv-staging 1800 IN A ${YOUR-REG-SLAVE-IP-ADDRESS}
pryv-staging 1800 IN NS dns1-pryv.${YOUR-DOMAIN}.
pryv-staging 1800 IN NS dns2-pryv.${YOUR-DOMAIN}.

Expose the API on a second-level domain

Using the aforementioned steps, your API will be exposed under a subdomain like pryv.${YOUR-DOMAIN}. If you wish to expose it on a second-level domain such as, you will have to:

Second domain DNS Zone ${SECOND-DOMAIN}:

dns2-pryv 1800 IN A ${YOUR-REG-SLAVE-IP-ADDRESS}

You will then define name servers for your domain as:


If your domain is set up correctly, the following command should yield the hostname of the machine(s) you intend to use as a Register server:

dig NS +trace +nodnssec ${DOMAIN}

This command should yield the hostnames you have set for the name servers of your domain in the last block as:

${YOUR-DOMAIN}.        SOME_TTL_VALUE    IN    NS    dns1-pryv.${YOUR-DOMAIN}.
${YOUR-DOMAIN}.        SOME_TTL_VALUE    IN    NS    dns2-pryv.${YOUR-DOMAIN}.

Obtain the license key, credentials and configuration files

In order to be able to run your instance, you will need to get a license key for your platform from Pryv and the credentials to pull the Docker images defined in the configuration files.

Set the platform parameters

Along with the configuration files, you will find an Installation guide describing where to unpack them and how to set the platform variables.

Obtain an SSL certificate

You will need to obtain a wildcard SSL certificate for *.DOMAIN to enable encryption to the platform's API. For this, you can either obtain one from your hosting provider, or generate one using Let's Encrypt.

We have automatic SSL certificate renewal on our roadmap, so let us know if you are interested.

If you are using an infrastructure with appliances that perform the SSL termination, you can simply adapt the NGINX configuration files to listen on port 80 and not perform encryption.

Validate your platform installation

Now that your platform is configured and running, you can run the validation procedure from the platform validation guide.

It will walk you through the validation steps of your platform and contains a troubleshooting part in case of issue.

Set up the platform health monitoring

You can monitor its status by setting up regular healthcheck API calls to the API.

The procedure for the platform health monitoring is described in the Healthchecks guide.

Customize authentication, registration and reset password apps

In order to perform the authentication procedure, a web page is necessary. We deliver platforms with a web app for this as well as for other functions such as registration and password reset. You can find the code repository on

In order to customize your own, we suggest that you fork this repository and host the web app on your environment. The easiest way to begin is to fork it on GitHub and host it using GitHub-pages.

To use your own page, you will have to update the following platform variables:

You will then need to provide your web page's URL in the Auth request authUrl parameter, or if you want to make it default, change the DEFAULT_AUTH_URL in the platform variables.

Or if you wish to proxy your custom app-web-auth3 app through the https://sw.DOMAIN/access/... URL, you will only need to change the APP_WEB_AUTH_URL instead of all other changes.

GH pages

Make sure to implement the following change on your fork.

If you are hosting it on GitHub pages, you will need to adapt the platform variables as following:

  TRUSTED_APPS: "*@https://*.DOMAIN*, *@*, *@*"
    - "https://sw.DOMAIN/access/access.html"
    - ""

If you wish to make it default, set:


or if you wish to proxy it through https://sw.DOMAIN/access/, only set:


Your own server

If you are hosting it on your own server, you will need to adapt the platform variables as following:

  TRUSTED_APPS: "*@https://*.DOMAIN*, *@*, *@https://YOUR-SERVER-DOMAIN*"
    - "https://sw.DOMAIN/access/access.html"
    - "https://YOUR-SERVER-URL/access/access.html"
  PASSWORD_RESET_URL: "https://YOUR-SERVER-URL/access/reset-password.html"

If you wish to make it default, set:

  DEFAULT_AUTH_URL: "https://YOUR-SERVER-URL/access/access.html"

or if you wish to proxy it through https://sw.DOMAIN/access/, only set:


Set up email sending allows to send emails in two situations:

You might want to install and configure the sending of emails in these situations. You can do so by either using your SMTP server, or Sendmail.

In both cases, you will need to customize settings in the "Email configuration" section of the platform parameters file.

You can also customize the email templates in the configuration files.

More details are provided in the Emails configuration guide that can be found in the Customer Resources section.

Define your data model

As your platform is fully operational, you can start collecting data.

To do so, you need to design the data model your app(s) will use using Pryv's data structures: streams and events.

You can have a look at our Data modelling guide which describes the data structure and walks you through different use cases for your data model. We provide you with an Excel template file describing a basic use case.

We advise you to build your own file based on this template to describe your own data structure (streams, events, permissions) depending on your use case.

We can also help you with the design and validation of your data model.

Customize event types validation

Your platform performs content validation for the types definition that you provide it. Events with undefined types are allowed but their content is not validated.

See the Event Types page for more information.

You can host your definitions page on a public URL which will be loaded at the platform boot. You can define this URL in the platform parameters as following:


Other documents

More resources can be found in our Customer Resources page, or in the FAQ.