publishing under pryv.github.io

Author: Perki

customer-resources/emails-setup/index.html

@@ -114,7 +114,7 @@ <h4 id="using-your-pryvio-domain"><!--using-your-pryvio-domain-->Using your Pryv
 </code></pre>
 <p>In the SPF record above, we declared that Mandrill can be used to send emails on behalf of the domain of our Pryv.io platform.
 You can of course replace Mandrill by the SPF address of the SMTP host(s) of your choice.</p>
-<p>Please refer to <a href="https://api.pryv.com/customer-resources/#guides-and-documents">the DNS configuration document</a> on how to set such SPF record in the Pryv.io DNS.</p>
+<p>Please refer to <a href="https://pryv.github.io/customer-resources/#guides-and-documents">the DNS configuration document</a> on how to set such SPF record in the Pryv.io DNS.</p>
 <h3 id="email-template-default-language"><!--email-template-default-language-->Email template default language</h3>
 <p>You can set the default language for the template that will be applied if you do not provide a <code>language</code> field in the <a href="/reference-system/#create-user">Create user API method</a>, by setting <code>EMAIL_TEMPLATES_DEFAULT_LANG</code>:</p>
 <p>in the platform.yml file:</p>
@@ -132,7 +132,7 @@ <h3 id="welcome"><!--welcome-->Welcome</h3>
 <ul>
 <li>USERNAME</li>
 </ul>
-<pre><code>&lt;img src=&quot;https://api.pryv.com/style/images/logo-256.png&quot; alt=&quot;Logo&quot;&gt; 
+<pre><code>&lt;img src=&quot;https://pryv.github.io/style/images/logo-256.png&quot; alt=&quot;Logo&quot;&gt; 
 &lt;h1&gt;&lt;span style=&quot;color:#bd1026&quot;&gt;Hey&lt;/span&gt; #{USERNAME},&lt;/h1&gt;
 &lt;h2&gt;&lt;span style=&quot;color:#bd1026&quot;&gt;Thanks for creating your Pryv account&lt;/span&gt;&lt;/h2&gt;
 </code></pre>

customer-resources/healthchecks/index.html

@@ -149,7 +149,7 @@ <h3 id="create-token"><!--create-token-->Create token</h3>
 </code></pre>
 <p>If you are using a default configuration, you can use the default web app:</p>
 <ol>
-<li>Go to https://api.pryv.com/app-web-access/?pryvServiceInfoUrl=https://reg.${DOMAIN}/service/info (https://api.pryv.com/app-web-access/?pryvServiceInfoUrl=https://${HOSTNAME}/reg/service/info for DNS-less)</li>
+<li>Go to https://pryv.github.io/app-web-access/?pryvServiceInfoUrl=https://reg.${DOMAIN}/service/info (https://pryv.github.io/app-web-access/?pryvServiceInfoUrl=https://${HOSTNAME}/reg/service/info for DNS-less)</li>
 <li>Click on <code>Master Token</code>radio button</li>
 <li>Click on <code>Request Access</code> button</li>
 <li>Click on <code>Sign in</code> Pryv button</li>

customer-resources/index.html

@@ -7,7 +7,7 @@
 <h2 id="documents"><!--documents-->Documents</h2>
 <ul>
 <li>
-<p>Functional Requirement Specification: <a href="/functional-specifications/">api.pryv.com/functional-specifications</a></p>
+<p>Functional Requirement Specification: <a href="/functional-specifications/">pryv.github.io/functional-specifications</a></p>
 <p>Functional specifications for the Pryv.io middleware system: the capabilities and functions that the system must be capable of performing.</p>
 </li>
 <li>
@@ -18,7 +18,7 @@ <h2 id="documents"><!--documents-->Documents</h2>
 <h2 id="files"><!--files-->Files</h2>
 <ul>
 <li>
-<p>Pryv.io configuration files: <a href="https://api.pryv.com/config-template-pryv.io/">HTML</a></p>
+<p>Pryv.io configuration files: <a href="https://pryv.github.io/config-template-pryv.io/">HTML</a></p>
 <p>Configuration files to install Pryv.io (requires Pryv license and docker key).</p>
 </li>
 </ul>

customer-resources/pryv.io-setup/index.html

@@ -81,7 +81,7 @@ <h3 id="verify"><!--verify-->Verify</h3>
 ${YOUR-DOMAIN}.		SOME_TTL_VALUE	IN	NS	dns2-pryv.${YOUR-DOMAIN}.
 </code></pre>
 <h2 id="obtain-the-license-key-credentials-and-configuration-files"><!--obtain-the-license-key-credentials-and-configuration-files-->Obtain the license key, credentials and configuration files</h2>
