Type alias MetadataV4

MetadataV4: { category: string; compatible: boolean; defaultPassword?: string; description: string; developers: Record<string, string>; gallery?: string[]; hiddenService?: string; id?: string; implements?: string; installed?: boolean; name: string; path?: string; permissions?: (string | string[])[]; repo: Record<string, string>; support: string; tagline: string; torOnly?: boolean; updateContainers?: string[] | null; version: string; versionControl?: null | string }

Type declaration

  • category: string

    The category for the app

  • compatible: boolean

    Automatically added

  • Optional defaultPassword?: string

    The app's default password. Can also be $APP_SEED for a random password

  • description: string

    A description of the app

  • developers: Record<string, string>
  • Optional gallery?: string[]

    A list of promo images for the apps

  • Optional hiddenService?: string

    Automatically added

  • Optional id?: string

    The app id, only set in output

  • Optional implements?: string

    For "virtual" apps, the service the app implements

  • Optional installed?: boolean

    Automatically added

  • name: string

    The name of the app

  • Optional path?: string

    The path the "Open" link on the dashboard should lead to

  • Optional permissions?: (string | string[])[]

    Permissions the app requires

  • repo: Record<string, string>

    App repository name -> repo URL

  • support: string

    A support link for the app

  • tagline: string

    A short tagline for the app

  • Optional torOnly?: boolean

    True if the app only works over Tor

  • Optional updateContainers?: string[] | null

    A list of containers to update automatically (still validated by the Citadel team)

  • version: string

    The version of the app

  • Optional versionControl?: null | string

Settings

Member Visibility

Theme

Generated using TypeDoc