cloudron-box/migrations/schema.sql

#### WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
#### This file is not used by any code and is here to document the latest schema

#### General ideas
#### Default char set is utf8mb4 and DEFAULT COLLATE is utf8mb4_bin. Collate affects comparisons in WHERE and ORDER
#### Strict mode is enabled
#### VARCHAR - stored as part of table row (use for strings)
#### TEXT - stored offline from table row (use for strings)
#### BLOB (64KB), MEDIUMBLOB (16MB), LONGBLOB (4GB) - stored offline from table row (use for binary data)
#### https://dev.mysql.com/doc/refman/5.0/en/storage-requirements.html
#### Times are stored in the database in UTC. And precision is seconds

# The code uses zero dates. Make sure sql_mode does NOT have NO_ZERO_DATE
# http://johnemb.blogspot.com/2014/09/adding-or-removing-individual-sql-modes.html
# SET GLOBAL sql_mode=(SELECT REPLACE(@@sql_mode,'NO_ZERO_DATE',''));

CREATE TABLE IF NOT EXISTS users(
    id VARCHAR(128) NOT NULL UNIQUE,
    username VARCHAR(254) UNIQUE,
    email VARCHAR(254) NOT NULL UNIQUE,
    password VARCHAR(1024) NOT NULL,
    salt VARCHAR(512) NOT NULL,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    displayName VARCHAR(512) DEFAULT "",
    fallbackEmail VARCHAR(512) DEFAULT "",
    twoFactorAuthenticationSecret VARCHAR(128) DEFAULT "",
    twoFactorAuthenticationEnabled BOOLEAN DEFAULT false,
    source VARCHAR(128) DEFAULT "",
    role VARCHAR(32),
    inviteToken VARCHAR(128) DEFAULT "", // one time token until user sets up account
    resetToken VARCHAR(128) DEFAULT "",
    resetTokenCreationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    active BOOLEAN DEFAULT 1,
    avatar MEDIUMBLOB,
    backgroundImage MEDIUMBLOB,
    loginLocationsJson MEDIUMTEXT, // { locations: [{ ip, userAgent, city, country, ts }] }
    notificationConfigJson TEXT,

    INDEX creationTime_index (creationTime),
    PRIMARY KEY(id));

CREATE TABLE IF NOT EXISTS userGroups(
    id VARCHAR(128) NOT NULL UNIQUE,
    name VARCHAR(254) NOT NULL UNIQUE,
    source VARCHAR(128) DEFAULT "",
    PRIMARY KEY(id));

CREATE TABLE IF NOT EXISTS groupMembers(
    groupId VARCHAR(128) NOT NULL,
    userId VARCHAR(128) NOT NULL,
    FOREIGN KEY(groupId) REFERENCES userGroups(id),
    FOREIGN KEY(userId) REFERENCES users(id),
    UNIQUE (groupId, userId));

CREATE TABLE IF NOT EXISTS tokens(
    id VARCHAR(128) NOT NULL UNIQUE,
    name VARCHAR(64) DEFAULT "", // description
    accessToken VARCHAR(128) NOT NULL UNIQUE,
    identifier VARCHAR(128) NOT NULL, // resourceId: app id or user id
    clientId VARCHAR(128),
    scopeJson TEXT,
    expires BIGINT NOT NULL, // FIXME: make this a timestamp
    lastUsedTime TIMESTAMP NULL,
    allowedIpRanges TEXT,
    PRIMARY KEY(accessToken));

