README.md

title
Cozy-Stack documentation - Table of contents

What is the Cozy-Stack?

The cozy-stack is the main backend server for the Cozy platform.

Full Cozy-Stack documentation here.

The Cozy-Stack is in charge of serving / running the applications users have installed on their Cozy.

It is in charge of:

• creating, updating, deleting documents inside the database;
• authenticating users and client applications;
• sending emails;
• launching jobs on the server. Connectors that import data from remote websites are jobs. Jobs can be one time tasks (sending a message) or periodic tasks. Jobs that require executing third party code on the server side (like connectors), are sandboxed;
• database replication API, allowing to sync documents between the server and local databases, for example in mobile clients.

Feel free to open an issue for questions and suggestions.

How-to guides

Usage

• Install the cozy-stack
• Configuration file
• Managing Instances
• Security
• Manpages of the command-line tool
• Using the admin API
• Important changes

For developers

• Using the HTTP API of cozy-stack
• Develop a client-side app
• Develop a konnector
• Running and building Docker images
• Adding a new doctype
• Working with the stack assets
• Build a release
• The contributing guide

Explanation

Up-to-date

• Flagship app
• Move design
• Realtime internals
• Sharing design
• Workflow of the konnectors

Archives

These pages are the results of studies we made. They may be outdated and are kept as an archive to help understanding what were out original intentions when designing new services.

• General overview of the initial architecture
• Onboarding with an application
• Moving
• Golang Couchdb Plugins
• Konnectors design
• Replication
• Realtime design

Reference

List of services

• /ai - AI
• /auth - Authentication & OAuth
  • Delegated authentication
• /apps - Applications Management
  • Apps registry
  • Konnectors
• /bitwarden - Bitwarden
• /connection_check - Connection check
• /contacts - Contacts
• /data - Data System
  • Mango
  • CouchDB Quirks & PouchDB Quirks
• /files - Virtual File System
  • Not synchronized directories
  • References of documents in VFS
• /intents - Intents
• /jobs - Jobs
  • Workers
• /move - Move, export and import an instance
• /notes - Notes with collaborative edition
• /notifications - Notifications
• /office - Collaborative edition of Office documents
• /permissions - Permissions
• /public - Public
• /realtime - Realtime
• /remote - Proxy for remote data/API
  • NextCloud
• /settings - Settings
  • Terms of Services
• /sharings - Sharing
• /shortcuts - Shortcuts
• /.well-known - Well-known