Documentation

Getting started

This is a short start. The full user guide, with screenshots and recordings of every feature, is here.

The first account

In Home, the first account you create is yours and has full control. On a Server installation, the account registered with the address set in ADMIN_EMAIL becomes the administrator; everyone else joins by registering or through an invitation.

How it is organised

A workspace holds collections, and a collection holds entries. A collection has fields (in Corexar they are called characteristics): text, number, date, choice, tags, rating, rich text, or a composite of several. A field is defined once and can be used in any collection.

A field can be shared (one value for everyone) or personal (each person has their own, visible only to them) — handy for ratings and progress in a family or a team.

Long entries can have parts: chapters, episodes, volumes, nested as deep as you need. The pages of a collection and of every entry are built from blocks in the “Customize” editors.

Roles and sharing

Invite people by a link or e-mail and give them a role. A role is a set of permissions (manage members, create and edit collections and entries, manage security). On top of that, a role can be allowed to edit just some fields of an entry. The activity log shows who did what.

Encrypted collections

Server edition with a Pro or Enterprise key. Titles and values of an encrypted collection are stored as ciphertext under a key protected by the collection password. That protects a stolen database, backup or disk. It is not end-to-end encryption: the server handles the key while a collection is unlocked. If the password is lost, the data cannot be recovered.

Backups

Home: copy the data folder while the app is closed.
Server: a PostgreSQL dump and the media bucket. Keep ENCRYPTION_PEPPER and the other secrets with them.
Entries can also be exported to CSV and JSON from a collection page.