CREATE TABLE IF NOT EXISTS apps(
    id VARCHAR(128) NOT NULL UNIQUE,
    appStoreId VARCHAR(128) NOT NULL, // empty for custom apps
    versionsUrl VARCHAR(512) DEFAULT "", // community apps
    installationState VARCHAR(512) NOT NULL, // the active task on the app
    runState VARCHAR(512) NOT NULL,   // if the app is stopped
    health VARCHAR(128),
    healthTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, // when the app last responded
    containerId VARCHAR(128),
    manifestJson TEXT,
    accessRestrictionJson TEXT, // { users: [ ], groups: [ ] }
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, // when the app was installed
    updateTime TIMESTAMP NULL DEFAULT NULL,   // when the last app update was done . Without the first NULL, it comes current time when assigned null!
    ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, // when this db record was updated (useful for UI caching)
    memoryLimit BIGINT DEFAULT 0,
    cpuQuota INTEGER DEFAULT 100,
    xFrameOptions VARCHAR(512),
    sso BOOLEAN DEFAULT 1, // whether user chose to enable SSO
    devicesJson TEXT,
    debugModeJson TEXT, // options for development mode
    reverseProxyConfigJson TEXT, // { robotsTxt, csp, hstsPreload }
    enableBackup BOOLEAN DEFAULT 1, // misnomer: controls automatic daily backups
    enableAutomaticUpdate BOOLEAN DEFAULT 1,
    enableMailbox BOOLEAN DEFAULT 1, // whether sendmail addon is enabled
    mailboxName VARCHAR(128), // mailbox of this app
    mailboxDomain VARCHAR(128), // mailbox domain of this app
    mailboxDisplayName VARCHAR(128), // mailbox display name
    enableInbox BOOLEAN DEFAULT 0, // whether recvmail addon is enabled
    inboxName VARCHAR(128), // mailbox of this app
    inboxDomain VARCHAR(128), // mailbox domain of this app
    label VARCHAR(128),     // display name
    notes TEXT,     // free form notes for admins
    tagsJson VARCHAR(2048), // array of tags
    storageVolumeId VARCHAR(128),
    storageVolumePrefix VARCHAR(128),
    taskId INTEGER, // current task
    errorJson TEXT,
    servicesConfigJson TEXT, // app services configuration
    containerIp VARCHAR(16) UNIQUE, // this is not-null because of ip allocation fails, user can 'repair'
    packageIcon MEDIUMBLOB,
    icon MEDIUMBLOB,
    crontab TEXT,
    upstreamUri VARCHAR(256) DEFAULT "",
    checklistJson TEXT, // checklist for admins

    FOREIGN KEY(mailboxDomain) REFERENCES domains(domain),
    FOREIGN KEY(inboxDomain) REFERENCES domains(domain),
    FOREIGN KEY(taskId) REFERENCES tasks(id),
    FOREIGN KEY(storageVolumeId) REFERENCES volumes(id),
    UNIQUE (storageVolumeId, storageVolumePrefix),
    PRIMARY KEY(id));

CREATE TABLE IF NOT EXISTS appPortBindings(
    hostPort INTEGER NOT NULL UNIQUE,
    type VARCHAR(8) NOT NULL DEFAULT "tcp",
    environmentVariable VARCHAR(128) NOT NULL,
    appId VARCHAR(128) NOT NULL,
    count INTEGER NOT NULL DEFAULT 1,
    FOREIGN KEY(appId) REFERENCES apps(id),
    PRIMARY KEY(hostPort));

CREATE TABLE IF NOT EXISTS settings(
    name VARCHAR(128) NOT NULL UNIQUE,
    value TEXT,
    valueBlob MEDIUMBLOB,
    PRIMARY KEY(name));

CREATE TABLE IF NOT EXISTS appAddonConfigs(
    appId VARCHAR(128) NOT NULL,
    addonId VARCHAR(32) NOT NULL,
    name VARCHAR(128) NOT NULL,
    value TEXT NOT NULL,
    FOREIGN KEY(appId) REFERENCES apps(id));

CREATE TABLE IF NOT EXISTS appEnvVars(
    appId VARCHAR(128) NOT NULL,
    name TEXT NOT NULL,
    value TEXT NOT NULL,
    FOREIGN KEY(appId) REFERENCES apps(id));

CREATE TABLE IF NOT EXISTS backups(
    id VARCHAR(128) NOT NULL,
    remotePath VARCHAR(256) NOT NULL UNIQUE,
    label VARCHAR(128) DEFAULT "",
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    packageVersion VARCHAR(128) NOT NULL, /* app version or box version */
    encryptionVersion INTEGER, /* when null, unencrypted backup */
    type VARCHAR(16) NOT NULL, /* 'box' or 'app' */
    identifier VARCHAR(128) NOT NULL, /* 'box' or the app id */
    dependsOnJson TEXT, /* comma separate list of objects this backup depends on */
    state VARCHAR(16) NOT NULL,
    manifestJson TEXT, /* to validate if the app can be installed in this version of box */
    preserveSecs INTEGER DEFAULT 0,
    appConfigJson TEXT, /* useful for clone and archive */
    siteId VARCHAR(128) NOT NULL,
    integrityJson TEXT, /* { signature } */
    statsJson TEXT,
    integrityCheckTaskId INTEGER, /* task id while integrity check is running */
    lastIntegrityCheckTime TIMESTAMP NULL, /* compared to task time, this is the result time */
    integrityCheckStatus VARCHAR(16) NULL, /* 'passed' | 'failed' */
    integrityCheckResultJson TEXT,    /* per backup result. if stored in tasks, this would have to be aggregated */

    FOREIGN KEY(siteId) REFERENCES backupSites(id),
    FOREIGN KEY(integrityCheckTaskId) REFERENCES tasks(id),
    INDEX creationTime_index (creationTime),
    PRIMARY KEY (id));

CREATE TABLE IF NOT EXISTS archives(
    id VARCHAR(128) NOT NULL UNIQUE,
    backupId VARCHAR(128) NOT NULL,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    packageIcon MEDIUMBLOB,
    icon MEDIUMBLOB,

    FOREIGN KEY(backupId) REFERENCES backups(id),
    PRIMARY KEY (id));

