OwnYourData is developed by the non-profit association to promote personal use of data. All elements of it are published under the MIT license and available on Github. If you also want to work on OwnYourData, you will find the necessary information on this page.
Content
OwnYourData’s architecture separates encrypted data storage in the data vault and data processing through plugins as shown in the following figure:
The central element for storing and managing data in OwnYourData is the data vault. It essentially consists of a database and access management via OAuth2. Plugins and services must be registered with a manifest, creating an ID and a secret. A client application (plugin) receives a token after the provision of ID and secret with which access to the data defined in the manifest is possible.
Source code of the data vault: https://github.com/ownyourdata/oyd-pia2
Docker image for data vault: https://hub.docker.com/r/oydeu/oyd-pia2
Swagger API documentation: https://api-docs.ownyourdata.eu/datavault
Note: the internal name PIA for the vault is the abbreviation for “Personal Information Archive”
Data is encrypted in the data vault end-to-end, i.e., all data sources should encrypt any data with the public key when storing data and plugins that process the data require the private key. Detailed documentation for access to the data vault is included in the OwnYourData Smartphone App specification.
Ein Manifest beschreibt ein Plugin und definiert auf welche Daten in welcher Form zugegriffen werden darf. Es ist in JSON und enthält folgende Felder:
name: angezeigter Nameidentifier: eindeutiger, interner Namelanguage: Sprache (de|en)version: Version als ZeichenketteversionNumber: Version als Ganzzahldescription: kurze Beschreibung der App / des Servicesinfo_url: Link zu online Beschreibungpicture: base64 enkodiertes Bild das im Datentresor angezeigt wirdpermissions: Array der Listen (Repos) auf die zugegriffen werden darf; mögliche Zugriffe sind:
read: lesenwrite: schreibenupdate: änderndelete: löschen*: lesen, schreiben, ändern und löschender Syntax für jeden Eintrag ist {Liste}:{Zugriff}; bei der Angabe der Liste ist am Ende das Wildcard * möglich
sources: Array der angebotenen Datenquellen mit folgenden Attributen:
name: angezeigter Nameidentifier: eindeutiger, interner Namedescription: kurze Beschreibung der Datenquelletype: Typ der Datenquelle (pull|push)inactive_duration: Anzahl der Tage ohne Daten bevor eine Warnung ausgegeben werden sollconfig: Konfigurationsmöglichkeiten der Datenquelle:
form: HTML Code zur Darstellung der Konfigurationsoptionenfields: Array mit Namen der Felder in formdefaults: Standardwerte der Konfigurationsparameterrepos: Beschreibung der relevanten Listenanswers: Array der Fragen die mit diesem Plugin beantwortet werden können – Struktur so wie weiter unten beschriebenreports: Array der Einträge in der periodischen Datenzusammenfassung die mit diesem Plugin bereitgestellt werden – Struktur so wie weiter unten beschriebenviews: Array der im Datentresor angezeigten Applikationen mit folgenden Attributen:
name: angezeigter Nameidentifier: eindeutiger, interner Namedescription: kurze Beschreibung der Applikationurl: Webadresse der Applikationdocker: eindeutiger Name des Docker Imagespicture: base64 enkodiertes Bild das im Datentresor angezeigt wirdmobiles: Array der im Datentresor angezeigten Applikationen die nur in der Smartphone App angezeigt werden sollen mit den gleichen Attributen wie viewstasks: Array der periodischen Aufgaben mit folgenden Attributen:
name: angezeigter Nameidentifier: eindeutiger, interner Namecommand: base64 enkodiertes Bash Skript das ausgeführt werden sollschedule: Webadresse der Applikationanswers: Array der Fragen die mit diesem Plugin beantwortet werden können mit folgenden Attributen:
name: angezeigter Nameshort: angezeigter Kurznameidentifier: eindeutiger, interner Namecategory: Text mit frei wählbarer Kategorieinfo_url: Webadresse mit weiterführenden Informationenrepos: Array mit relevanten Listen zur Beantwortung der Fragenanswer_order: numerischer Wert zur aufsteigenden Sortierung aller Antwortenanswer_view: base64 enkodierter Client-seitiger UI code einer Shiny Anwendunganswer_logic: base64 enkodierter Server-seitiger Code einer Shiny Anwendungreports: Array der Einträge in der periodischen Datenzusammenfassung mit folgenden Attributen:
name: angezeigter Name in der Datenzusammenfassungidentifier: eindeutiger, interner Namerepos: Array mit relevanten Listen zur Beantwortung der Frageninfo_url: Webadresse mit weiterführenden Informationendata_prep: base64 enkodiertes Bash Skript das ausgeführt wird um Daten in data_snippet bereitzustellendata_snippet: base64 enkodierter R-code mit Platzhaltern die durch das Skript in data_prep befüllt werdenreport_view: base64 enkodierter R-Markdown code der auf die Variablen in data_snippet zugreifen kannreport_order: numerischer Wert zur aufsteigenden Sortierung der Einträge in der DatenzusammenfassungIn folgendem Github Repository befinden sich Beispiele für die Erstellung eines Manifests: https://github.com/OwnYourData/oyd-manifest
Plugins in OwnYourData provide the functions for collecting, processing and displaying data. To do this, they must log in to the data vault via OAuth2 and then access the data defined in the specified manifest. Access to the vault is demonstrated in tutorials for the following languages:
There is also an R-Package to create Shiny apps for OwnYourData. Use the following applications as a reference for your own developments:
To easily install plugins, manifests can be stored in a plugin provider. These plugins stored there are displayed on the plug-in page of the data vault, depending on the language version. The manifest of your own plugin can also be uploaded.
Source Code for Plugin Provider: https://github.com/ownyourdata/oyd-sam
Note: the internal name SAM for plugin providers is the acronym for “Store for AlgorithMs”
The different components of OwnYourData can be operated on different devices depending on own preferences. This section describes the most common options.
The online data vault at https://data-vault.eu is the simplest and most comfortable way of using OwnYourData. On this page a new account can be requested and after confirmation of the email address the data safe with all extensions are available.
Docker is required to install and run OwnYourData. The data vault is installed on the commandline and requires the following 5 docker images:
A script on Github is available for configuring and starting Docker containers. Run the following command in an empty directory to download and start the script:
bash <(wget -qO- https://raw.githubusercontent.com/OwnYourData/oyd-pia2/master/local/oyd_local_setup.sh)
You have to provide the following four pieces of information:
The data vault is then available under the respective IP address and user accounts can be set up. The following blog posts describe how to use OwnYourData on your own NAS (such as Synology) and on an Asus VivoMini.
For access to the data vault and as a sensor platform there is also a separate app for Android and iOS available.
For Android-based systems there is also the possibility to download the APK file here.
The source code for the mobile data vault (developed with react-native) is available here: https://github.com/OwnYourData/oyd-phoneapp
