README
¶
Cozy DISPERS
⚠️ This is a POC that might dramatically evolve in the future.
What is Cozy-DISPERS
It is the core server of the Cozy-DISPERS platform.
Cozy-DISPERS is in charge of serving a query over a list of stacks. This process is a privacy-by-design algorithm.
It provides its services through a REST API that allows to:
- subscribe, or unsubscribe to queries
- launch a query or even a machine learning algorithm
Five actors are available:
- Conductor
- Concept Indexor
- Target Finder
- Target
- Data Aggregator
Feel free to open an issue for questions and suggestions.
Installing cozy-dispers
It is quite like installing a cozy-stack
You can follow the Install guide and the configuration documentation.
How to contribute?
We are eager for contributions and very happy when we receive them! It can code, of course, but it can also take other forms. The workflow is explained in the contributing guide.
What is Cozy?
Cozy is a platform that brings all your web services in the same private space. With it, your web apps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one profiles you.
Community
You can reach the Cozy Community by:
- Chatting with us on IRC #cozycloud on irc.freenode.net
- Posting on our Forum
- Posting issues on the Github repos
- Mentioning us on Twitter
License
Cozy is developed by Cozy Cloud and distributed under the AGPL v3 license.
Documentation
¶
Overview ¶
Cozy Cloud is a personal platform as a service with a focus on data. Cozy Cloud can be seen as 4 layers, from inside to outside:
1. A place to keep your personal data
2. A core API to handle the data
3. Your web apps, and also the mobile & desktop clients
4. A coherent User Experience
It's also a set of values: Simple, Versatile, Yours. These values mean a lot for Cozy Cloud in all aspects. From an architectural point, it declines to:
- Simple to deploy and understand, not built as a galaxy of optimized microservices managed by kubernetes that only experts can debug.
- Versatile, can be hosted on a Raspberry Pi for geeks to massive scale on multiple servers by specialized hosting. Users can install apps.
- Yours, you own your data and you control it. If you want to take back your data to go elsewhere, you can.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
browser
Package browser provides utilities for interacting with users' browsers.
|
Package browser provides utilities for interacting with users' browsers. |
|
model
|
|
|
pkg
|
|
|
jsonapi
Package jsonapi is for using the JSON-API format: parsing, serialization, checking the content-type, etc.
|
Package jsonapi is for using the JSON-API format: parsing, serialization, checking the content-type, etc. |
|
statik
Package contains a program that generates code to register a directory and its contents as zip data for statik file system.
|
Package contains a program that generates code to register a directory and its contents as zip data for statik file system. |
|
statik/fs
Package fs contains an HTTP file system that works with zip contents.
|
Package fs contains an HTTP file system that works with zip contents. |
|
tests
|
|
|
Package web Cozy Stack API.
|
Package web Cozy Stack API. |
|
status
Package status is here just to say that the API is up and that it can access the CouchDB databases, for debugging and monitoring purposes.
|
Package status is here just to say that the API is up and that it can access the CouchDB databases, for debugging and monitoring purposes. |
|
version
Package version gives informations about the version of the cozy-stack
|
Package version gives informations about the version of the cozy-stack |
|
worker
|
|