-<p>In order to be able to run your Pryv.io 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, which you can download <a href="https://api.pryv.com/config-template-pryv.io/">here</a>.</p>
+<p>In order to be able to run your Pryv.io 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, which you can download <a href="https://pryv.github.io/config-template-pryv.io/">here</a>.</p>
 <h2 id="set-the-platform-parameters"><!--set-the-platform-parameters-->Set the platform parameters</h2>
 <p>Along with the configuration files, you will find an Installation guide describing where to unpack them and how to set the platform variables.</p>
 <h2 id="obtain-an-ssl-certificate"><!--obtain-an-ssl-certificate-->Obtain an SSL certificate</h2>
@@ -154,7 +154,7 @@ <h2 id="customize-event-types-validation"><!--customize-event-types-validation--
 <p>Your Pryv.io platform performs content validation for the types definition that you provide it. Events with undefined types are allowed but their content is not validated.</p>
 <p>See the <a href="/event-types/">Event Types</a> page for more information.</p>
 <p>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:</p>
-<pre><code class="language-yaml">EVENT_TYPES_URL: &quot;https://api.pryv.com/event-types/flat.json&quot;
+<pre><code class="language-yaml">EVENT_TYPES_URL: &quot;https://pryv.github.io/event-types/flat.json&quot;
 </code></pre>
 <h2 id="other-documents"><!--other-documents-->Other documents</h2>
 <p>More resources can be found in our <a href="/customer-resources/#guides-and-documents">customer resources page</a>, or in the <a href="/faq-infra/">FAQ</a>.</p>

customer-resources/single-node-to-cluster/index.html

@@ -15,7 +15,7 @@ <h2 id="table-of-contents-"><!--table-of-contents--->Table of contents <!-- omit
 <h2 id="optional-create-users-with-specific-data-on-source-for-post-migration-verification"><!--optional-create-users-with-specific-data-on-source-for-post-migration-verification--><em>(Optional)</em> Create user(s) with specific data on source for post-migration verification</h2>
 <p>Generate a few events and streams by hand for a naked eye comparison for data transferred after the migration.</p>
 <h2 id="adapt-platform-parameters"><!--adapt-platform-parameters-->Adapt platform parameters</h2>
-<p>Fetch cluster configuration files for the same version <a href="https://api.pryv.com/config-template-pryv.io/">here</a>. Extract them, and edit the <code>config-leader/conf/template-platform.yml</code> (<code>platform.yml</code> for versions prior to 1.7).</p>
+<p>Fetch cluster configuration files for the same version <a href="https://pryv.github.io/config-template-pryv.io/">here</a>. Extract them, and edit the <code>config-leader/conf/template-platform.yml</code> (<code>platform.yml</code> for versions prior to 1.7).</p>
 <p>The difference between a single and cluster lies in the &#x201C;Machines and platform settings&#x201D; section.</p>
 <ol>
 <li>

customer-resources/ssl-certificate/index.html

@@ -26,7 +26,7 @@ <h2 id="table-of-contents-"><!--table-of-contents--->Table of contents <!-- omit
 </li>
 </ol>
 <h2 id="automatic-generation-with-pryvio-174-or-later"><!--automatic-generation-with-pryvio-174-or-later-->Automatic generation with Pryv.io 1.7.4 or later</h2>
-<p>If you are running Pryv.io 1.7.4 or later, you can simply run the <code>renew-ssl-certificate</code> script provided with <a href="https://api.pryv.com/config-template-pryv.io/">the configuration files</a> to generate a SSL certificate for your Pryv.io platform.</p>
+<p>If you are running Pryv.io 1.7.4 or later, you can simply run the <code>renew-ssl-certificate</code> script provided with <a href="https://pryv.github.io/config-template-pryv.io/">the configuration files</a> to generate a SSL certificate for your Pryv.io platform.</p>
 <p>Note: from version 1.9.0 it&#x2019;s required to set a valid email address in the configuration file <code>config-leader/ssl/conf/ssl-certificate.yml</code></p>
 <p>Otherwise, follow this guide.</p>
 <h3 id="dns-check-failure-error-servers-are-not-reachable"><!--dns-check-failure-error-servers-are-not-reachable-->DNS check failure: Error: Servers are not reachable</h3>
@@ -70,7 +70,7 @@ <h3 id="generate-certificate-using-dns-validation"><!--generate-certificate-usin
     name: &quot;DNS settings&quot;
     settings:
       DNS_CUSTOM_ENTRIES:
-        description: &quot;Additional DNS entries. See the DNS configuration document: https://api.pryv.com/customer-resources/#guides-and-documents.
+        description: &quot;Additional DNS entries. See the DNS configuration document: https://pryv.github.io/customer-resources/#guides-and-documents.
         Can be set to null if not used.&quot;
         value:
           _acme-challenge:

