README
¶
Cozy Cloud
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.
What is the Cozy-Stack
It is the core server of the Cozy platform. It consists of a single process, the Cozy stack.
Full Cozy-Stack documentation here.
The Cozy-Stack is in charge of serving the Web applications users have installed from the application store.
It provides its services through a REST API that allows to:
- create, update, delete documents inside the database;
- authenticate users and client applications;
- send emails;
- launch jobs on the server. Connectors that import data from remote websites are some sort of jobs. Jobs can be one time tasks (sending a message) or periodic tasks. Some jobs, like the connectors, that require executing third party code on the server side, are sandboxed (we use
nsjailfor now). - …
The Cozy-Stack also allows to access the database replication API, allowing to sync documents between the server and local databases, for example in mobile clients.
Two authentication methods are available:
- Web applications running on the server get a session token when the user log in;
- OAuth2 for other applications.
Feel free to open an issue for questions and suggestions.
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.
Community
You can reach the Cozy Community by:
- Chatting with us on IRC #cozycloud on Libera.Chat
- 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
|
|
|
note
Package note is the glue between the prosemirror models, the VFS, redis, the hub for realtime, etc.
|
Package note is the glue between the prosemirror models, the VFS, redis, the hub for realtime, etc. |
|
vfs
Package vfs is for storing files on the cozy, including binary ones like photos and movies.
|
Package vfs is for storing files on the cozy, including binary ones like photos and movies. |
|
pkg
|
|
|
assets/statik
Package statik contains an HTTP file system that works with zip contents.
|
Package statik contains an HTTP file system that works with zip contents. |
|
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. |
|
shortcut
Package shortcut can be used to manipulate files in the .url format (from windows).
|
Package shortcut can be used to manipulate files in the .url format (from windows). |
|
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. |
|
tests
|
|
|
Package web Cozy Stack API.
|
Package web Cozy Stack API. |
|
apps
Package apps is the HTTP frontend of the application package.
|
Package apps is the HTTP frontend of the application package. |
|
auth
Package auth provides register and login handlers
|
Package auth provides register and login handlers |
|
bitwarden
Package bitwarden exposes an API compatible with the Bitwarden Open-Soure apps.
|
Package bitwarden exposes an API compatible with the Bitwarden Open-Soure apps. |
|
contacts
Package contacts exposes a route for the myself document.
|
Package contacts exposes a route for the myself document. |
|
data
Package data provide simple CRUD operation on couchdb doc
|
Package data provide simple CRUD operation on couchdb doc |
|
files
Package files is the HTTP frontend of the vfs package.
|
Package files is the HTTP frontend of the vfs package. |
|
notes
Package notes is about the documents of cozy-notes.
|
Package notes is about the documents of cozy-notes. |
|
public
Package public adds some public routes that can be used to give information to anonymous users, or to the not yet authentified cozy owner on its login page.
|
Package public adds some public routes that can be used to give information to anonymous users, or to the not yet authentified cozy owner on its login page. |
|
settings
Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents.
|
Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents. |
|
shortcuts
Package shortcuts is about the .url shortcuts.
|
Package shortcuts is about the .url shortcuts. |
|
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
|
|