CREATE TABLE IF NOT EXISTS eventlog(
    id VARCHAR(128) NOT NULL,
    action VARCHAR(128) NOT NULL,
    sourceJson TEXT, /* { userId, username, ip }. userId can be null for cron,sysadmin */
    dataJson TEXT, /* free flowing json based on action */
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,

    INDEX creationTime_index (creationTime),
    PRIMARY KEY (id));

CREATE TABLE IF NOT EXISTS domains(
    domain VARCHAR(128) NOT NULL UNIQUE, /* if this needs to be larger, InnoDB has a limit of 767 bytes for PRIMARY KEY values! */
    zoneName VARCHAR(128) NOT NULL, /* this mostly contains the domain itself again */
    provider VARCHAR(16) NOT NULL,
    configJson TEXT, /* JSON containing the dns backend provider config */
    tlsConfigJson TEXT, /* JSON containing the tls provider config */
    wellKnownJson TEXT, /* JSON containing well known docs for this domain */

    fallbackCertificateJson MEDIUMTEXT,

    PRIMARY KEY (domain));

CREATE TABLE IF NOT EXISTS mail(
    domain VARCHAR(128) NOT NULL UNIQUE,

    enabled BOOLEAN DEFAULT 0, /* MDA enabled */
    mailFromValidation BOOLEAN DEFAULT 1,
    catchAllJson TEXT,
    relayJson TEXT,
    bannerJson TEXT,

    dkimKeyJson MEDIUMTEXT,
    dkimSelector VARCHAR(128) NOT NULL DEFAULT "cloudron",

    FOREIGN KEY(domain) REFERENCES domains(domain),
    PRIMARY KEY(domain));

/* NOTE: this table contains only real mailboxes. And has unique constraint to handle
   conflict with aliases and mailbox names
*/
CREATE TABLE IF NOT EXISTS mailboxes(
    name VARCHAR(128) NOT NULL,
    type VARCHAR(16) NOT NULL, /* 'mailbox', 'alias', 'list' */
    ownerId VARCHAR(128) NOT NULL, /* user id */
    ownerType VARCHAR(16) NOT NULL,
    aliasName VARCHAR(128), /* the target name type is an alias */
    aliasDomain VARCHAR(128), /* the target domain */
    membersJson TEXT, /* members of a group. fully qualified */
    membersOnly BOOLEAN DEFAULT false,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    domain VARCHAR(128),
    active BOOLEAN DEFAULT 1,
    enablePop3 BOOLEAN DEFAULT 0,
    storageQuota BIGINT DEFAULT 0,
    messagesQuota BIGINT DEFAULT 0,

    FOREIGN KEY(domain) REFERENCES mail(domain),
    FOREIGN KEY(aliasDomain) REFERENCES mail(domain),
    UNIQUE (name, domain));

CREATE TABLE IF NOT EXISTS locations(
    appId VARCHAR(128) NOT NULL,
    domain VARCHAR(128) NOT NULL,
    subdomain VARCHAR(128) NOT NULL,
    type VARCHAR(128) NOT NULL, /* primary, secondary, redirect, alias */
    environmentVariable VARCHAR(128), /* only set for secondary */

    certificateJson MEDIUMTEXT,

    FOREIGN KEY(domain) REFERENCES domains(domain),
    FOREIGN KEY(appId) REFERENCES apps(id),
    UNIQUE (subdomain, domain));

CREATE TABLE IF NOT EXISTS tasks(
    id int NOT NULL AUTO_INCREMENT,
    type VARCHAR(32) NOT NULL, /* 32 prefix + 128 for any id */
    argsJson TEXT,
    pending BOOLEAN DEFAULT true,
    completed BOOLEAN DEFAULT false,
    percent INTEGER DEFAULT 0,
    message TEXT,
    errorJson TEXT,
    resultJson TEXT,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,

    INDEX creationTime_index (creationTime),
    PRIMARY KEY (id));

CREATE TABLE IF NOT EXISTS notifications(
    id int NOT NULL AUTO_INCREMENT,
    eventId VARCHAR(128), // reference to eventlog. can be null
    type VARCHAR(128) NOT NULL DEFAULT ""
    title VARCHAR(512) NOT NULL,
    message TEXT,
    acknowledged BOOLEAN DEFAULT false,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    context VARCHAR(128) DEFAULT "", // used along with "type" to create uniqueness

    INDEX creationTime_index (creationTime),
    FOREIGN KEY(eventId) REFERENCES eventlog(id),
    PRIMARY KEY (id)
);

