Export and deletion

The data of a home belongs to its owners, who can take it out and delete it; the data of a person is erased with their account (ADR 0023). The administrator of the instance does neither for a home they do not own.

Export of a home

An owner downloads the archive from the page of the home (Export all data) or from the API (POST /api/v1/homes/<id>/export/, signed in; an API token cannot). The export is written to the audit log of the home.

The archive is a zip:

Part	Content
export.json	The data, as JSON (below).
files/	The files of the home, at the paths export.json lists: the photos, under files/photos/.
README.txt	A reminder of the format.

export.json is versioned. Version 1 has these keys:

Key	Content
format, version	"housecairn-export" and 1. A change that removes or renames a key raises the version.
exported_at, application_version	When, and by which version.
home	id, name, currency, required_provider, created_at.
members	id, email, name, role, joined_at of each member.
pending_invitations	id, email, role, sent_at, expires_at; never a link.
events	id, kind, payload, received_at of the events received.
rooms	id, name, kind, position, notes, created_at of each room, and its memory (paint colour, brand, reference, batch and stock, floor and wall covering, memory notes).
items	id, room, name, kind, brand, model, serial_number, installed_on, warranty_ends_on, contract, contract_url, links, notes, created_at of each item.
photos	id, room or item, category, caption, content_type, size_bytes, width, height, created_at, and file, the path of the photo in the archive (files/photos/<id>.<extension>, or null if the file is missing).
files	path and size of each file in files/.

Photos are exported as they are stored, already stripped of their metadata at upload. Thumbnails are not exported, and neither is anything deleted. The archive has no size limit of its own: it is as large as the photos of the home (each is limited by HOUSECAIRN_PHOTO_MAX_BYTES).

Each lot that adds data adds its section here and to the archive. The archive holds the home it was made for and nothing of another.

Deletion of a home

An owner deletes the home from its page (Delete this home): type its exact name. The home and everything in it go for good, for all its members: members, invitations, events, its audit log and its files; an API token left without a home is revoked. There is no grace period and no way back: export first. The audit log of the instance records that a home was deleted, without its name.

The photos are erased from the disk with the home, deleted ones included. If the disk refuses (permissions, a full or read-only volume), the home is still deleted and the error is logged by housecairn.files with the path of the directory (photos/<home id>): remove that directory by hand.

Erasure of an account

Delete my account (see Account pages) erases the account, its sign-in methods, devices and API tokens, the homes where it is the only member, and the invitations to its address. It is refused for the only administrator and for the only owner of a home with other members: hand ownership over, or delete the home, first. The audit log keeps that it happened and no longer says who.

Backups

Deleted data stays in backups until they expire: tell people how long you keep them (see Backup).

Edit this page on GitHub Report a problem with this page