mirror of
https://github.com/yusing/godoxy.git
synced 2025-05-20 12:42:34 +02:00
57292f0fe8
* feat: idle sleep for proxmox LXCs * refactor: replace deprecated docker api types * chore(api): remove debug task list endpoint * refactor: move servemux to gphttp/servemux; favicon.go to v1/favicon * refactor: introduce Pool interface, move agent_pool to agent module * refactor: simplify api code * feat: introduce debug api * refactor: remove net.URL and net.CIDR types, improved unmarshal handling * chore: update Makefile for debug build tag, update README * chore: add gperr.Unwrap method * feat: relative time and duration formatting * chore: add ROOT_DIR environment variable, refactor * migration: move homepage override and icon cache to $BASE_DIR/data, add migration code * fix: nil dereference on marshalling service health * fix: wait for route deletion * chore: enhance tasks debuggability * feat: stdout access logger and MultiWriter * fix(agent): remove agent properly on verify error * fix(metrics): disk exclusion logic and added corresponding tests * chore: update schema and prettify, fix package.json and Makefile * fix: I/O buffer not being shrunk before putting back to pool * feat: enhanced error handling module * chore: deps upgrade * feat: better value formatting and handling --------- Co-authored-by: yusing <yusing@6uo.me>
58 lines
1.5 KiB
TypeScript
58 lines
1.5 KiB
TypeScript
import { URI, URL } from "../types";
|
|
import { GotifyConfig, NtfyConfig, WebhookConfig } from "./notification";
|
|
export type Providers = {
|
|
/** List of route definition files to include
|
|
*
|
|
* @minItems 1
|
|
* @examples require(".").includeExamples
|
|
* @items.pattern ^[\w\d\-_]+\.(yaml|yml)$
|
|
*/
|
|
include?: URI[];
|
|
/** Name-value mapping of docker hosts to retrieve routes from
|
|
*
|
|
* @minProperties 1
|
|
* @examples require(".").dockerExamples
|
|
*/
|
|
docker?: {
|
|
[name: string]: URL | "$DOCKER_HOST";
|
|
};
|
|
/** List of GoDoxy agents
|
|
*
|
|
* @minItems 1
|
|
* @examples require(".").agentExamples
|
|
*/
|
|
agents?: `${string}:${number}`[];
|
|
/** List of notification providers
|
|
*
|
|
* @minItems 1
|
|
* @examples require(".").notificationExamples
|
|
*/
|
|
notification?: (WebhookConfig | GotifyConfig | NtfyConfig)[];
|
|
};
|
|
export declare const includeExamples: readonly ["file1.yml", "file2.yml"];
|
|
export declare const dockerExamples: readonly [
|
|
{
|
|
readonly local: "$DOCKER_HOST";
|
|
},
|
|
{
|
|
readonly remote: "tcp://10.0.2.1:2375";
|
|
},
|
|
{
|
|
readonly remote2: "ssh://root:1234@10.0.2.2";
|
|
},
|
|
];
|
|
export declare const notificationExamples: readonly [
|
|
{
|
|
readonly name: "gotify";
|
|
readonly provider: "gotify";
|
|
readonly url: "https://gotify.domain.tld";
|
|
readonly token: "abcd";
|
|
},
|
|
{
|
|
readonly name: "discord";
|
|
readonly provider: "webhook";
|
|
readonly template: "discord";
|
|
readonly url: "https://discord.com/api/webhooks/1234/abcd";
|
|
},
|
|
];
|
|
export declare const agentExamples: readonly ["10.0.2.3:8890", "10.0.2.4:8890"];
|