Skip to content

Cozy Developer Documentation

Documentations

Initializing search

Home
Tutorials
How-to
Libraries
Projects

Cozy Developer Documentation

Home
Tutorials
Tutorials
- Create Your Application
- Develop a Connector
  Develop a Connector
- Develop a Client-Side Connector
  Develop a Client-Side Connector
- Manipulate data
  Manipulate data
  - Introduction
  - Queries
  - PouchDB
  - DocTypes
  - Qualification
  - Advanced
- Translate Apps
- Self-Hosting
  Self-Hosting
  - Introduction
  - Running inside Docker
  - Traditional installation
    Traditional installation
    
    Requirements
    Requirements
    
    What you need
    
    Installing CouchDB
    
    Installing NodeJS
    
    Installing cozy-stack
    Installing cozy-stack
    
    Introduction
    
    From precompiled package
    
    From sources
    
    Finalize installation
    Finalize installation
    
    Nginx and certificates
    
    Using Apache instead of Nginx
    
    Create first instance
    
    Administration
    Administration
    
    Index
    
    Create more instances
    
    Upgrade cozy-stack
    
    Configure mail sending
    
    Online edition of office documents
How-to
How-to
- Dev
  Dev
- Synchronize
  Synchronize
  - Install Cozy Drive on GNU/Linux
Libraries
Libraries
- Develop an application
  Develop an application
  - Access data (client)
    Access data (client)
    
    Getting started
    
    Using relationships
    
    Using time series
    
    React integration
    
    Hooks
    
    Metadata
    
    Logging
    
    Node
    
    Architecture
    
    Cozy Client API
    
    Cozy Pouch Link API
    
    Cozy Stack Client API
  - Build the user interface (ui)
  - Define data (doctypes)
    Define data (doctypes)
    
    README
    
    Accounts
    
    AI
    
    Apps
    
    App suggestions
    
    Banking doctypes
    
    Bills
    
    Calendar
    
    Connectors
    
    CoachCO2
    
    Contacts
    
    DocRules
    
    Files
    
    Files metadata
    
    Home settings
    
    Identities
    
    Notes
    
    Notifications
    
    Permissions
    
    Photos
    
    Procedures
    
    Sessions Logins
    
    Settings
    
    Sharings
    
    Tags
    
    Time series
    
    Todos
    
    Accounts Types
    
    Autocategorization
    
    Exports
    
    Jobs
    
    OAuth Clients
    
    OAuth Access Codes
    
    Triggers
    
    Triggers state
    
    Remote NextCloud files
    
    Remote requests
    
    Sessions
    
    Shared
    
    Terms
    
    Bitwarden ciphers
    
    Bitwarden folders
    
    Bitwarden organizations
    
    Bitwarden contacts
    
    Bets Unibet
    
    Announcements
    
    Drive Settings
  - Realtime data (realtime)
  - Native devices (device-helper)
- Develop a konnector
  Develop a konnector
  - README
  - API
  - CLI
  - Develop
  - Errors
  - Operation linking
  - Synchronization
- Publish on the store (app-publish)
- Send notifications (cozy-notifications)
- Dev tools
  Dev tools
  - Babel preset
  - Commitlint
  - ESLint
  - ACH
- Advanced
  Advanced
  - Stack server
    Stack server
    
    README
    
    Usage
    Usage
    
    Install the cozy-stack
    
    Configuration file
    
    Managing Instances
    
    Security
    
    Manpages of the command-line tool
    
    Using the admin API
    
    Important changes
    
    How-to guides for developpers
    How-to guides for developpers
    
    Using the HTTP API
    
    Develop a client-side app
    
    Running and building Docker images
    
    Running a konnector locally
    
    Adding a new doctype
    
    Working with the stack assets
    
    Build a release
    
    The contributing guide
    
    Explanations
    Explanations
    
    Flagship app
    
    Move design
    
    Realtime internals
    
    Sharing design
    
    Workflow of the konnectors
    
    List of services
    List of services
    
    /ai - AI
    
    /auth - Authentication & OAuth
    
    /oidc - Delegated authentication
    
    /apps - Applications Management
    
    /apps - Apps registry
    
    /bitwarden - Bitwarden
    
    /connection_check - Connection check
    
    /contacts - Contacts
    
    /data - Data System
    
    /data - Mango
    
    /data - CouchDB Quirks
    
    /data - PouchDB Quirks
    
    /files - Virtual File System
    
    /files - Not synchronized directories
    
    /files - References of documents in VFS
    
    /intents - Intents
    
    /jobs - Jobs
    
    /jobs - Workers
    
    /konnectors - Konnectors
    
    /move - Move, export and import an instance
    
    /notes - Notes for collaborative edition
    
    /notifications - Notifications
    
    /office - Collaborative edition of Office documents
    
    /public - Public
    
    /permissions - Permissions
    
    /realtime - Realtime
    
    /remote - Proxy for remote data/API
    
    /remote/nextcloud - NextCloud
    
    /rabbitmq - RabbitMQ integration
    
    /settings - Settings
    
    /settings - Terms of Services
    
    /sharings - Sharing
    
    /sharings/drives - Shared drives
    
    /shortcuts - Shortcuts
    
    /.well-known - Well-known
  - Registry server
Projects
Projects
- Documentations
- Cozy Desktop
  Cozy Desktop
  - README
  - Usage
    Usage
    
    Build
    
    CLI
    
    Filesystems
    
    Ignore files
    
    inotify
    
    Limitations
    
    Linux
    
    MacOS
    
    Windows
  - Developer
    Developer
    
    API Documentation
    
    Cofeescript
    
    Debug
    
    Log analysis
    
    Requirements
    
    Setup
    
    Setup
  - Feddback

Projects¶

Cozy App Publish

Cozy App Registry

Cozy Banks

Cozy Flags

Cozy Interapp

Cozy Stack

Cozy UI

Cozy Desktop

privacy

Made with Material for MkDocs