CREATE TABLE IF NOT EXISTS appPasswords(
    id VARCHAR(128) NOT NULL UNIQUE,
    name VARCHAR(128) NOT NULL,
    userId VARCHAR(128) NOT NULL,
    identifier VARCHAR(128) NOT NULL, // resourceId: app id or mail or webadmin
    hashedPassword VARCHAR(1024) NOT NULL,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    expiresAt TIMESTAMP NULL DEFAULT NULL,
    UNIQUE KEY appPasswords_name_appId_identifier (name, userId, identifier)
    FOREIGN KEY(userId) REFERENCES users(id),

    PRIMARY KEY (id)
);

CREATE TABLE IF NOT EXISTS mailPasswords(
    clientId VARCHAR(128) NOT NULL,
    userId VARCHAR(128) NOT NULL,
    password VARCHAR(1024) NOT NULL,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    FOREIGN KEY(clientId) REFERENCES oidcClients(id),
    FOREIGN KEY(userId) REFERENCES users(id),
    PRIMARY KEY (clientId, userId)
);

CREATE TABLE IF NOT EXISTS dockerRegistries(
    id VARCHAR(128) NOT NULL UNIQUE,
    provider VARCHAR(16) NOT NULL,
    serverAddress VARCHAR(128) NOT NULL,
    username VARCHAR(128),
    email VARCHAR(128),
    password VARCHAR(128),

    PRIMARY KEY (id)
);

CREATE TABLE IF NOT EXISTS backupSites(
    id VARCHAR(128) NOT NULL UNIQUE,
    name VARCHAR(128) NOT NULL UNIQUE,
    provider VARCHAR(32) NOT NULL,
    configJson TEXT,
    contentsJson TEXT,
    limitsJson TEXT,
    retentionJson TEXT,
    encryptionJson TEXT,
    format VARCHAR(16) NOT NULL,
    schedule VARCHAR(128),
    integrityKeyPairJson TEXT, // { publicKey, privateKey }
    enableForUpdates BOOLEAN DEFAULT false,
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,

    PRIMARY KEY (id)
);

CREATE TABLE IF NOT EXISTS volumes(
    id VARCHAR(128) NOT NULL UNIQUE,
    name VARCHAR(256) NOT NULL UNIQUE,
    hostPath VARCHAR(768) NOT NULL UNIQUE, // computed hostPath . has to be < 768*4 (3072) bytes
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    mountType VARCHAR(16) DEFAULT "noop",
    mountOptionsJson TEXT,
    PRIMARY KEY (id)
);

CREATE TABLE IF NOT EXISTS appMounts(
    appId VARCHAR(128) NOT NULL,
    volumeId VARCHAR(128) NOT NULL,
    readOnly BOOLEAN DEFAULT 1,
    UNIQUE KEY appMounts_appId_volumeId (appId, volumeId),
    FOREIGN KEY(appId) REFERENCES apps(id),
    FOREIGN KEY(volumeId) REFERENCES volumes(id));

CREATE TABLE IF NOT EXISTS blobs(
    id VARCHAR(128) NOT NULL UNIQUE,
    value MEDIUMBLOB,
    PRIMARY KEY(id));

CREATE TABLE IF NOT EXISTS appLinks(
    id VARCHAR(128) NOT NULL UNIQUE,
    accessRestrictionJson TEXT, // { users: [ ], groups: [ ] }
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, // when the app was installed
    updateTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,   // when the last app update was done
    ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, // when this db record was updated (useful for UI caching)
    label VARCHAR(128),     // display name
    tagsJson VARCHAR(2048), // array of tags
    icon MEDIUMBLOB,
    upstreamUri VARCHAR(256) DEFAULT "",

    PRIMARY KEY(id));

CREATE TABLE IF NOT EXISTS oidcClients(
    id VARCHAR(128) NOT NULL UNIQUE,
    secret VARCHAR(128) DEFAULT "",
    appId VARCHAR(128) DEFAULT "",
    name VARCHAR(128) DEFAULT "",
    loginRedirectUri VARCHAR(256) DEFAULT "",
    tokenSignatureAlgorithm VARCHAR(128) DEFAULT "",
    PRIMARY KEY(id));

CREATE TABLE IF NOT EXISTS locks(
    id VARCHAR(128) NOT NULL UNIQUE,
    dataJson TEXT,
    version INT DEFAULT 1
    ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP);

CREATE TABLE IF NOT EXISTS passkeys(
    id VARCHAR(128) NOT NULL UNIQUE,
    userId VARCHAR(128) NOT NULL,
    credentialId VARCHAR(512) NOT NULL UNIQUE,
    publicKey TEXT NOT NULL,
    counter BIGINT DEFAULT 0,
    transports TEXT,
    name VARCHAR(128) DEFAULT "",
    creationTime TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    lastUsedTime TIMESTAMP NULL,
    FOREIGN KEY(userId) REFERENCES users(id),
    PRIMARY KEY(id));