homeio

1/** What the UI is allowed to know about the tunnel configuration. */
2export type CloudflareTunnelConfigPublic = {
3  enabled: boolean;
4  domain: string;
5  hasToken: boolean;
6  /** An API token lets Homeio create the public hostname routes itself. */
7  hasApiToken: boolean;
8};
9
10export type CloudflareTunnelConfigSaveRequest = {
11  enabled: boolean;
12  domain: string;
13  /** Omit to keep the stored token, empty string to clear it. */
14  token?: string;
15  /** Same rules as token. Without it, routes must be created by hand. */
16  apiToken?: string;
17};
18
19/** A cloudflared container on this host that is not Homeio's own connector. */
20export type CloudflareOtherConnector = {
21  name: string;
22  running: boolean;
23  /** True when it serves the tunnel Homeio is configured for; null when its token cannot be read. */
24  sameTunnel: boolean | null;
25};
26
27/** Whether the cloudflared connector is actually up. */
28export type CloudflareTunnelStatus = {
29  installed: boolean;
30  running: boolean;
31  state: string | null;
32  error: string | null;
33  /** The container Homeio runs the connector in. */
34  containerName: string;
35  otherConnectors: CloudflareOtherConnector[];
36};
37
38/** One installed app as offered in the "expose through the tunnel" list. */
39export type CloudflareTunnelAppExposure = {
40  appId: string;
41  name: string;
42  /** Port the app's web UI listens on, null when it has none. */
43  port: number | null;
44  /** Subdomain in use, or the suggestion to prefill when not exposed yet. */
45  subdomain: string;
46  exposed: boolean;
47  /** The public address this app resolves to, null until it is exposed. */
48  publicUrl: string | null;
49};
50
51export type CloudflareTunnelExposureSaveRequest = {
52  appId: string;
53  exposed: boolean;
54  subdomain?: string;
55};
56