mirror of
https://github.com/yusing/godoxy.git
synced 2025-06-04 02:42:34 +02:00
use auto generated schemas
This commit is contained in:
yusing
parent
26d259b952
commit
6a07a63c34
30 changed files with 4713 additions and 867 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -4,6 +4,7 @@ compose.yml
|
||||||
config
|
config
|
||||||
certs
|
certs
|
||||||
config*/
|
config*/
|
||||||
|
!schemas/**
|
||||||
certs*/
|
certs*/
|
||||||
bin/
|
bin/
|
||||||
error_pages/
|
error_pages/
|
||||||
|
|
@ -25,4 +26,4 @@ todo.md
|
||||||
.aider*
|
.aider*
|
||||||
mtrace.json
|
mtrace.json
|
||||||
.env
|
.env
|
||||||
test.Dockerfile
|
test.Dockerfile
|
||||||
4
.vscode/settings.example.json
vendored
4
.vscode/settings.example.json
vendored
|
|
@ -1,10 +1,10 @@
|
||||||
{
|
{
|
||||||
"yaml.schemas": {
|
"yaml.schemas": {
|
||||||
"https://github.com/yusing/go-proxy/raw/v0.8/schema/config.schema.json": [
|
"https://github.com/yusing/go-proxy/raw/v0.8/schemas/config.schema.json": [
|
||||||
"config.example.yml",
|
"config.example.yml",
|
||||||
"config.yml"
|
"config.yml"
|
||||||
],
|
],
|
||||||
"https://github.com/yusing/go-proxy/raw/v0.8/schema/providers.schema.json": [
|
"https://github.com/yusing/go-proxy/raw/v0.8/schemas/routes.schema.json": [
|
||||||
"providers.example.yml"
|
"providers.example.yml"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -51,7 +51,7 @@ COPY config.example.yml /app/config/config.yml
|
||||||
COPY --from=builder /etc/ssl/certs /etc/ssl/certs
|
COPY --from=builder /etc/ssl/certs /etc/ssl/certs
|
||||||
|
|
||||||
# copy schema
|
# copy schema
|
||||||
COPY schema /app/schema
|
COPY schemas/config.schema.json schemas/routes.schema.json /app/schemas/
|
||||||
|
|
||||||
ENV DOCKER_HOST=unix:///var/run/docker.sock
|
ENV DOCKER_HOST=unix:///var/run/docker.sock
|
||||||
ENV GODOXY_DEBUG=0
|
ENV GODOXY_DEBUG=0
|
||||||
|
|
|
||||||
11
Makefile
11
Makefile
|
|
@ -70,4 +70,13 @@ push-docker-io:
|
||||||
|
|
||||||
build-docker:
|
build-docker:
|
||||||
docker build -t godoxy-nightly \
|
docker build -t godoxy-nightly \
|
||||||
--build-arg VERSION="${VERSION}-nightly-${BUILD_DATE}" .
|
--build-arg VERSION="${VERSION}-nightly-${BUILD_DATE}" .
|
||||||
|
|
||||||
|
gen-schema:
|
||||||
|
typescript-json-schema --required --constAsEnum --tsNodeRegister=true -o schemas/config.schema.json schemas/config/config.ts Config
|
||||||
|
typescript-json-schema --required --constAsEnum --tsNodeRegister=true -o schemas/routes.schema.json schemas/providers/routes.ts Routes
|
||||||
|
typescript-json-schema --required --constAsEnum --tsNodeRegister=true -o schemas/middleware_compose.schema.json schemas/middlewares/middleware_compose.ts MiddlewareComposeConfig
|
||||||
|
# typescript-json-schema --required --constAsEnum --tsNodeRegister=true -o schemas/docker_routes.schema.json schemas/docker.ts DockerRoutes
|
||||||
|
|
||||||
|
push-github:
|
||||||
|
git push origin $(shell git rev-parse --abbrev-ref HEAD)
|
||||||
|
|
@ -14,7 +14,7 @@ func GetSchemaFile(w http.ResponseWriter, r *http.Request) {
|
||||||
if filename == "" {
|
if filename == "" {
|
||||||
U.RespondError(w, U.ErrMissingKey("filename"), http.StatusBadRequest)
|
U.RespondError(w, U.ErrMissingKey("filename"), http.StatusBadRequest)
|
||||||
}
|
}
|
||||||
content, err := os.ReadFile(path.Join(common.SchemaBasePath, filename))
|
content, err := os.ReadFile(path.Join(common.SchemasBasePath, filename))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
U.HandleErr(w, r, err)
|
U.HandleErr(w, r, err)
|
||||||
return
|
return
|
||||||
|
|
|
||||||
|
|
@ -25,9 +25,9 @@ const (
|
||||||
|
|
||||||
MiddlewareComposeBasePath = ConfigBasePath + "/middlewares"
|
MiddlewareComposeBasePath = ConfigBasePath + "/middlewares"
|
||||||
|
|
||||||
SchemaBasePath = "schema"
|
SchemasBasePath = "schemas"
|
||||||
ConfigSchemaPath = SchemaBasePath + "/config.schema.json"
|
ConfigSchemaPath = SchemasBasePath + "/config.schema.json"
|
||||||
FileProviderSchemaPath = SchemaBasePath + "/providers.schema.json"
|
FileProviderSchemaPath = SchemasBasePath + "/providers.schema.json"
|
||||||
|
|
||||||
ComposeFileName = "compose.yml"
|
ComposeFileName = "compose.yml"
|
||||||
ComposeExampleFileName = "compose.example.yml"
|
ComposeExampleFileName = "compose.example.yml"
|
||||||
|
|
@ -37,7 +37,7 @@ const (
|
||||||
|
|
||||||
var RequiredDirectories = []string{
|
var RequiredDirectories = []string{
|
||||||
ConfigBasePath,
|
ConfigBasePath,
|
||||||
SchemaBasePath,
|
SchemasBasePath,
|
||||||
ErrorPagesBasePath,
|
ErrorPagesBasePath,
|
||||||
MiddlewareComposeBasePath,
|
MiddlewareComposeBasePath,
|
||||||
}
|
}
|
||||||
|
|
|
||||||
43
internal/docker/container_test.go
Normal file
43
internal/docker/container_test.go
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
package docker
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/docker/docker/api/types"
|
||||||
|
. "github.com/yusing/go-proxy/internal/utils/testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestContainerExplicit(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
labels map[string]string
|
||||||
|
isExplicit bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "explicit",
|
||||||
|
labels: map[string]string{
|
||||||
|
"proxy.aliases": "foo",
|
||||||
|
},
|
||||||
|
isExplicit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "explicit2",
|
||||||
|
labels: map[string]string{
|
||||||
|
"proxy.idle_timeout": "1s",
|
||||||
|
},
|
||||||
|
isExplicit: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "not explicit",
|
||||||
|
labels: map[string]string{},
|
||||||
|
isExplicit: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
c := FromDocker(&types.Container{Names: []string{"test"}, State: "test", Labels: tt.labels}, "")
|
||||||
|
ExpectEqual(t, c.IsExplicit, tt.isExplicit)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -2,6 +2,7 @@ example: # matching `example.y.z`
|
||||||
scheme: http
|
scheme: http
|
||||||
host: 10.0.0.254
|
host: 10.0.0.254
|
||||||
port: 80
|
port: 80
|
||||||
|
no_tls_verify: true
|
||||||
path_patterns: # Check https://pkg.go.dev/net/http#hdr-Patterns-ServeMux for syntax
|
path_patterns: # Check https://pkg.go.dev/net/http#hdr-Patterns-ServeMux for syntax
|
||||||
- GET / # accept any GET request
|
- GET / # accept any GET request
|
||||||
- POST /auth # for /auth and /auth/* accept only POST
|
- POST /auth # for /auth and /auth/* accept only POST
|
||||||
|
|
|
||||||
|
|
@ -1,103 +0,0 @@
|
||||||
{
|
|
||||||
"$id": "https://github.com/yusing/go-proxy/raw/v0.8/schema/access_log.json",
|
|
||||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
||||||
"title": "Access log configuration",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"path": {
|
|
||||||
"title": "Access log path",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"format": {
|
|
||||||
"title": "Access log format",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"common",
|
|
||||||
"combined",
|
|
||||||
"json"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"buffer_size": {
|
|
||||||
"title": "Access log buffer size in bytes",
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 1
|
|
||||||
},
|
|
||||||
"filters": {
|
|
||||||
"title": "Access log filters",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"cidr": {
|
|
||||||
"title": "CIDR filter",
|
|
||||||
"$ref": "#/$defs/access_log_filters"
|
|
||||||
},
|
|
||||||
"status_codes": {
|
|
||||||
"title": "Status code filter",
|
|
||||||
"$ref": "#/$defs/access_log_filters"
|
|
||||||
},
|
|
||||||
"method": {
|
|
||||||
"title": "Method filter",
|
|
||||||
"$ref": "#/$defs/access_log_filters"
|
|
||||||
},
|
|
||||||
"headers": {
|
|
||||||
"title": "Header filter",
|
|
||||||
"$ref": "#/$defs/access_log_filters"
|
|
||||||
},
|
|
||||||
"host": {
|
|
||||||
"title": "Host filter",
|
|
||||||
"$ref": "#/$defs/access_log_filters"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"fields": {
|
|
||||||
"title": "Access log fields",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"headers": {
|
|
||||||
"title": "Headers field",
|
|
||||||
"$ref": "#/$defs/access_log_fields"
|
|
||||||
},
|
|
||||||
"query": {
|
|
||||||
"title": "Query field",
|
|
||||||
"$ref": "#/$defs/access_log_fields"
|
|
||||||
},
|
|
||||||
"cookies": {
|
|
||||||
"title": "Cookies field",
|
|
||||||
"$ref": "#/$defs/access_log_fields"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"$defs": {
|
|
||||||
"access_log_filters": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"negative": {
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
"values": {
|
|
||||||
"type": "array"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"access_log_fields": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"default": {
|
|
||||||
"enum": [
|
|
||||||
"keep",
|
|
||||||
"redact",
|
|
||||||
"drop"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"config": {
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,464 +0,0 @@
|
||||||
{
|
|
||||||
"$id": "https://github.com/yusing/go-proxy/raw/v0.8/schema/config.schema.json",
|
|
||||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
||||||
"type": "object",
|
|
||||||
"title": "GoDoxy config file",
|
|
||||||
"properties": {
|
|
||||||
"autocert": {
|
|
||||||
"title": "Autocert configuration",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"email": {
|
|
||||||
"title": "ACME Email",
|
|
||||||
"type": "string",
|
|
||||||
"format": "email"
|
|
||||||
},
|
|
||||||
"domains": {
|
|
||||||
"title": "Cert Domains",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"minItems": 1
|
|
||||||
},
|
|
||||||
"cert_path": {
|
|
||||||
"title": "path of cert file to load/store",
|
|
||||||
"default": "certs/cert.crt",
|
|
||||||
"markdownDescription": "default: `certs/cert.crt`,",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"key_path": {
|
|
||||||
"title": "path of key file to load/store",
|
|
||||||
"default": "certs/priv.key",
|
|
||||||
"markdownDescription": "default: `certs/priv.key`",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"acme_key_path": {
|
|
||||||
"title": "path of acme key file to load/store",
|
|
||||||
"default": "certs/acme.key",
|
|
||||||
"markdownDescription": "default: `certs/acme.key`",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"provider": {
|
|
||||||
"title": "DNS Challenge Provider",
|
|
||||||
"default": "local",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"local",
|
|
||||||
"cloudflare",
|
|
||||||
"clouddns",
|
|
||||||
"duckdns",
|
|
||||||
"ovh"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"options": {
|
|
||||||
"title": "Provider specific options",
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"if": {
|
|
||||||
"not": {
|
|
||||||
"properties": {
|
|
||||||
"provider": {
|
|
||||||
"const": "local"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"then": {
|
|
||||||
"required": [
|
|
||||||
"email",
|
|
||||||
"domains",
|
|
||||||
"provider",
|
|
||||||
"options"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"if": {
|
|
||||||
"properties": {
|
|
||||||
"provider": {
|
|
||||||
"const": "cloudflare"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"then": {
|
|
||||||
"properties": {
|
|
||||||
"options": {
|
|
||||||
"required": [
|
|
||||||
"auth_token"
|
|
||||||
],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"auth_token": {
|
|
||||||
"description": "Cloudflare API Token with Zone Scope",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"if": {
|
|
||||||
"properties": {
|
|
||||||
"provider": {
|
|
||||||
"const": "clouddns"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"then": {
|
|
||||||
"properties": {
|
|
||||||
"options": {
|
|
||||||
"required": [
|
|
||||||
"client_id",
|
|
||||||
"email",
|
|
||||||
"password"
|
|
||||||
],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"client_id": {
|
|
||||||
"description": "CloudDNS Client ID",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"email": {
|
|
||||||
"description": "CloudDNS Email",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"description": "CloudDNS Password",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"if": {
|
|
||||||
"properties": {
|
|
||||||
"provider": {
|
|
||||||
"const": "duckdns"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"then": {
|
|
||||||
"properties": {
|
|
||||||
"options": {
|
|
||||||
"required": [
|
|
||||||
"token"
|
|
||||||
],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"token": {
|
|
||||||
"description": "DuckDNS Token",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"if": {
|
|
||||||
"properties": {
|
|
||||||
"provider": {
|
|
||||||
"const": "ovh"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"then": {
|
|
||||||
"properties": {
|
|
||||||
"options": {
|
|
||||||
"required": [
|
|
||||||
"application_secret",
|
|
||||||
"consumer_key"
|
|
||||||
],
|
|
||||||
"additionalProperties": false,
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"required": [
|
|
||||||
"application_key"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"required": [
|
|
||||||
"oauth2_config"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"api_endpoint": {
|
|
||||||
"description": "OVH API endpoint",
|
|
||||||
"default": "ovh-eu",
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
"enum": [
|
|
||||||
"ovh-eu",
|
|
||||||
"ovh-ca",
|
|
||||||
"ovh-us",
|
|
||||||
"kimsufi-eu",
|
|
||||||
"kimsufi-ca",
|
|
||||||
"soyoustart-eu",
|
|
||||||
"soyoustart-ca"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"format": "uri"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"application_secret": {
|
|
||||||
"description": "OVH Application Secret",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"consumer_key": {
|
|
||||||
"description": "OVH Consumer Key",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"application_key": {
|
|
||||||
"description": "OVH Application Key",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"oauth2_config": {
|
|
||||||
"description": "OVH OAuth2 config",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"client_id": {
|
|
||||||
"description": "OVH Client ID",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"client_secret": {
|
|
||||||
"description": "OVH Client Secret",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"client_id",
|
|
||||||
"client_secret"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"providers": {
|
|
||||||
"title": "Proxy providers configuration",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"include": {
|
|
||||||
"title": "Proxy providers configuration files",
|
|
||||||
"description": "relative path to 'config'",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^[a-zA-Z0-9_-]+\\.(yml|yaml)$",
|
|
||||||
"patternErrorMessage": "Invalid file name"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"docker": {
|
|
||||||
"title": "Docker provider configuration",
|
|
||||||
"description": "docker clients (name-address pairs)",
|
|
||||||
"type": "object",
|
|
||||||
"patternProperties": {
|
|
||||||
"^[a-zA-Z0-9-_]+$": {
|
|
||||||
"type": "string",
|
|
||||||
"examples": [
|
|
||||||
"unix:///var/run/docker.sock",
|
|
||||||
"tcp://127.0.0.1:2375",
|
|
||||||
"ssh://user@host:port"
|
|
||||||
],
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"const": "$DOCKER_HOST",
|
|
||||||
"description": "Use DOCKER_HOST environment variable"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"pattern": "^unix://.+$",
|
|
||||||
"description": "A Unix socket for local Docker communication."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"pattern": "^ssh://.+$",
|
|
||||||
"description": "An SSH connection to a remote Docker host."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"pattern": "^fd://.+$",
|
|
||||||
"description": "A file descriptor for Docker communication."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"pattern": "^tcp://.+$",
|
|
||||||
"description": "A TCP connection to a remote Docker host."
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"notification": {
|
|
||||||
"description": "Notification provider configuration",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"name",
|
|
||||||
"provider"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"name": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Notifier name"
|
|
||||||
},
|
|
||||||
"provider": {
|
|
||||||
"description": "Notifier provider",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"gotify",
|
|
||||||
"webhook"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"description": "Gotify configuration",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"name": {},
|
|
||||||
"provider": {
|
|
||||||
"const": "gotify"
|
|
||||||
},
|
|
||||||
"url": {
|
|
||||||
"description": "Gotify URL",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"token": {
|
|
||||||
"description": "Gotify token",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"url",
|
|
||||||
"token"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"description": "Webhook configuration",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"name": {},
|
|
||||||
"provider": {
|
|
||||||
"const": "webhook"
|
|
||||||
},
|
|
||||||
"url": {
|
|
||||||
"description": "Webhook URL",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"token": {
|
|
||||||
"description": "Webhook bearer token",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"template": {
|
|
||||||
"description": "Webhook template",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"discord"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"payload": {
|
|
||||||
"description": "Webhook payload",
|
|
||||||
"type": "string",
|
|
||||||
"format": "json"
|
|
||||||
},
|
|
||||||
"method": {
|
|
||||||
"description": "Webhook request method",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"GET",
|
|
||||||
"POST",
|
|
||||||
"PUT"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"mime_type": {
|
|
||||||
"description": "Webhook NIME type",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"color_mode": {
|
|
||||||
"description": "Webhook color mode",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"hex",
|
|
||||||
"dec"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"url"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"match_domains": {
|
|
||||||
"title": "Domains to match",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"minItems": 1
|
|
||||||
},
|
|
||||||
"homepage": {
|
|
||||||
"title": "Homepage configuration",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"use_default_categories": {
|
|
||||||
"title": "Use default categories",
|
|
||||||
"type": "boolean"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"entrypoint": {
|
|
||||||
"title": "Entrypoint configuration",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"middlewares": {
|
|
||||||
"title": "Entrypoint middlewares",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"use"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"use": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Middleware to use"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"access_log": {
|
|
||||||
"$ref": "https://github.com/yusing/go-proxy/raw/v0.8/schema/access_log.json"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"timeout_shutdown": {
|
|
||||||
"title": "Shutdown timeout (in seconds)",
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 0
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": [
|
|
||||||
"providers"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
@ -1,290 +0,0 @@
|
||||||
{
|
|
||||||
"$id": "https://github.com/yusing/go-proxy/raw/v0.8/schema/providers.schema.json",
|
|
||||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
||||||
"title": "GoDoxy standalone include file",
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "object"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"patternProperties": {
|
|
||||||
".+": {
|
|
||||||
"title": "Proxy entry",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"scheme": {
|
|
||||||
"title": "Proxy scheme",
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"http",
|
|
||||||
"https",
|
|
||||||
"tcp",
|
|
||||||
"udp",
|
|
||||||
"tcp:tcp",
|
|
||||||
"udp:udp",
|
|
||||||
"tcp:udp",
|
|
||||||
"udp:tcp"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "null",
|
|
||||||
"description": "Auto detect base on port format"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"host": {
|
|
||||||
"default": "localhost",
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
"type": "null",
|
|
||||||
"title": "localhost (default)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"format": "ipv4",
|
|
||||||
"title": "ipv4 address"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"format": "ipv6",
|
|
||||||
"title": "ipv6 address"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"format": "hostname",
|
|
||||||
"title": "hostname"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"title": "Proxy host (ipv4/6 / hostname)"
|
|
||||||
},
|
|
||||||
"port": {},
|
|
||||||
"no_tls_verify": {},
|
|
||||||
"path_patterns": {},
|
|
||||||
"middlewares": {},
|
|
||||||
"homepage": {
|
|
||||||
"title": "Dashboard config",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"show": {
|
|
||||||
"title": "Show on dashboard",
|
|
||||||
"type": "boolean",
|
|
||||||
"default": true
|
|
||||||
},
|
|
||||||
"name": {
|
|
||||||
"title": "Display name",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"title": "Display icon",
|
|
||||||
"type": "string",
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"pattern": "^(png|svg|webp)\\/[\\w\\d\\-_]+\\.\\1$",
|
|
||||||
"title": "Icon from walkxcode/dashboard-icons"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"pattern": "^https?://",
|
|
||||||
"title": "Absolute URI",
|
|
||||||
"format": "uri"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"pattern": "^@target/",
|
|
||||||
"title": "Relative URI to target"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"url": {
|
|
||||||
"title": "App URL override",
|
|
||||||
"type": "string",
|
|
||||||
"format": "uri",
|
|
||||||
"pattern": "^https?://"
|
|
||||||
},
|
|
||||||
"category": {
|
|
||||||
"title": "Category",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"description": {
|
|
||||||
"title": "Description",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"widget_config": {
|
|
||||||
"title": "Widget config",
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"load_balance": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"link": {
|
|
||||||
"type": "string",
|
|
||||||
"title": "Name and subdomain of load-balancer"
|
|
||||||
},
|
|
||||||
"mode": {
|
|
||||||
"enum": [
|
|
||||||
"round_robin",
|
|
||||||
"least_conn",
|
|
||||||
"ip_hash"
|
|
||||||
],
|
|
||||||
"title": "Load-balance mode",
|
|
||||||
"default": "roundrobin"
|
|
||||||
},
|
|
||||||
"weight": {
|
|
||||||
"type": "integer",
|
|
||||||
"title": "Reserved for future use",
|
|
||||||
"minimum": 0,
|
|
||||||
"maximum": 100
|
|
||||||
},
|
|
||||||
"options": {
|
|
||||||
"type": "object",
|
|
||||||
"title": "load-balance mode specific options"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"healthcheck": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"disable": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"title": "Disable healthcheck"
|
|
||||||
},
|
|
||||||
"path": {
|
|
||||||
"type": "string",
|
|
||||||
"title": "Healthcheck path",
|
|
||||||
"default": "/",
|
|
||||||
"format": "uri-reference",
|
|
||||||
"description": "should start with `/`"
|
|
||||||
},
|
|
||||||
"use_get": {
|
|
||||||
"type": "boolean",
|
|
||||||
"title": "Use GET instead of HEAD",
|
|
||||||
"default": false
|
|
||||||
},
|
|
||||||
"interval": {
|
|
||||||
"type": "string",
|
|
||||||
"title": "healthcheck Interval",
|
|
||||||
"pattern": "^([0-9]+(ms|s|m|h))+$",
|
|
||||||
"default": "5s",
|
|
||||||
"description": "e.g. 5s, 1m, 2h, 3m30s"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"access_log": {
|
|
||||||
"$ref": "https://github.com/yusing/go-proxy/raw/v0.8/schema/access_log.json"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"if": {
|
|
||||||
"properties": {
|
|
||||||
"scheme": {
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
"enum": [
|
|
||||||
"http",
|
|
||||||
"https"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "null"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"then": {
|
|
||||||
"properties": {
|
|
||||||
"port": {
|
|
||||||
"title": "Proxy port",
|
|
||||||
"markdownDescription": "From **0** to **65535**",
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^\\d{1,5}$",
|
|
||||||
"patternErrorMessage": "`port` must be a number"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 0,
|
|
||||||
"maximum": 65535
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"path_patterns": {
|
|
||||||
"title": "Path patterns",
|
|
||||||
"type": "array",
|
|
||||||
"markdownDescription": "See https://pkg.go.dev/net/http#hdr-Patterns-ServeMux",
|
|
||||||
"items": {
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^(?:([A-Z]+) )?(?:([a-zA-Z0-9.-]+)\\/)?(\\/[^\\s]*)$",
|
|
||||||
"patternErrorMessage": "invalid path pattern"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"middlewares": {
|
|
||||||
"type": "object"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"else": {
|
|
||||||
"properties": {
|
|
||||||
"port": {
|
|
||||||
"markdownDescription": "`listening port:proxy port` or `listening port:service name`",
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^[0-9]+:[0-9a-z]+$",
|
|
||||||
"patternErrorMessage": "invalid syntax"
|
|
||||||
},
|
|
||||||
"no_tls_verify": {
|
|
||||||
"not": true
|
|
||||||
},
|
|
||||||
"path_patterns": {
|
|
||||||
"not": true
|
|
||||||
},
|
|
||||||
"middlewares": {
|
|
||||||
"not": true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"port"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"if": {
|
|
||||||
"properties": {
|
|
||||||
"scheme": {
|
|
||||||
"const": "https"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"then": {
|
|
||||||
"properties": {
|
|
||||||
"no_tls_verify": {
|
|
||||||
"title": "Disable TLS verification for https proxy",
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"else": {
|
|
||||||
"properties": {
|
|
||||||
"no_tls_verify": {
|
|
||||||
"not": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
1595
schemas/config.schema.json
Normal file
1595
schemas/config.schema.json
Normal file
File diff suppressed because it is too large
Load diff
69
schemas/config/access_log.ts
Normal file
69
schemas/config/access_log.ts
Normal file
|
|
@ -0,0 +1,69 @@
|
||||||
|
import { CIDR, HTTPHeader, HTTPMethod, StatusCodeRange, URI } from "../types";
|
||||||
|
|
||||||
|
export const ACCESS_LOG_FORMATS = ["combined", "common", "json"] as const;
|
||||||
|
|
||||||
|
export type AccessLogFormat = (typeof ACCESS_LOG_FORMATS)[number];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type AccessLogConfig = {
|
||||||
|
/**
|
||||||
|
* The size of the buffer.
|
||||||
|
*
|
||||||
|
* @minimum 0
|
||||||
|
* @default 65536
|
||||||
|
* @TJS-type integer
|
||||||
|
*/
|
||||||
|
buffer_size?: number;
|
||||||
|
/** The format of the access log.
|
||||||
|
*
|
||||||
|
* @default "combined"
|
||||||
|
*/
|
||||||
|
format?: AccessLogFormat;
|
||||||
|
/* The path to the access log file. */
|
||||||
|
path: URI;
|
||||||
|
/* The access log filters. */
|
||||||
|
filters?: AccessLogFilters;
|
||||||
|
/* The access log fields. */
|
||||||
|
fields?: AccessLogFields;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type AccessLogFilter<T> = {
|
||||||
|
/** Whether the filter is negative.
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
negative?: boolean;
|
||||||
|
/* The values to filter. */
|
||||||
|
values: T[];
|
||||||
|
};
|
||||||
|
|
||||||
|
export type AccessLogFilters = {
|
||||||
|
/* Status code filter. */
|
||||||
|
status_code?: AccessLogFilter<StatusCodeRange>;
|
||||||
|
/* Method filter. */
|
||||||
|
method?: AccessLogFilter<HTTPMethod>;
|
||||||
|
/* Host filter. */
|
||||||
|
host?: AccessLogFilter<string>;
|
||||||
|
/* Header filter. */
|
||||||
|
headers?: AccessLogFilter<HTTPHeader>;
|
||||||
|
/* CIDR filter. */
|
||||||
|
cidr?: AccessLogFilter<CIDR>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const ACCESS_LOG_FIELD_MODES = ["keep", "drop", "redact"] as const;
|
||||||
|
export type AccessLogFieldMode = (typeof ACCESS_LOG_FIELD_MODES)[number];
|
||||||
|
|
||||||
|
export type AccessLogField = {
|
||||||
|
default?: AccessLogFieldMode;
|
||||||
|
config: {
|
||||||
|
[key: string]: AccessLogFieldMode;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type AccessLogFields = {
|
||||||
|
header?: AccessLogField;
|
||||||
|
query?: AccessLogField;
|
||||||
|
cookie?: AccessLogField;
|
||||||
|
};
|
||||||
103
schemas/config/autocert.ts
Normal file
103
schemas/config/autocert.ts
Normal file
|
|
@ -0,0 +1,103 @@
|
||||||
|
import { DomainOrWildcards as DomainsOrWildcards, Email } from "../types";
|
||||||
|
|
||||||
|
export const AUTOCERT_PROVIDERS = [
|
||||||
|
"local",
|
||||||
|
"cloudflare",
|
||||||
|
"clouddns",
|
||||||
|
"duckdns",
|
||||||
|
"ovh",
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
export type AutocertProvider = (typeof AUTOCERT_PROVIDERS)[number];
|
||||||
|
|
||||||
|
export type AutocertConfig =
|
||||||
|
| CloudflareOptions
|
||||||
|
| CloudDNSOptions
|
||||||
|
| DuckDNSOptions
|
||||||
|
| OVHOptionsWithAppKey
|
||||||
|
| OVHOptionsWithOAuth2Config;
|
||||||
|
|
||||||
|
export interface AutocertConfigBase {
|
||||||
|
/* ACME email */
|
||||||
|
email: Email;
|
||||||
|
/* ACME domains */
|
||||||
|
domains: DomainsOrWildcards;
|
||||||
|
/* ACME certificate path */
|
||||||
|
cert_path?: string;
|
||||||
|
/* ACME key path */
|
||||||
|
key_path?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export interface CloudflareOptions extends AutocertConfigBase {
|
||||||
|
provider: "cloudflare";
|
||||||
|
options: { auth_token: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export interface CloudDNSOptions extends AutocertConfigBase {
|
||||||
|
provider: "clouddns";
|
||||||
|
options: {
|
||||||
|
client_id: string;
|
||||||
|
/**
|
||||||
|
* @format email
|
||||||
|
*/
|
||||||
|
email: Email;
|
||||||
|
password: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export interface DuckDNSOptions extends AutocertConfigBase {
|
||||||
|
provider: "duckdns";
|
||||||
|
options: {
|
||||||
|
token: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export const OVH_ENDPOINTS = [
|
||||||
|
"ovh-eu",
|
||||||
|
"ovh-ca",
|
||||||
|
"ovh-us",
|
||||||
|
"kimsufi-eu",
|
||||||
|
"kimsufi-ca",
|
||||||
|
"soyoustart-eu",
|
||||||
|
"soyoustart-ca",
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
export type OVHEndpoint = (typeof OVH_ENDPOINTS)[number];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export interface OVHOptionsWithAppKey extends AutocertConfigBase {
|
||||||
|
provider: "ovh";
|
||||||
|
options: {
|
||||||
|
application_secret: string;
|
||||||
|
consumer_key: string;
|
||||||
|
api_endpoint?: OVHEndpoint;
|
||||||
|
application_key: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export interface OVHOptionsWithOAuth2Config extends AutocertConfigBase {
|
||||||
|
provider: "ovh";
|
||||||
|
options: {
|
||||||
|
application_secret: string;
|
||||||
|
consumer_key: string;
|
||||||
|
api_endpoint?: OVHEndpoint;
|
||||||
|
oauth2_config: {
|
||||||
|
client_id: string;
|
||||||
|
client_secret: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
}
|
||||||
55
schemas/config/config.ts
Normal file
55
schemas/config/config.ts
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
import { DomainNames } from "../types";
|
||||||
|
import { AutocertConfig } from "./autocert";
|
||||||
|
import { EntrypointConfig } from "./entrypoint";
|
||||||
|
import { HomepageConfig } from "./homepage";
|
||||||
|
import { Providers } from "./providers";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type Config = {
|
||||||
|
/** Optional autocert configuration
|
||||||
|
*
|
||||||
|
* @examples require(".").autocertExamples
|
||||||
|
*/
|
||||||
|
autocert?: AutocertConfig;
|
||||||
|
/* Optional entrypoint configuration */
|
||||||
|
entrypoint?: EntrypointConfig;
|
||||||
|
/* Providers configuration (include file, docker, notification) */
|
||||||
|
providers: Providers;
|
||||||
|
/** Optional list of domains to match
|
||||||
|
*
|
||||||
|
* @minItems 1
|
||||||
|
* @examples require(".").matchDomainsExamples
|
||||||
|
*/
|
||||||
|
match_domains?: DomainNames;
|
||||||
|
/* Optional homepage configuration */
|
||||||
|
homepage?: HomepageConfig;
|
||||||
|
/**
|
||||||
|
* Optional timeout before shutdown
|
||||||
|
* @default 3
|
||||||
|
* @minimum 1
|
||||||
|
*/
|
||||||
|
timeout_shutdown?: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const autocertExamples = [
|
||||||
|
{ provider: "local" },
|
||||||
|
{
|
||||||
|
provider: "cloudflare",
|
||||||
|
email: "abc@gmail",
|
||||||
|
domains: ["example.com"],
|
||||||
|
options: { auth_token: "c1234565789-abcdefghijklmnopqrst" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
provider: "clouddns",
|
||||||
|
email: "abc@gmail",
|
||||||
|
domains: ["example.com"],
|
||||||
|
options: {
|
||||||
|
client_id: "c1234565789",
|
||||||
|
email: "abc@gmail",
|
||||||
|
password: "password",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
export const matchDomainsExamples = ["example.com", "*.example.com"] as const;
|
||||||
50
schemas/config/entrypoint.ts
Normal file
50
schemas/config/entrypoint.ts
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
import { MiddlewareComposeConfig } from "../middlewares/middleware_compose";
|
||||||
|
import { AccessLogConfig } from "./access_log";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type EntrypointConfig = {
|
||||||
|
/** Entrypoint middleware configuration
|
||||||
|
*
|
||||||
|
* @examples require(".").middlewaresExamples
|
||||||
|
*/
|
||||||
|
middlewares: MiddlewareComposeConfig;
|
||||||
|
/** Entrypoint access log configuration
|
||||||
|
*
|
||||||
|
* @examples require(".").accessLogExamples
|
||||||
|
*/
|
||||||
|
access_log?: AccessLogConfig;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const accessLogExamples = [
|
||||||
|
{
|
||||||
|
path: "/var/log/access.log",
|
||||||
|
format: "combined",
|
||||||
|
filters: {
|
||||||
|
status_codes: {
|
||||||
|
values: ["200-299"],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
fields: {
|
||||||
|
headers: {
|
||||||
|
default: "keep",
|
||||||
|
config: {
|
||||||
|
foo: "redact",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
export const middlewaresExamples = [
|
||||||
|
{
|
||||||
|
use: "RedirectHTTP",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
use: "CIDRWhitelist",
|
||||||
|
allow: ["127.0.0.1", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"],
|
||||||
|
status: 403,
|
||||||
|
message: "Forbidden",
|
||||||
|
},
|
||||||
|
] as const;
|
||||||
10
schemas/config/homepage.ts
Normal file
10
schemas/config/homepage.ts
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type HomepageConfig = {
|
||||||
|
/**
|
||||||
|
* Use default app categories (uses docker image name)
|
||||||
|
* @default true
|
||||||
|
*/
|
||||||
|
use_default_categories: boolean;
|
||||||
|
};
|
||||||
77
schemas/config/notification.ts
Normal file
77
schemas/config/notification.ts
Normal file
|
|
@ -0,0 +1,77 @@
|
||||||
|
import { URL } from "../types";
|
||||||
|
|
||||||
|
export const NOTIFICATION_PROVIDERS = ["webhook", "gotify"] as const;
|
||||||
|
|
||||||
|
export type NotificationProvider = (typeof NOTIFICATION_PROVIDERS)[number];
|
||||||
|
|
||||||
|
export type NotificationConfig = {
|
||||||
|
/**
|
||||||
|
* Name of the notification provider
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
/**
|
||||||
|
* URL of the notification provider
|
||||||
|
*/
|
||||||
|
url: URL;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export interface GotifyConfig extends NotificationConfig {
|
||||||
|
provider: "gotify";
|
||||||
|
/* Gotify token */
|
||||||
|
token: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const WEBHOOK_TEMPLATES = ["discord"] as const;
|
||||||
|
export const WEBHOOK_METHODS = ["POST", "GET", "PUT"] as const;
|
||||||
|
export const WEBHOOK_MIME_TYPES = [
|
||||||
|
"application/json",
|
||||||
|
"application/x-www-form-urlencoded",
|
||||||
|
"text/plain",
|
||||||
|
] as const;
|
||||||
|
export const WEBHOOK_COLOR_MODES = ["hex", "dec"] as const;
|
||||||
|
|
||||||
|
export type WebhookTemplate = (typeof WEBHOOK_TEMPLATES)[number];
|
||||||
|
export type WebhookMethod = (typeof WEBHOOK_METHODS)[number];
|
||||||
|
export type WebhookMimeType = (typeof WEBHOOK_MIME_TYPES)[number];
|
||||||
|
export type WebhookColorMode = (typeof WEBHOOK_COLOR_MODES)[number];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export interface WebhookConfig extends NotificationConfig {
|
||||||
|
provider: "webhook";
|
||||||
|
/**
|
||||||
|
* Webhook template
|
||||||
|
*
|
||||||
|
* @default "discord"
|
||||||
|
*/
|
||||||
|
template?: WebhookTemplate;
|
||||||
|
/* Webhook token */
|
||||||
|
token?: string;
|
||||||
|
/**
|
||||||
|
* Webhook message (usally JSON),
|
||||||
|
* required when template is not defined
|
||||||
|
*/
|
||||||
|
payload?: string;
|
||||||
|
/**
|
||||||
|
* Webhook method
|
||||||
|
*
|
||||||
|
* @default "POST"
|
||||||
|
*/
|
||||||
|
method?: WebhookMethod;
|
||||||
|
/**
|
||||||
|
* Webhook mime type
|
||||||
|
*
|
||||||
|
* @default "application/json"
|
||||||
|
*/
|
||||||
|
mime_type?: WebhookMimeType;
|
||||||
|
/**
|
||||||
|
* Webhook color mode
|
||||||
|
*
|
||||||
|
* @default "hex"
|
||||||
|
*/
|
||||||
|
color_mode?: WebhookColorMode;
|
||||||
|
}
|
||||||
49
schemas/config/providers.ts
Normal file
49
schemas/config/providers.ts
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
import { URI, URL } from "../types";
|
||||||
|
import { GotifyConfig, WebhookConfig } from "./notification";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
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
|
||||||
|
* @items.pattern ^((\w+://)[^\s]+)|\$DOCKER_HOST$
|
||||||
|
*/
|
||||||
|
docker?: { [name: string]: URL };
|
||||||
|
/** List of notification providers
|
||||||
|
*
|
||||||
|
* @minItems 1
|
||||||
|
* @examples require(".").notificationExamples
|
||||||
|
*/
|
||||||
|
notification?: (WebhookConfig | GotifyConfig)[];
|
||||||
|
};
|
||||||
|
|
||||||
|
export const includeExamples = ["file1.yml", "file2.yml"] as const;
|
||||||
|
export const dockerExamples = [
|
||||||
|
{ local: "$DOCKER_HOST" },
|
||||||
|
{ remote: "tcp://10.0.2.1:2375" },
|
||||||
|
{ remote2: "ssh://root:1234@10.0.2.2" },
|
||||||
|
] as const;
|
||||||
|
export const notificationExamples = [
|
||||||
|
{
|
||||||
|
name: "gotify",
|
||||||
|
provider: "gotify",
|
||||||
|
url: "https://gotify.domain.tld",
|
||||||
|
token: "abcd",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "discord",
|
||||||
|
provider: "webhook",
|
||||||
|
template: "discord",
|
||||||
|
url: "https://discord.com/api/webhooks/1234/abcd",
|
||||||
|
},
|
||||||
|
] as const;
|
||||||
7
schemas/docker.ts
Normal file
7
schemas/docker.ts
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
import { IdleWatcherConfig } from "./providers/idlewatcher";
|
||||||
|
import { Route } from "./providers/routes";
|
||||||
|
|
||||||
|
//FIXME: fix this
|
||||||
|
export type DockerRoutes = {
|
||||||
|
[key: string]: Route & IdleWatcherConfig;
|
||||||
|
};
|
||||||
761
schemas/middleware_compose.schema.json
Normal file
761
schemas/middleware_compose.schema.json
Normal file
|
|
@ -0,0 +1,761 @@
|
||||||
|
{
|
||||||
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"definitions": {
|
||||||
|
"CIDR": {
|
||||||
|
"anyOf": [
|
||||||
|
{
|
||||||
|
"pattern": "^[0-9]*\\.[0-9]*\\.[0-9]*\\.[0-9]*$",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"pattern": "^.*:.*:.*:.*:.*:.*:.*:.*$",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"pattern": "^[0-9]*\\.[0-9]*\\.[0-9]*\\.[0-9]*/[0-9]*$",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"pattern": "^::[0-9]*$",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"pattern": "^.*::/[0-9]*$",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"pattern": "^.*:.*::/[0-9]*$",
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"Partial<CIDRWhitelist>": {
|
||||||
|
"properties": {
|
||||||
|
"allow": {
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/definitions/CIDR"
|
||||||
|
},
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
"message": {
|
||||||
|
"default": "IP not allowed",
|
||||||
|
"description": "Error message when blocked",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"status_code": {
|
||||||
|
"$ref": "#/definitions/StatusCode",
|
||||||
|
"default": 403,
|
||||||
|
"description": "HTTP status code when blocked"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<CloudflareRealIP>": {
|
||||||
|
"properties": {
|
||||||
|
"recursive": {
|
||||||
|
"default": false,
|
||||||
|
"description": "Recursively resolve the IP",
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<CustomErrorPage>": {
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<HideXForwarded>": {
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<ModifyRequest>": {
|
||||||
|
"properties": {
|
||||||
|
"add_headers": {
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"description": "Add HTTP headers",
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"hide_headers": {
|
||||||
|
"description": "Hide HTTP headers",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
"set_headers": {
|
||||||
|
"additionalProperties": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"description": "Set HTTP headers",
|
||||||
|
"type": "object"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<OIDC>": {
|
||||||
|
"properties": {
|
||||||
|
"allowed_groups": {
|
||||||
|
"description": "Allowed groups",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"minItems": 1,
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
"allowed_users": {
|
||||||
|
"description": "Allowed users",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"minItems": 1,
|
||||||
|
"type": "array"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<RateLimit>": {
|
||||||
|
"properties": {
|
||||||
|
"average": {
|
||||||
|
"description": "Average number of requests allowed in a period",
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
"burst": {
|
||||||
|
"description": "Maximum number of requests allowed in a period",
|
||||||
|
"type": "number"
|
||||||
|
},
|
||||||
|
"period": {
|
||||||
|
"default": "1s",
|
||||||
|
"description": "Duration of the rate limit",
|
||||||
|
"pattern": "^([0-9]+(ms|s|m|h))+$",
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<RealIP>": {
|
||||||
|
"properties": {
|
||||||
|
"from": {
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/definitions/CIDR"
|
||||||
|
},
|
||||||
|
"type": "array"
|
||||||
|
},
|
||||||
|
"header": {
|
||||||
|
"description": "Header to get the client IP from",
|
||||||
|
"pattern": "^[a-zA-Z0-9\\-]+$",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"recursive": {
|
||||||
|
"default": false,
|
||||||
|
"description": "Recursive resolve the IP",
|
||||||
|
"type": "boolean"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<RedirectHTTP>": {
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"Partial<SetXForwarded>": {
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
"StatusCode": {
|
||||||
|
"anyOf": [
|
||||||
|
{
|
||||||
|
"pattern": "^[0-9]*$",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "number"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"items": {
|
||||||
|
"anyOf": [
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<RedirectHTTP>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<OIDC>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<ModifyRequest>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<SetXForwarded>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<HideXForwarded>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<CustomErrorPage>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<RealIP>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<CloudflareRealIP>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<RateLimit>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"properties": {
|
||||||
|
"use": {
|
||||||
|
"enum": [
|
||||||
|
"CIDRWhitelist",
|
||||||
|
"CloudflareRealIP",
|
||||||
|
"CustomErrorPage",
|
||||||
|
"HideXForwarded",
|
||||||
|
"ModifyRequest",
|
||||||
|
"ModifyResponse",
|
||||||
|
"OIDC",
|
||||||
|
"RateLimit",
|
||||||
|
"RealIP",
|
||||||
|
"RedirectHTTP",
|
||||||
|
"Request",
|
||||||
|
"Response",
|
||||||
|
"SetXForwarded",
|
||||||
|
"cidrWhitelist",
|
||||||
|
"cidr_whitelist",
|
||||||
|
"cloudflareRealIP",
|
||||||
|
"cloudflare_real_ip",
|
||||||
|
"customErrorPage",
|
||||||
|
"custom_error_page",
|
||||||
|
"errorPage",
|
||||||
|
"error_page",
|
||||||
|
"hideXForwarded",
|
||||||
|
"hide_x_forwarded",
|
||||||
|
"modifyRequest",
|
||||||
|
"modifyResponse",
|
||||||
|
"modify_request",
|
||||||
|
"modify_response",
|
||||||
|
"oidc",
|
||||||
|
"rateLimit",
|
||||||
|
"rate_limit",
|
||||||
|
"realIP",
|
||||||
|
"real_ip",
|
||||||
|
"redirectHTTP",
|
||||||
|
"redirect_http",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"setXForwarded",
|
||||||
|
"set_x_forwarded"
|
||||||
|
],
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"use"
|
||||||
|
],
|
||||||
|
"type": "object"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/definitions/Partial<CIDRWhitelist>"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"type": "array"
|
||||||
|
}
|
||||||
|
|
||||||
11
schemas/middlewares/middleware_compose.ts
Normal file
11
schemas/middlewares/middleware_compose.ts
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
import { MiddlewaresMap } from "./middlewares";
|
||||||
|
|
||||||
|
export type MiddlewareComposeConfigBase = {
|
||||||
|
use: keyof MiddlewaresMap;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type MiddlewareComposeConfig = (MiddlewareComposeConfigBase &
|
||||||
|
Partial<MiddlewaresMap[keyof MiddlewaresMap]>)[];
|
||||||
161
schemas/middlewares/middlewares.ts
Normal file
161
schemas/middlewares/middlewares.ts
Normal file
|
|
@ -0,0 +1,161 @@
|
||||||
|
import * as types from "../types";
|
||||||
|
|
||||||
|
export type MiddlewaresMap = {
|
||||||
|
redirect_http?: RedirectHTTP;
|
||||||
|
redirectHTTP?: RedirectHTTP;
|
||||||
|
RedirectHTTP?: RedirectHTTP;
|
||||||
|
oidc?: OIDC;
|
||||||
|
OIDC?: OIDC;
|
||||||
|
request?: ModifyRequest;
|
||||||
|
Request?: ModifyRequest;
|
||||||
|
modify_request?: ModifyRequest;
|
||||||
|
modifyRequest?: ModifyRequest;
|
||||||
|
ModifyRequest?: ModifyRequest;
|
||||||
|
response?: ModifyResponse;
|
||||||
|
Response?: ModifyResponse;
|
||||||
|
modify_response?: ModifyResponse;
|
||||||
|
modifyResponse?: ModifyResponse;
|
||||||
|
ModifyResponse?: ModifyResponse;
|
||||||
|
set_x_forwarded?: SetXForwarded;
|
||||||
|
setXForwarded?: SetXForwarded;
|
||||||
|
SetXForwarded?: SetXForwarded;
|
||||||
|
hide_x_forwarded?: HideXForwarded;
|
||||||
|
hideXForwarded?: HideXForwarded;
|
||||||
|
HideXForwarded?: HideXForwarded;
|
||||||
|
error_page?: CustomErrorPage;
|
||||||
|
errorPage?: CustomErrorPage;
|
||||||
|
custom_error_page?: CustomErrorPage;
|
||||||
|
customErrorPage?: CustomErrorPage;
|
||||||
|
CustomErrorPage?: CustomErrorPage;
|
||||||
|
real_ip?: RealIP;
|
||||||
|
realIP?: RealIP;
|
||||||
|
RealIP?: RealIP;
|
||||||
|
cloudflare_real_ip?: CloudflareRealIP;
|
||||||
|
cloudflareRealIP?: CloudflareRealIP;
|
||||||
|
CloudflareRealIP?: CloudflareRealIP;
|
||||||
|
rate_limit?: RateLimit;
|
||||||
|
rateLimit?: RateLimit;
|
||||||
|
RateLimit?: RateLimit;
|
||||||
|
cidr_whitelist?: CIDRWhitelist;
|
||||||
|
cidrWhitelist?: CIDRWhitelist;
|
||||||
|
CIDRWhitelist?: CIDRWhitelist;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type CustomErrorPage = {};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type CIDRWhitelist = {
|
||||||
|
/* Allowed CIDRs/IPs */
|
||||||
|
allow: types.CIDR[];
|
||||||
|
/** HTTP status code when blocked
|
||||||
|
*
|
||||||
|
* @default 403
|
||||||
|
*/
|
||||||
|
status_code?: types.StatusCode;
|
||||||
|
/** Error message when blocked
|
||||||
|
*
|
||||||
|
* @default "IP not allowed"
|
||||||
|
*/
|
||||||
|
message?: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type CloudflareRealIP = {
|
||||||
|
/** Recursively resolve the IP
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
recursive?: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type ModifyRequest = {
|
||||||
|
/** Set HTTP headers */
|
||||||
|
set_headers?: { [key: types.HTTPHeader]: string };
|
||||||
|
/** Add HTTP headers */
|
||||||
|
add_headers?: { [key: types.HTTPHeader]: string };
|
||||||
|
/** Hide HTTP headers */
|
||||||
|
hide_headers?: types.HTTPHeader[];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type ModifyResponse = ModifyRequest;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type OIDC = {
|
||||||
|
/** Allowed users
|
||||||
|
*
|
||||||
|
* @minItems 1
|
||||||
|
*/
|
||||||
|
allowed_users?: string[];
|
||||||
|
/** Allowed groups
|
||||||
|
*
|
||||||
|
* @minItems 1
|
||||||
|
*/
|
||||||
|
allowed_groups?: string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type RateLimit = {
|
||||||
|
/** Average number of requests allowed in a period
|
||||||
|
*
|
||||||
|
* @min 1
|
||||||
|
*/
|
||||||
|
average: number;
|
||||||
|
/** Maximum number of requests allowed in a period
|
||||||
|
*
|
||||||
|
* @min 1
|
||||||
|
*/
|
||||||
|
burst: number;
|
||||||
|
/** Duration of the rate limit
|
||||||
|
*
|
||||||
|
* @default 1s
|
||||||
|
*/
|
||||||
|
period?: types.Duration;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type RealIP = {
|
||||||
|
/** Header to get the client IP from
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
header: types.HTTPHeader;
|
||||||
|
from: types.CIDR[];
|
||||||
|
/** Recursive resolve the IP
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
recursive: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type RedirectHTTP = {};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type SetXForwarded = {};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type HideXForwarded = {};
|
||||||
33
schemas/providers/healthcheck.ts
Normal file
33
schemas/providers/healthcheck.ts
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
import { Duration, URI } from "../types";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type HealthcheckConfig = {
|
||||||
|
/** Disable healthcheck
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
disable?: boolean;
|
||||||
|
/** Healthcheck path
|
||||||
|
*
|
||||||
|
* @default /
|
||||||
|
*/
|
||||||
|
path?: URI;
|
||||||
|
/**
|
||||||
|
* Use GET instead of HEAD
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
use_get?: boolean;
|
||||||
|
/** Healthcheck interval
|
||||||
|
*
|
||||||
|
* @default 5s
|
||||||
|
*/
|
||||||
|
interval?: Duration;
|
||||||
|
/** Healthcheck timeout
|
||||||
|
*
|
||||||
|
* @default 5s
|
||||||
|
*/
|
||||||
|
timeout?: Duration;
|
||||||
|
};
|
||||||
31
schemas/providers/homepage.ts
Normal file
31
schemas/providers/homepage.ts
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
import { URL } from "../types";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type HomepageConfig = {
|
||||||
|
/* Display name on dashboard */
|
||||||
|
name: string;
|
||||||
|
/* Display icon on dashboard */
|
||||||
|
icon?: URL | WalkxcodeIcon | TargetRelativeIconPath;
|
||||||
|
/* App description */
|
||||||
|
description?: string;
|
||||||
|
/* Override url */
|
||||||
|
url?: URL;
|
||||||
|
/* App category */
|
||||||
|
category?: string;
|
||||||
|
/* Widget config */
|
||||||
|
widget_config?: {
|
||||||
|
[key: string]: any;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @pattern ^(png|svg|webp)\\/[\\w\\d\\-_]+\\.\\1$
|
||||||
|
*/
|
||||||
|
export type WalkxcodeIcon = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @pattern ^@target/.+$
|
||||||
|
*/
|
||||||
|
export type TargetRelativeIconPath = string;
|
||||||
45
schemas/providers/idlewatcher.ts
Normal file
45
schemas/providers/idlewatcher.ts
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
import { Duration, URI } from "../types";
|
||||||
|
|
||||||
|
export const STOP_METHODS = ["pause", "stop", "kill"] as const;
|
||||||
|
export type StopMethod = (typeof STOP_METHODS)[number];
|
||||||
|
|
||||||
|
export const STOP_SIGNALS = [
|
||||||
|
"",
|
||||||
|
"SIGINT",
|
||||||
|
"SIGTERM",
|
||||||
|
"SIGHUP",
|
||||||
|
"SIGQUIT",
|
||||||
|
"INT",
|
||||||
|
"TERM",
|
||||||
|
"HUP",
|
||||||
|
"QUIT",
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
export type Signal = (typeof STOP_SIGNALS)[number];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type IdleWatcherConfig = {
|
||||||
|
/* Idle timeout */
|
||||||
|
idle_timeout?: Duration;
|
||||||
|
/** Wake timeout
|
||||||
|
*
|
||||||
|
* @default 30s
|
||||||
|
*/
|
||||||
|
wake_timeout?: Duration;
|
||||||
|
/** Stop timeout
|
||||||
|
*
|
||||||
|
* @default 10s
|
||||||
|
*/
|
||||||
|
stop_timeout?: Duration;
|
||||||
|
/** Stop method
|
||||||
|
*
|
||||||
|
* @default stop
|
||||||
|
*/
|
||||||
|
stop_method?: StopMethod;
|
||||||
|
/* Stop signal */
|
||||||
|
stop_signal?: Signal;
|
||||||
|
/* Start endpoint (any path can wake the container if not specified) */
|
||||||
|
start_endpoint?: URI;
|
||||||
|
};
|
||||||
57
schemas/providers/loadbalance.ts
Normal file
57
schemas/providers/loadbalance.ts
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
import { RealIP } from "../middlewares/middlewares";
|
||||||
|
|
||||||
|
export const LOAD_BALANCE_MODES = [
|
||||||
|
"round_robin",
|
||||||
|
"least_conn",
|
||||||
|
"ip_hash",
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
export type LoadBalanceMode = (typeof LOAD_BALANCE_MODES)[number];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type LoadBalanceConfigBase = {
|
||||||
|
/** Alias (subdomain or FDN) of load-balancer
|
||||||
|
*
|
||||||
|
* @minLength 1
|
||||||
|
*/
|
||||||
|
link: string;
|
||||||
|
/** Load-balance weight (reserved for future use)
|
||||||
|
*
|
||||||
|
* @minimum 0
|
||||||
|
* @maximum 100
|
||||||
|
*/
|
||||||
|
weight?: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type LoadBalanceConfig = LoadBalanceConfigBase &
|
||||||
|
(
|
||||||
|
| RoundRobinLoadBalanceConfig
|
||||||
|
| LeastConnLoadBalanceConfig
|
||||||
|
| IPHashLoadBalanceConfig
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type IPHashLoadBalanceConfig = {
|
||||||
|
mode: "ip_hash";
|
||||||
|
/** Real IP config, header to get client IP from */
|
||||||
|
config: RealIP;
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type LeastConnLoadBalanceConfig = {
|
||||||
|
mode: "least_conn";
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type RoundRobinLoadBalanceConfig = {
|
||||||
|
mode: "round_robin";
|
||||||
|
};
|
||||||
120
schemas/providers/routes.ts
Normal file
120
schemas/providers/routes.ts
Normal file
|
|
@ -0,0 +1,120 @@
|
||||||
|
import { AccessLogConfig } from "../config/access_log";
|
||||||
|
import { accessLogExamples } from "../config/entrypoint";
|
||||||
|
import { MiddlewaresMap } from "../middlewares/middlewares";
|
||||||
|
import { Hostname, IPv4, IPv6, PathPattern, Port, StreamPort } from "../types";
|
||||||
|
import { HealthcheckConfig } from "./healthcheck";
|
||||||
|
import { HomepageConfig } from "./homepage";
|
||||||
|
import { LoadBalanceConfig } from "./loadbalance";
|
||||||
|
export const PROXY_SCHEMES = ["http", "https"] as const;
|
||||||
|
export const STREAM_SCHEMES = ["tcp", "udp"] as const;
|
||||||
|
|
||||||
|
export type ProxyScheme = (typeof PROXY_SCHEMES)[number];
|
||||||
|
export type StreamScheme = (typeof STREAM_SCHEMES)[number];
|
||||||
|
|
||||||
|
export type Route = ReverseProxyRoute | StreamRoute;
|
||||||
|
export type Routes = {
|
||||||
|
[key: string]: Route;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type ReverseProxyRoute = {
|
||||||
|
/** Alias (subdomain or FDN)
|
||||||
|
* @minLength 1
|
||||||
|
*/
|
||||||
|
alias?: string;
|
||||||
|
/** Proxy scheme
|
||||||
|
*
|
||||||
|
* @default http
|
||||||
|
*/
|
||||||
|
scheme?: ProxyScheme;
|
||||||
|
/** Proxy host
|
||||||
|
*
|
||||||
|
* @default localhost
|
||||||
|
*/
|
||||||
|
host?: Hostname | IPv4 | IPv6;
|
||||||
|
/** Proxy port
|
||||||
|
*
|
||||||
|
* @default 80
|
||||||
|
*/
|
||||||
|
port?: Port;
|
||||||
|
/** Skip TLS verification
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
no_tls_verify?: boolean;
|
||||||
|
/** Path patterns (only patterns that match will be proxied).
|
||||||
|
*
|
||||||
|
* See https://pkg.go.dev/net/http#hdr-Patterns-ServeMux
|
||||||
|
*/
|
||||||
|
path_patterns?: PathPattern[];
|
||||||
|
/** Healthcheck config */
|
||||||
|
healthcheck?: HealthcheckConfig;
|
||||||
|
/** Load balance config */
|
||||||
|
load_balance?: LoadBalanceConfig;
|
||||||
|
/** Middlewares */
|
||||||
|
middlewares?: MiddlewaresMap;
|
||||||
|
/** Homepage config
|
||||||
|
*
|
||||||
|
* @examples require(".").homepageExamples
|
||||||
|
*/
|
||||||
|
homepage?: HomepageConfig;
|
||||||
|
/** Access log config
|
||||||
|
*
|
||||||
|
* @examples require(".").accessLogExamples
|
||||||
|
*/
|
||||||
|
access_log?: AccessLogConfig;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @additionalProperties false
|
||||||
|
*/
|
||||||
|
export type StreamRoute = {
|
||||||
|
/** Alias (subdomain or FDN)
|
||||||
|
* @minLength 1
|
||||||
|
*/
|
||||||
|
alias?: string;
|
||||||
|
/** Stream scheme
|
||||||
|
*
|
||||||
|
* @default tcp
|
||||||
|
*/
|
||||||
|
scheme?: StreamScheme;
|
||||||
|
/** Stream host
|
||||||
|
*
|
||||||
|
* @default localhost
|
||||||
|
*/
|
||||||
|
host?: Hostname | IPv4 | IPv6;
|
||||||
|
/* Stream port */
|
||||||
|
port: StreamPort;
|
||||||
|
/** Healthcheck config */
|
||||||
|
healthcheck?: HealthcheckConfig;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const homepageExamples = [
|
||||||
|
{
|
||||||
|
name: "Sonarr",
|
||||||
|
icon: "png/sonarr.png",
|
||||||
|
category: "Arr suite",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "App",
|
||||||
|
icon: "@target/favicon.ico",
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
export const loadBalanceExamples = [
|
||||||
|
{
|
||||||
|
link: "flaresolverr",
|
||||||
|
mode: "round_robin",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
link: "service.domain.com",
|
||||||
|
mode: "ip_hash",
|
||||||
|
config: {
|
||||||
|
header: "X-Real-IP",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
export { accessLogExamples };
|
||||||
1311
schemas/routes.schema.json
Normal file
1311
schemas/routes.schema.json
Normal file
File diff suppressed because it is too large
Load diff
104
schemas/types.ts
Normal file
104
schemas/types.ts
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
export const HTTP_METHODS = [
|
||||||
|
"GET",
|
||||||
|
"POST",
|
||||||
|
"PUT",
|
||||||
|
"PATCH",
|
||||||
|
"DELETE",
|
||||||
|
"CONNECT",
|
||||||
|
"HEAD",
|
||||||
|
"OPTIONS",
|
||||||
|
"TRACE",
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
export type HTTPMethod = (typeof HTTP_METHODS)[number];
|
||||||
|
/**
|
||||||
|
* HTTP Header
|
||||||
|
* @pattern ^[a-zA-Z0-9\-]+$
|
||||||
|
*/
|
||||||
|
export type HTTPHeader = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* HTTP Query
|
||||||
|
* @pattern ^[a-zA-Z0-9\-_]+$
|
||||||
|
*/
|
||||||
|
export type HTTPQuery = string;
|
||||||
|
/**
|
||||||
|
* HTTP Cookie
|
||||||
|
* @pattern ^[a-zA-Z0-9\-_]+$
|
||||||
|
*/
|
||||||
|
export type HTTPCookie = string;
|
||||||
|
|
||||||
|
export type StatusCode = number | `${number}`;
|
||||||
|
export type StatusCodeRange = number | `${number}` | `${number}-${number}`;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @items.pattern ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
|
||||||
|
*/
|
||||||
|
export type DomainNames = string[];
|
||||||
|
/**
|
||||||
|
* @items.pattern ^(\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
|
||||||
|
*/
|
||||||
|
export type DomainOrWildcards = string[];
|
||||||
|
/**
|
||||||
|
* @format hostname
|
||||||
|
*/
|
||||||
|
export type Hostname = string;
|
||||||
|
/**
|
||||||
|
* @format ipv4
|
||||||
|
*/
|
||||||
|
export type IPv4 = string;
|
||||||
|
/**
|
||||||
|
* @format ipv6
|
||||||
|
*/
|
||||||
|
export type IPv6 = string;
|
||||||
|
|
||||||
|
/* CIDR / IPv4 / IPv6 */
|
||||||
|
export type CIDR =
|
||||||
|
| `${number}.${number}.${number}.${number}`
|
||||||
|
| `${string}:${string}:${string}:${string}:${string}:${string}:${string}:${string}`
|
||||||
|
| `${number}.${number}.${number}.${number}/${number}`
|
||||||
|
| `::${number}`
|
||||||
|
| `${string}::/${number}`
|
||||||
|
| `${string}:${string}::/${number}`;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @type integer
|
||||||
|
* @minimum 0
|
||||||
|
* @maximum 65535
|
||||||
|
*/
|
||||||
|
export type Port = number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @pattern ^\d+\:\d+$
|
||||||
|
*/
|
||||||
|
export type StreamPort = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @format email
|
||||||
|
*/
|
||||||
|
export type Email = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @format uri
|
||||||
|
*/
|
||||||
|
export type URL = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @format uri-reference
|
||||||
|
*/
|
||||||
|
export type URI = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @pattern ^(?:([A-Z]+) )?(?:([a-zA-Z0-9.-]+)\\/)?(\\/[^\\s]*)$
|
||||||
|
*/
|
||||||
|
export type PathPattern = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @pattern ^([0-9]+(ms|s|m|h))+$
|
||||||
|
*/
|
||||||
|
export type Duration = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @format date-time
|
||||||
|
*/
|
||||||
|
export type DateTime = string;
|
||||||
Loading…
Add table
Reference in a new issue