external-resources/index.html

@@ -22,10 +22,10 @@ <h3 id="example-web-apps"><!--example-web-apps-->Example web apps</h3>
 </ul>
 <h3 id="auth-web-app"><!--auth-web-app-->Auth web app</h3>
 <p>&#x2794; <a href="https://github.com/pryv/app-web-auth3">GitHub</a></p>
-<p>Handling registration, <a href="https://api.pryv.com/reference/#authenticate-your-app">auth requests</a>, password reset and email change</p>
+<p>Handling registration, <a href="https://pryv.github.io/reference/#authenticate-your-app">auth requests</a>, password reset and email change</p>
 <h3 id="multi-factor-authentication-app"><!--multi-factor-authentication-app-->Multi-Factor Authentication app</h3>
 <p>&#x2794; <a href="https://github.com/pryv/app-web-mfa">GitHub</a></p>
-<p>Handles the <a href="https://api.pryv.com/reference/#multi-factor-authentication">MFA flow</a>.</p>
+<p>Handles the <a href="https://pryv.github.io/reference/#multi-factor-authentication">MFA flow</a>.</p>
 <h2 id="ios"><!--ios-->iOS</h2>
 <h3 id="swift-library"><!--swift-library-->Swift library</h3>
 <p>&#x2794; <a href="https://github.com/pryv/lib-swift">GitHub</a></p>

faq-api/index.html

@@ -43,7 +43,7 @@ <h3 id="can-i-limit-the-number-of-event-types-to-be-used-in-a-stream-"><!--can-i
 <p>There is no limitation in terms of event types per stream. A stream acts like a &#x201C;folder&#x201D; in which you can put any type of information.
 If you wish to give a Pryv access token to an external service and to control its use of the access, you can give it a &#x201C;limited&#x201D; access type - <code>create-only</code> - which allows it to <strong>only</strong> create events in the streams (more information on the different permission levels <a href="/reference/#access">here</a>).</p>
 <h3 id="are-my-events-content-validated"><!--are-my-events-content-validated-->Are my events content validated?</h3>
-<p>The default set of validated types is defined in <a href="/event-types/">https://api.pryv.com/event-types</a>, they are validated upon creation and modification. To validate custom types, it is possible to provide a different source of event types, following the <a href="/event-types/#format-specification">JSON schema format</a>.</p>
+<p>The default set of validated types is defined in <a href="/event-types/">https://pryv.github.io/event-types</a>, they are validated upon creation and modification. To validate custom types, it is possible to provide a different source of event types, following the <a href="/event-types/#format-specification">JSON schema format</a>.</p>
 <h3 id="what-kind-of-validation-do-you-perform"><!--what-kind-of-validation-do-you-perform-->What kind of validation do you perform?</h3>
 <p>Depending on the <code>type</code> field of the event, the content of the fields <code>content</code> and <code>attachments</code> are validated.</p>
 <h2 id="other-data-structures"><!--other-data-structures-->Other data structures</h2>

faq-infra/index.html

@@ -27,7 +27,7 @@ <h3 id="what-constraints-should-be-considered-when-choosing-a-host"><!--what-con
 <h3 id="how-do-you-address-encryption-of-the-data-at-rest-as-medical-records-will-be-stored-in-mongodb-are-you-using-db-encryption-or-some-other-application-specific-encryption"><!--how-do-you-address-encryption-of-the-data-at-rest-as-medical-records-will-be-stored-in-mongodb-are-you-using-db-encryption-or-some-other-application-specific-encryption-->How do you address encryption of the data at rest? As medical records will be stored in MongoDB, are you using DB encryption or some other application specific encryption?</h3>
 <p>Pryv offers three options here:</p>
 <ul>
-<li>Application-level end-to-end encryption: your application(s) that will access Pryv.io encrypt the data before sending it and can decrypt it after reading it back. Pryv.io provides a data type to include metadata concerning the encryption used by your application. See: <a href="http://api.pryv.com/event-types/#encrypted">http://api.pryv.com/event-types/#encrypted</a></li>
+<li>Application-level end-to-end encryption: your application(s) that will access Pryv.io encrypt the data before sending it and can decrypt it after reading it back. Pryv.io provides a data type to include metadata concerning the encryption used by your application. See: <a href="http://pryv.github.io/event-types/#encrypted">http://pryv.github.io/event-types/#encrypted</a></li>
 <li>Disk encryption: Linux has a solid story of disk encryption. If stored on such a disk, Pryv data is encrypted at rest as well.</li>
 </ul>
 <p>The last option will probably the easiest to implement. It offers good protection against disks being stolen from the datacenter, while not increasing overall system complexity by much.</p>