Fix cypress oauth test one more time

Generate backend coverage in ci

.dockerignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*
+
+# Only allow the following for docker build:
+!backend/
+!docker/
+!scripts/
+!test/

.github/workflows/stale.yml

@@ -1,21 +0,0 @@
-name: 'Close stale issues and PRs'
-on:
-  schedule:
-    - cron: '30 1 * * *'
-  workflow_dispatch:
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v9
-        with:
-          stale-issue-label: 'stale'
-          stale-pr-label: 'stale'
-          stale-issue-message: 'Issue is now considered stale. If you want to keep it open, please comment :+1:'
-          stale-pr-message: 'PR is now considered stale. If you want to keep it open, please comment :+1:'
-          close-issue-message: 'Issue was closed due to inactivity.'
-          close-pr-message: 'PR was closed due to inactivity.'
-          days-before-stale: 182
-          days-before-close: 365
-          operations-per-run: 50

.gitignore

@@ -1,9 +1,29 @@
+git.idea
+.env
 .DS_Store
-.idea
 ._*
-.vscode
+*.code-workspace
-certbot-help.txt
+vendor
+bin/*
+backend/config.json
+backend/embed/assets
+backend/.task
+backend/coverage.out
+backend/coverage.html
 test/node_modules
 */node_modules
-docker/dev/dnsrouter-config.json.tmp
+docs/.vuepress/dist
+frontend/build
+frontend/yarn-error.log
+frontend/.npmrc
+frontend/src/locale/lang
+test/cypress/fixtures/example.json
+.vscode
+docker-build
+data
+dist
+backend/embed/acme.sh
 docker/dev/resolv.conf
+docker/dev/dnsrouter-config.json.tmp
+thunder-tests
+test/cypress/videos

.version

@@ -1 +1 @@
-2.12.0
+3.0.0a

Jenkinsfile

@@ -1,22 +1,33 @@
 import groovy.transform.Field
 
 @Field
-def shOutput = ""
 def buildxPushTags = ""
 
+def getVersion() {
+	ver = sh(script: 'cat .version', returnStdout: true)
+	return ver.trim()
+}
+
+def getCommit() {
+	ver = sh(script: 'git log -n 1 --format=%h', returnStdout: true)
+	return ver.trim()
+}
+
 pipeline {
 	agent {
 		label 'docker-multiarch'
 	}
 	options {
-		buildDiscarder(logRotator(numToKeepStr: '5'))
+		buildDiscarder(logRotator(numToKeepStr: '10'))
 		disableConcurrentBuilds()
 		ansiColor('xterm')
 	}
 	environment {
+		DOCKER_ORG                 = 'jc21'
 		IMAGE                      = 'nginx-proxy-manager'
 		BUILD_VERSION              = getVersion()
-		MAJOR_VERSION              = '2'
+		BUILD_COMMIT               = getCommit()
+		MAJOR_VERSION              = '3'
 		BRANCH_LOWER               = "${BRANCH_NAME.toLowerCase().replaceAll('\\\\', '-').replaceAll('/', '-').replaceAll('\\.', '-')}"
 		BUILDX_NAME                = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}"
 		COMPOSE_INTERACTIVE_NO_CLI = 1
@@ -30,7 +41,9 @@ pipeline {
 					}
 					steps {
 						script {
-							buildxPushTags = "-t docker.io/jc21/${IMAGE}:${BUILD_VERSION} -t docker.io/jc21/${IMAGE}:${MAJOR_VERSION} -t docker.io/jc21/${IMAGE}:latest"
+							buildxPushTags = "-t docker.io/${DOCKER_ORG}/${IMAGE}:${BUILD_VERSION} -t docker.io/${DOCKER_ORG}/${IMAGE}:${MAJOR_VERSION} -t docker.io/${DOCKER_ORG}/${IMAGE}:latest"
+							echo 'Building on Master is disabled!'
+							sh 'exit 1'
 						}
 					}
 				}
@@ -43,51 +56,44 @@ pipeline {
 					steps {
 						script {
 							// Defaults to the Branch name, which is applies to all branches AND pr's
-							buildxPushTags = "-t docker.io/jc21/${IMAGE}:github-${BRANCH_LOWER}"
+							// buildxPushTags = "-t docker.io/jc21/${IMAGE}:github-${BRANCH_LOWER}"
-						}
+							buildxPushTags = "-t docker.io/${DOCKER_ORG}/${IMAGE}:v3"
-					}
-				}
-				stage('Versions') {
-					steps {
-						sh 'cat frontend/package.json | jq --arg BUILD_VERSION "${BUILD_VERSION}" \'.version = $BUILD_VERSION\' | sponge frontend/package.json'
-						sh 'echo -e "\\E[1;36mFrontend Version is:\\E[1;33m $(cat frontend/package.json | jq -r .version)\\E[0m"'
-						sh 'cat backend/package.json | jq --arg BUILD_VERSION "${BUILD_VERSION}" \'.version = $BUILD_VERSION\' | sponge backend/package.json'
-						sh 'echo -e "\\E[1;36mBackend Version is:\\E[1;33m  $(cat backend/package.json | jq -r .version)\\E[0m"'
-						sh 'sed -i -E "s/(version-)[0-9]+\\.[0-9]+\\.[0-9]+(-green)/\\1${BUILD_VERSION}\\2/" README.md'
-					}
-				}
-				stage('Docker Login') {
-					steps {
-						withCredentials([usernamePassword(credentialsId: 'jc21-dockerhub', passwordVariable: 'dpass', usernameVariable: 'duser')]) {
-							sh 'docker login -u "${duser}" -p "${dpass}"'
 						}
 					}
 				}
 			}
 		}
-		stage('Builds') {
+		stage('Build') {
 			parallel {
 				stage('Project') {
 					steps {
-						script {
+						sh './scripts/ci/build-frontend'
-							// Frontend and Backend
+						sh './scripts/ci/test-backend'
-							def shStatusCode = sh(label: 'Checking and Building', returnStatus: true, script: '''
+						// Temporarily disable building backend binaries
-								set -e
+						// sh './scripts/ci/build-backend'
-								./scripts/ci/frontend-build > ${WORKSPACE}/tmp-sh-build 2>&1
+						// Build the docker image used for testing below
-								./scripts/ci/test-and-build > ${WORKSPACE}/tmp-sh-build 2>&1
+						sh '''docker build --pull --no-cache \\
-							''')
+							-t "${IMAGE}:${BRANCH_LOWER}-ci-${BUILD_NUMBER}" \\
-							shOutput = readFile "${env.WORKSPACE}/tmp-sh-build"
+							-f docker/Dockerfile \\
-							if (shStatusCode != 0) {
+							--build-arg BUILD_COMMIT="${BUILD_COMMIT}" \\
-								error "${shOutput}"
+							--build-arg BUILD_DATE="$(date '+%Y-%m-%d %T %Z')" \\
-							}
+							--build-arg BUILD_VERSION="${BUILD_VERSION}" \\
-						}
+							.
+						'''
 					}
 					post {
-						always {
+						success {
-							sh 'rm -f ${WORKSPACE}/tmp-sh-build'
+							junit 'test/results/junit/*'
-						}
+							// archiveArtifacts allowEmptyArchive: false, artifacts: 'bin/*'
-						failure {
+							publishHTML([
-							npmGithubPrComment("CI Error:\n\n```\n${shOutput}\n```", true)
+								allowMissing: false,
+								alwaysLinkToLastBuild: false,
+								keepAll: false,
+								reportDir: 'test/results/html-reports',
+								reportFiles: 'backend-coverage.html',
+								reportName: 'HTML Reports',
+								useWrapperFileDirectly: true
+							])
 						}
 					}
 				}
@@ -104,7 +110,7 @@ pipeline {
 		stage('Test Sqlite') {
 			environment {
 				COMPOSE_PROJECT_NAME = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}_sqlite"
-				COMPOSE_FILE         = 'docker/docker-compose.ci.yml:docker/docker-compose.ci.sqlite.yml'
+				COMPOSE_FILE         = 'docker/docker-compose.ci.yml'
 			}
 			when {
 				not {
@@ -114,6 +120,8 @@ pipeline {
 			steps {
 				sh 'rm -rf ./test/results/junit/*'
 				sh './scripts/ci/fulltest-cypress'
+				// Adding this here as the schema needs to come from a running stack, but this will be used by docs later
+				sh 'docker-compose exec -T fullstack curl -s --output /temp-docs/api-schema.json "http://fullstack:81/api/schema"'
 			}
 			post {
 				always {
@@ -127,11 +135,6 @@ pipeline {
 					junit 'test/results/junit/*'
 					sh 'docker-compose down --remove-orphans --volumes -t 30 || true'
 				}
-				unstable {
-					dir(path: 'testing/results') {
-						archiveArtifacts(allowEmptyArchive: true, artifacts: '**/*', excludes: '**/*.xml')
-					}
-				}
 			}
 		}
 		stage('Test Mysql') {
@@ -160,10 +163,38 @@ pipeline {
 					junit 'test/results/junit/*'
 					sh 'docker-compose down --remove-orphans --volumes -t 30 || true'
 				}
-				unstable {
+			}
-					dir(path: 'testing/results') {
+		}
-						archiveArtifacts(allowEmptyArchive: true, artifacts: '**/*', excludes: '**/*.xml')
+		stage('Test Postgres') {
-					}
+			environment {
+				COMPOSE_PROJECT_NAME = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}_postgres"
+				COMPOSE_FILE         = 'docker/docker-compose.ci.yml:docker/docker-compose.ci.postgres.yml'
+			}
+			when {
+				not {
+					equals expected: 'UNSTABLE', actual: currentBuild.result
+				}
+			}
+			steps {
+				sh 'rm -rf ./test/results/junit/*'
+				sh './scripts/ci/fulltest-cypress'
+			}
+			post {
+				always {
+					// Dumps to analyze later
+					sh 'mkdir -p debug/postgres'
+					sh 'docker logs $(docker-compose ps --all -q fullstack) > debug/postgres/docker_fullstack.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q stepca) > debug/postgres/docker_stepca.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q pdns) > debug/postgres/docker_pdns.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q pdns-db) > debug/postgres/docker_pdns-db.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q dnsrouter) > debug/postgres/docker_dnsrouter.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q db-postgres) > debug/postgres/docker_db.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q authentik) > debug/postgres/docker_authentik.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q authentik-redis) > debug/postgres/docker_authentik-redis.log 2>&1'
+					sh 'docker logs $(docker-compose ps --all -q authentik-ldap) > debug/postgres/docker_authentik-ldap.log 2>&1'
+
+					junit 'test/results/junit/*'
+					sh 'docker-compose down --remove-orphans --volumes -t 30 || true'
 				}
 			}
 		}
@@ -174,7 +205,11 @@ pipeline {
 				}
 			}
 			steps {
-				sh "./scripts/buildx --push ${buildxPushTags}"
+				withCredentials([usernamePassword(credentialsId: 'jc21-dockerhub', passwordVariable: 'dpass', usernameVariable: 'duser')]) {
+					sh 'docker login -u "${duser}" -p "${dpass}"'
+					sh "./scripts/buildx --push ${buildxPushTags}"
+					// sh './scripts/buildx -o type=local,dest=docker-build'
+				}
 			}
 		}
 		stage('Docs / Comment') {
@@ -182,7 +217,7 @@ pipeline {
 				stage('Docs Job') {
 					when {
 						allOf {
-							branch pattern: "^(develop|master)\$", comparator: "REGEXP"
+							branch pattern: "^(develop|master|v3)\$", comparator: "REGEXP"
 							not {
 								equals expected: 'UNSTABLE', actual: currentBuild.result
 							}
@@ -212,25 +247,22 @@ pipeline {
 	}
 	post {
 		always {
-			sh 'echo Reverting ownership'
+			sh './scripts/ci/build-cleanup'
-			sh 'docker run --rm -v "$(pwd):/data" jc21/ci-tools chown -R "$(id -u):$(id -g)" /data'
+			echo 'Reverting ownership'
-			printResult(true)
+			sh 'docker run --rm -v $(pwd):/data jc21/gotools:latest chown -R "$(id -u):$(id -g)" /data'
+			printResult()
 		}
 		failure {
-			archiveArtifacts(artifacts: 'debug/**/*.*', allowEmptyArchive: true)
+			archiveArtifacts(artifacts: 'debug/**/*', allowEmptyArchive: true)
+			dir(path: 'test') {
+				archiveArtifacts allowEmptyArchive: true, artifacts: 'results/**/*', excludes: '**/*.xml'
+			}
 		}
 		unstable {
-			archiveArtifacts(artifacts: 'debug/**/*.*', allowEmptyArchive: true)
+			archiveArtifacts(artifacts: 'debug/**/*', allowEmptyArchive: true)
+			dir(path: 'test') {
+				archiveArtifacts allowEmptyArchive: true, artifacts: 'results/**/*', excludes: '**/*.xml'
+			}
 		}
 	}
 }
-
-def getVersion() {
-	ver = sh(script: 'cat .version', returnStdout: true)
-	return ver.trim()
-}
-
-def getCommit() {
-	ver = sh(script: 'git log -n 1 --format=%h', returnStdout: true)
-	return ver.trim()
-}

README.md

@@ -1,7 +1,7 @@
 <p align="center">
 	<img src="https://nginxproxymanager.com/github.png">
 	<br><br>
-	<img src="https://img.shields.io/badge/version-2.12.0-green.svg?style=for-the-badge">
+	<img src="https://img.shields.io/badge/version-2.9.19-green.svg?style=for-the-badge">
 	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
 		<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
 	</a>
@@ -19,7 +19,7 @@ running at home or otherwise, including free SSL, without having to know too muc
 
 ## Project Goal
 
-I created this project to fill a personal need to provide users with an easy way to accomplish reverse
+I created this project to fill a personal need to provide users with a easy way to accomplish reverse
 proxying hosts with SSL termination and it had to be so easy that a monkey could do it. This goal hasn't changed.
 While there might be advanced options they are optional and the project should be as simple as possible
 so that the barrier for entry here is low.
@@ -29,7 +29,7 @@ so that the barrier for entry here is low.
 
 ## Features
 
-- Beautiful and Secure Admin Interface based on [Tabler](https://tabler.github.io/)
+- Beautiful and Secure Admin Interface based on [Chakra UI](https://chakra-ui.com/)
 - Easily create forwarding domains, redirections, streams and 404 hosts without knowing anything about Nginx
 - Free SSL using Let's Encrypt or provide your own custom SSL certificates
 - Access Lists and basic HTTP Authentication for your hosts
@@ -46,7 +46,8 @@ I won't go in to too much detail here but here are the basics for someone new to
 3. Configure your domain name details to point to your home, either with a static ip or a service like DuckDNS or [Amazon Route53](https://github.com/jc21/route53-ddns)
 4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
 
-## Quick Setup
+
+## Quickest Setup
 
 1. Install Docker and Docker-Compose
 
@@ -56,9 +57,10 @@ I won't go in to too much detail here but here are the basics for someone new to
 2. Create a docker-compose.yml file similar to this:
 
 ```yml
+version: '3'
 services:
   app:
-    image: 'docker.io/jc21/nginx-proxy-manager:latest'
+    image: 'jc21/nginx-proxy-manager:v3'
     restart: unless-stopped
     ports:
       - '80:80'
@@ -66,11 +68,8 @@ services:
       - '443:443'
     volumes:
       - ./data:/data
-      - ./letsencrypt:/etc/letsencrypt
 ```
 
-This is the bare minimum configuration required. See the [documentation](https://nginxproxymanager.com/setup/) for more.
-
 3. Bring up your stack by running
 
 ```bash
@@ -78,43 +77,25 @@ docker-compose up -d
 
 # If using docker-compose-plugin
 docker compose up -d
-
 ```
 
 4. Log in to the Admin UI
 
 When your docker container is running, connect to it on port `81` for the admin interface.
-Sometimes this can take a little bit because of the entropy of keys.
 
 [http://127.0.0.1:81](http://127.0.0.1:81)
 
-Default Admin User:
+## Contributors
-```
-Email:    admin@example.com
-Password: changeme
-```
-
-Immediately after logging in with this default user you will be asked to modify your details and change your password.
-
-
-## Contributing
-
-All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch.
-
-CI is used in this project. All PR's must pass before being considered. After passing,
-docker builds for PR's are available on dockerhub for manual verifications.
-
-Documentation within the `develop` branch is available for preview at
-[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com)
-
-
-### Contributors
 
 Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
 
-
 ## Getting Support
 
 1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues)
 2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions)
-3. [Reddit](https://reddit.com/r/nginxproxymanager)
+3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community)
+4. [Reddit](https://reddit.com/r/nginxproxymanager)
+
+## Become a Contributor
+
+A guide to setting up your own development environment [is found here](DEV-README.md).

backend/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false

backend/.eslintrc.json

@@ -1,73 +0,0 @@
-{
-	"env": {
-		"node": true,
-		"es6": true
-	},
-	"extends": [
-		"eslint:recommended"
-	],
-	"globals": {
-		"Atomics": "readonly",
-		"SharedArrayBuffer": "readonly"
-	},
-	"parserOptions": {
-		"ecmaVersion": 2018,
-		"sourceType": "module"
-	},
-	"plugins": [
-		"align-assignments"
-	],
-	"rules": {
-		"arrow-parens": [
-			"error",
-			"always"
-		],
-		"indent": [
-			"error",
-			"tab"
-		],
-		"linebreak-style": [
-			"error",
-			"unix"
-		],
-		"quotes": [
-			"error",
-			"single"
-		],
-		"semi": [
-			"error",
-			"always"
-		],
-		"key-spacing": [
-			"error",
-			{
-				"align": "value"
-			}
-		],
-		"comma-spacing": [
-			"error",
-			{
-				"before": false,
-				"after": true
-			}
-		],
-		"func-call-spacing": [
-			"error",
-			"never"
-		],
-		"keyword-spacing": [
-			"error",
-			{
-				"before": true
-			}
-		],
-		"no-irregular-whitespace": "error",
-		"no-unused-expressions": 0,
-		"align-assignments/align-assignments": [
-			2,
-			{
-				"requiresOnly": false
-			}
-		]
-	}
-}

backend/.gitignore

@@ -1,8 +0,0 @@
-config/development.json
-data/*
-yarn-error.log
-tmp
-certbot.log
-node_modules
-core.*
-

backend/.golangci.yml

@@ -0,0 +1,63 @@
+linters:
+    enable:
+        - bodyclose
+        - errcheck
+        - gosimple
+        - govet
+        - gosec
+        - goconst
+        - gocritic
+        - gocyclo
+        - gofmt
+        - goimports
+        - ineffassign
+        - misspell
+        - nakedret
+        - prealloc
+        #- revive
+        - staticcheck
+        - typecheck
+        - unused
+        - unconvert
+        - unparam
+linters-settings:
+    gosec:
+      excludes:
+        - G115
+    errcheck:
+      exclude-functions:
+        - fmt.Fprint
+        - fmt.Fprintf
+    goconst:
+        # minimal length of string constant
+        # default: 3
+        min-len: 2
+        # minimum number of occurrences of string constant
+        # default: 3
+        min-occurences: 2
+    misspell:
+        locale: UK
+        ignore-words:
+            - color
+issues:
+    # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+    # We have chosen an arbitrary value that works based on practical usage.
+    max-same: 20
+    # See cmdline flag documentation for more info about default excludes --exclude-use-default
+    # Nothing is excluded by default
+    exclude-use-default: false
+    # Excluding configuration per-path, per-linter, per-text and per-source
+    exclude-rules:
+        # Exclude some linters from running on tests files. # TODO: Add examples why this is good
+
+        - path: _test\.go
+          linters:
+              # Tests should be simple? Add example why this is good?
+              - gocyclo
+              # Error checking adds verbosity and complexity for minimal value
+              - errcheck
+              # Table test encourage duplication in defining the table tests.
+              - dupl
+              # Hard coded example tokens, SQL injection and other bad practices may
+              # want to be tested
+              - gosec

backend/.testcoverage.yml

@@ -0,0 +1,21 @@
+---
+
+# (mandatory)
+# Path to coverprofile file (output of `go test -coverprofile` command).
+profile: coverage.out
+
+# (optional; but recommended to set)
+# When specified reported file paths will not contain local prefix in the output
+local-prefix: "npm"
+
+# Holds coverage thresholds percentages, values should be in range [0-100]
+threshold:
+  # (optional; default 0)
+  # The minimum coverage that each file should have
+  # file: 70
+  # (optional; default 0)
+  # The minimum coverage that each package should have
+  # package: 30
+  # (optional; default 0)
+  # The minimum total coverage project should have
+  total: 30

backend/README.md

@@ -0,0 +1,6 @@
+# Backend
+
+## Guides and materials
+
+-   [Nginx Proxy Protocol](https://docs.nginx.com/nginx/admin-guide/load-balancer/using-proxy-protocol/)
+-

backend/Taskfile.yml

@@ -0,0 +1,70 @@
+version: "3"
+
+tasks:
+    default:
+        cmds:
+            - task: run
+
+    run:
+        desc: Build and run
+        sources:
+            - internal/**/*.go
+            - cmd/**/*.go
+            - ../frontend/src/locale/src/*.json
+        cmds:
+            - task: locale
+            - task: build
+              force: true
+            - cmd: echo -e "==> Running..."
+              silent: true
+            - cmd: ../dist/bin/server
+              ignore_error: true
+              silent: true
+        env:
+            LOG_LEVEL: debug
+
+    build:
+        desc: Build the server
+        cmds:
+            - cmd: echo -e "==> Building..."
+              silent: true
+            - cmd: rm -f dist/bin/*
+              silent: true
+            - cmd: go build -tags 'json1' -buildvcs=false -ldflags="-X main.commit={{.GIT_COMMIT}} -X main.version={{.VERSION}}" -o ../dist/bin/server ./cmd/server/main.go
+              silent: true
+            - cmd: go build -buildvcs=false -ldflags="-X main.commit={{.GIT_COMMIT}} -X main.version={{.VERSION}}" -o ../dist/bin/ipranges ./cmd/ipranges/main.go
+              silent: true
+            - cmd: rm -f /etc/nginx/conf.d/include/ipranges.conf && /app/dist/bin/ipranges > /etc/nginx/conf.d/include/ipranges.conf
+            - task: lint
+        vars:
+            GIT_COMMIT:
+                sh: git log -n 1 --format=%h
+            VERSION:
+                sh: cat ../.version
+
+    lint:
+        desc: Linting
+        cmds:
+            - cmd: echo -e "==> Linting..."
+              silent: true
+            - cmd: bash scripts/lint.sh
+              silent: true
+
+    test:
+        desc: Testing
+        cmds:
+            - cmd: echo -e "==> Testing..."
+              silent: true
+            - cmd: bash scripts/test.sh
+              silent: true
+
+    locale:
+        desc: Locale
+        dir: /app/frontend
+        cmds:
+            - cmd: yarn locale-compile
+              silent: true
+              ignore_error: true
+            - cmd: chown -R "$PUID:$PGID" src/locale/lang
+              silent: true
+              ignore_error: true

backend/app.js

@@ -1,90 +0,0 @@
-const express     = require('express');
-const bodyParser  = require('body-parser');
-const fileUpload  = require('express-fileupload');
-const compression = require('compression');
-const config      = require('./lib/config');
-const log         = require('./logger').express;
-
-/**
- * App
- */
-const app = express();
-app.use(fileUpload());
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: true}));
-
-// Gzip
-app.use(compression());
-
-/**
- * General Logging, BEFORE routes
- */
-
-app.disable('x-powered-by');
-app.enable('trust proxy', ['loopback', 'linklocal', 'uniquelocal']);
-app.enable('strict routing');
-
-// pretty print JSON when not live
-if (config.debug()) {
-	app.set('json spaces', 2);
-}
-
-// CORS for everything
-app.use(require('./lib/express/cors'));
-
-// General security/cache related headers + server header
-app.use(function (req, res, next) {
-	let x_frame_options = 'DENY';
-
-	if (typeof process.env.X_FRAME_OPTIONS !== 'undefined' && process.env.X_FRAME_OPTIONS) {
-		x_frame_options = process.env.X_FRAME_OPTIONS;
-	}
-
-	res.set({
-		'X-XSS-Protection':       '1; mode=block',
-		'X-Content-Type-Options': 'nosniff',
-		'X-Frame-Options':        x_frame_options,
-		'Cache-Control':          'no-cache, no-store, max-age=0, must-revalidate',
-		Pragma:                   'no-cache',
-		Expires:                  0
-	});
-	next();
-});
-
-app.use(require('./lib/express/jwt')());
-app.use('/', require('./routes/main'));
-
-// production error handler
-// no stacktraces leaked to user
-// eslint-disable-next-line
-app.use(function (err, req, res, next) {
-
-	let payload = {
-		error: {
-			code:    err.status,
-			message: err.public ? err.message : 'Internal Error'
-		}
-	};
-
-	if (config.debug() || (req.baseUrl + req.path).includes('nginx/certificates')) {
-		payload.debug = {
-			stack:    typeof err.stack !== 'undefined' && err.stack ? err.stack.split('\n') : null,
-			previous: err.previous
-		};
-	}
-
-	// Not every error is worth logging - but this is good for now until it gets annoying.
-	if (typeof err.stack !== 'undefined' && err.stack) {
-		if (config.debug()) {
-			log.debug(err.stack);
-		} else if (typeof err.public == 'undefined' || !err.public) {
-			log.warn(err.message);
-		}
-	}
-
-	res
-		.status(err.status || 500)
-		.send(payload);
-});
-
-module.exports = app;

backend/cmd/ipranges/main.go

@@ -0,0 +1,125 @@
+package main
+
+import (
+	"bufio"
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
+	"os"
+
+	"npm/internal/config"
+	"npm/internal/model"
+
+	"github.com/rotisserie/eris"
+)
+
+var commit string
+var version string
+
+var cloudfrontURL = "https://ip-ranges.amazonaws.com/ip-ranges.json"
+var cloudflare4URL = "https://www.cloudflare.com/ips-v4"
+var cloudflare6URL = "https://www.cloudflare.com/ips-v6"
+
+func main() {
+	config.InitArgs(&version, &commit)
+	if err := config.InitIPRanges(&version, &commit); err != nil {
+		fmt.Printf("# Config ERROR: %v\n", err)
+		os.Exit(1)
+	}
+
+	exitCode := 0
+
+	// Cloudfront
+	fmt.Printf("# Cloudfront Ranges from: %s\n", cloudfrontURL)
+	if ranges, err := parseCloudfront(); err == nil {
+		for _, item := range ranges {
+			fmt.Printf("set_real_ip_from %s;\n", item)
+		}
+	} else {
+		fmt.Printf("# ERROR: %v\n", err)
+	}
+
+	// Cloudflare ipv4
+	if !config.Configuration.DisableIPV4 {
+		fmt.Printf("\n# Cloudflare Ranges from: %s\n", cloudflare4URL)
+		if ranges, err := parseCloudflare(cloudflare4URL); err == nil {
+			for _, item := range ranges {
+				fmt.Printf("set_real_ip_from %s;\n", item)
+			}
+		} else {
+			fmt.Printf("# ERROR: %v\n", err)
+		}
+	}
+
+	// Cloudflare ipv6
+	if !config.Configuration.DisableIPV6 {
+		fmt.Printf("\n# Cloudflare Ranges from: %s\n", cloudflare6URL)
+		if ranges, err := parseCloudflare(cloudflare6URL); err == nil {
+			for _, item := range ranges {
+				fmt.Printf("set_real_ip_from %s;\n", item)
+			}
+		} else {
+			fmt.Printf("# ERROR: %v\n", err)
+		}
+	}
+
+	// Done
+	os.Exit(exitCode)
+}
+
+func parseCloudfront() ([]string, error) {
+	// nolint: gosec
+	resp, err := http.Get(cloudfrontURL)
+	if err != nil {
+		return nil, eris.Wrapf(err, "Failed to download Cloudfront IP Ranges from %s", cloudfrontURL)
+	}
+
+	// nolint: errcheck, gosec
+	defer resp.Body.Close()
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, eris.Wrapf(err, "Failed to read Cloudfront IP Ranges body")
+	}
+
+	var result model.CloudfrontIPRanges
+	if err := json.Unmarshal(body, &result); err != nil {
+		return nil, eris.Wrapf(err, "Failed to unmarshal Cloudfront IP Ranges file")
+	}
+
+	ranges := make([]string, 0)
+	if !config.Configuration.DisableIPV4 {
+		for _, item := range result.IPV4Prefixes {
+			ranges = append(ranges, item.Value)
+		}
+	}
+	if !config.Configuration.DisableIPV6 {
+		for _, item := range result.IPV6Prefixes {
+			ranges = append(ranges, item.Value)
+		}
+	}
+
+	return ranges, nil
+}
+
+func parseCloudflare(url string) ([]string, error) {
+	// nolint: gosec
+	resp, err := http.Get(url)
+	if err != nil {
+		return nil, eris.Wrapf(err, "Failed to download Cloudflare IP Ranges from %s", url)
+	}
+
+	// nolint: errcheck, gosec
+	defer resp.Body.Close()
+
+	scanner := bufio.NewScanner(resp.Body)
+	scanner.Split(bufio.ScanLines)
+
+	ranges := make([]string, 0)
+	for scanner.Scan() {
+		if scanner.Text() != "" {
+			ranges = append(ranges, scanner.Text())
+		}
+	}
+	return ranges, nil
+}

backend/cmd/server/main.go

@@ -0,0 +1,84 @@
+package main
+
+import (
+	"os"
+	"os/signal"
+	"syscall"
+
+	"npm/internal/api"
+	"npm/internal/config"
+	"npm/internal/database"
+	"npm/internal/entity/certificate"
+	"npm/internal/entity/host"
+	"npm/internal/entity/user"
+	"npm/internal/errors"
+	"npm/internal/jobqueue"
+	"npm/internal/jwt"
+	"npm/internal/logger"
+)
+
+var commit string
+var version string
+
+func main() {
+	config.InitArgs(&version, &commit)
+	config.Init(&version, &commit)
+	config.CreateDataFolders()
+	logger.Info("Build Version: %s (%s)", version, commit)
+
+	database.Migrate(func() {
+		if err := jwt.LoadKeys(); err != nil {
+			logger.Error("KeysError", err)
+			os.Exit(1)
+		}
+
+		checkSetup()
+
+		// Internal Job Queue
+		jobqueue.Start()
+		certificate.AddPendingJobs()
+		host.AddPendingJobs()
+
+		// Http server
+		api.StartServer()
+		irqchan := make(chan os.Signal, 1)
+		signal.Notify(irqchan, syscall.SIGINT, syscall.SIGTERM)
+
+		for irq := range irqchan {
+			if irq == syscall.SIGINT || irq == syscall.SIGTERM {
+				logger.Info("Got ", irq, " shutting server down ...")
+				// Close db
+				sqlDB, _ := database.GetDB().DB()
+				err := sqlDB.Close()
+				if err != nil {
+					logger.Error("DatabaseCloseError", err)
+				}
+				// nolint
+				jobqueue.Shutdown()
+				break
+			}
+		}
+	})
+}
+
+// checkSetup Quick check by counting the number of users in the database
+func checkSetup() {
+	db := database.GetDB()
+	var count int64
+
+	if db != nil {
+		db.Model(&user.Model{}).
+			Where("is_disabled = ?", false).
+			Where("is_system = ?", false).
+			Count(&count)
+
+		if count == 0 {
+			logger.Warn("No users found, starting in Setup Mode")
+		} else {
+			config.IsSetup = true
+			logger.Info("Application is setup")
+		}
+	} else {
+		logger.Error("DatabaseError", errors.ErrDatabaseUnavailable)
+	}
+}

backend/config/README.md

@@ -1,2 +0,0 @@
-These files are use in development and are not deployed as part of the final product.
- 

backend/config/default.json

@@ -1,10 +0,0 @@
-{
-  "database": {
-    "engine": "mysql2",
-    "host": "db",
-    "name": "npm",
-    "user": "npm",
-    "password": "npm",
-    "port": 3306
-  }
-}

backend/config/sqlite-test-db.json

@@ -1,26 +0,0 @@
-{
-  "database": {
-      "engine": "knex-native",
-      "knex": {
-        "client": "sqlite3",
-        "connection": {
-          "filename": "/app/config/mydb.sqlite"
-        },
-        "pool": {
-          "min": 0,
-          "max": 1,
-          "createTimeoutMillis": 3000,
-          "acquireTimeoutMillis": 30000,
-          "idleTimeoutMillis": 30000,
-          "reapIntervalMillis": 1000,
-          "createRetryIntervalMillis": 100,
-          "propagateCreateError": false
-        },
-        "migrations": {
-          "tableName": "migrations",
-          "stub": "src/backend/lib/migrate_template.js",
-          "directory": "src/backend/migrations"
-        }
-      }
-    }
-}

backend/db.js

@@ -1,27 +0,0 @@
-const config = require('./lib/config');
-
-if (!config.has('database')) {
-	throw new Error('Database config does not exist! Please read the instructions: https://nginxproxymanager.com/setup/');
-}
-
-function generateDbConfig() {
-	const cfg = config.get('database');
-	if (cfg.engine === 'knex-native') {
-		return cfg.knex;
-	}
-	return {
-		client:     cfg.engine,
-		connection: {
-			host:     cfg.host,
-			user:     cfg.user,
-			password: cfg.password,
-			database: cfg.name,
-			port:     cfg.port
-		},
-		migrations: {
-			tableName: 'migrations'
-		}
-	};
-}
-
-module.exports = require('knex')(generateDbConfig());

backend/embed/api_docs/api.swagger.json

@@ -0,0 +1,310 @@
+{
+	"openapi": "3.0.0",
+	"info": {
+		"title": "Nginx Proxy Manager API",
+		"version": "{{VERSION}}"
+	},
+	"paths": {
+		"/": {
+			"get": {
+				"$ref": "file://./paths/get.json"
+			}
+		},
+		"/auth": {
+			"get": {
+				"$ref": "file://./paths/auth/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/auth/post.json"
+			}
+		},
+		"/auth/refresh": {
+			"post": {
+				"$ref": "file://./paths/auth/refresh/post.json"
+			}
+		},
+		"/auth/sse": {
+			"post": {
+				"$ref": "file://./paths/auth/sse/post.json"
+			}
+		},
+		"/certificates": {
+			"get": {
+				"$ref": "file://./paths/certificates/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/certificates/post.json"
+			}
+		},
+		"/certificates/{certificateID}": {
+			"get": {
+				"$ref": "file://./paths/certificates/certificateID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/certificates/certificateID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/certificates/certificateID/delete.json"
+			}
+		},
+		"/certificates-authorities": {
+			"get": {
+				"$ref": "file://./paths/certificates-authorities/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/certificates-authorities/post.json"
+			}
+		},
+		"/certificates-authorities/{caID}": {
+			"get": {
+				"$ref": "file://./paths/certificates-authorities/caID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/certificates-authorities/caID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/certificates-authorities/caID/delete.json"
+			}
+		},
+		"/config": {
+			"get": {
+				"$ref": "file://./paths/config/get.json"
+			}
+		},
+		"/dns-providers": {
+			"get": {
+				"$ref": "file://./paths/dns-providers/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/dns-providers/post.json"
+			}
+		},
+		"/dns-providers/{providerID}": {
+			"get": {
+				"$ref": "file://./paths/dns-providers/providerID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/dns-providers/providerID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/dns-providers/providerID/delete.json"
+			}
+		},
+		"/hosts": {
+			"get": {
+				"$ref": "file://./paths/hosts/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/hosts/post.json"
+			}
+		},
+		"/hosts/{hostID}": {
+			"get": {
+				"$ref": "file://./paths/hosts/hostID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/hosts/hostID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/hosts/hostID/delete.json"
+			}
+		},
+		"/hosts/{hostID}/nginx-config": {
+			"get": {
+				"$ref": "file://./paths/hosts/hostID/nginx-config/get.json"
+			}
+		},
+		"/nginx-templates": {
+			"get": {
+				"$ref": "file://./paths/nginx-templates/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/nginx-templates/post.json"
+			}
+		},
+		"/nginx-templates/{templateID}": {
+			"get": {
+				"$ref": "file://./paths/nginx-templates/templateID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/nginx-templates/templateID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/nginx-templates/templateID/delete.json"
+			}
+		},
+		"/schema": {
+			"get": {
+				"$ref": "file://./paths/schema/get.json"
+			}
+		},
+		"/settings": {
+			"get": {
+				"$ref": "file://./paths/settings/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/settings/post.json"
+			}
+		},
+		"/settings/{name}": {
+			"get": {
+				"$ref": "file://./paths/settings/name/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/settings/name/put.json"
+			}
+		},
+		"/streams": {
+			"get": {
+				"$ref": "file://./paths/streams/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/streams/post.json"
+			}
+		},
+		"/streams/{streamID}": {
+			"get": {
+				"$ref": "file://./paths/streams/streamID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/streams/streamID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/streams/streamID/delete.json"
+			}
+		},
+		"/upstreams": {
+			"get": {
+				"$ref": "file://./paths/upstreams/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/upstreams/post.json"
+			}
+		},
+		"/upstreams/{upstreamID}": {
+			"get": {
+				"$ref": "file://./paths/upstreams/upstreamID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/upstreams/upstreamID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/upstreams/upstreamID/delete.json"
+			}
+		},
+		"/upstreams/{upstreamID}/nginx-config": {
+			"get": {
+				"$ref": "file://./paths/upstreams/upstreamID/nginx-config/get.json"
+			}
+		},
+		"/users": {
+			"get": {
+				"$ref": "file://./paths/users/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/users/post.json"
+			}
+		},
+		"/users/{userID}": {
+			"get": {
+				"$ref": "file://./paths/users/userID/get.json"
+			},
+			"put": {
+				"$ref": "file://./paths/users/userID/put.json"
+			},
+			"delete": {
+				"$ref": "file://./paths/users/userID/delete.json"
+			}
+		},
+		"/users/{userID}/auth": {
+			"post": {
+				"$ref": "file://./paths/users/userID/auth/post.json"
+			}
+		}
+	},
+	"components": {
+		"schemas": {
+			"AuthConfigObject": {
+				"$ref": "file://./components/AuthConfigObject.json"
+			},
+			"CertificateAuthorityList": {
+				"$ref": "file://./components/CertificateAuthorityList.json"
+			},
+			"CertificateAuthorityObject": {
+				"$ref": "file://./components/CertificateAuthorityObject.json"
+			},
+			"CertificateList": {
+				"$ref": "file://./components/CertificateList.json"
+			},
+			"CertificateObject": {
+				"$ref": "file://./components/CertificateObject.json"
+			},
+			"ConfigObject": {
+				"$ref": "file://./components/ConfigObject.json"
+			},
+			"DeletedItemResponse": {
+				"$ref": "file://./components/DeletedItemResponse.json"
+			},
+			"DNSProviderList": {
+				"$ref": "file://./components/DNSProviderList.json"
+			},
+			"DNSProviderObject": {
+				"$ref": "file://./components/DNSProviderObject.json"
+			},
+			"ErrorObject": {
+				"$ref": "file://./components/ErrorObject.json"
+			},
+			"FilterObject": {
+				"$ref": "file://./components/FilterObject.json"
+			},
+			"HealthObject": {
+				"$ref": "file://./components/HealthObject.json"
+			},
+			"HostList": {
+				"$ref": "file://./components/HostList.json"
+			},
+			"HostObject": {
+				"$ref": "file://./components/HostObject.json"
+			},
+			"NginxTemplateList": {
+				"$ref": "file://./components/NginxTemplateList.json"
+			},
+			"NginxTemplateObject": {
+				"$ref": "file://./components/NginxTemplateObject.json"
+			},
+			"SettingList": {
+				"$ref": "file://./components/SettingList.json"
+			},
+			"SettingObject": {
+				"$ref": "file://./components/SettingObject.json"
+			},
+			"SortObject": {
+				"$ref": "file://./components/SortObject.json"
+			},
+			"StreamList": {
+				"$ref": "file://./components/StreamList.json"
+			},
+			"StreamObject": {
+				"$ref": "file://./components/StreamObject.json"
+			},
+			"TokenObject": {
+				"$ref": "file://./components/TokenObject.json"
+			},
+			"UpstreamList": {
+				"$ref": "file://./components/UpstreamList.json"
+			},
+			"UpstreamObject": {
+				"$ref": "file://./components/UpstreamObject.json"
+			},
+			"UserAuthObject": {
+				"$ref": "file://./components/UserAuthObject.json"
+			},
+			"UserList": {
+				"$ref": "file://./components/UserList.json"
+			},
+			"UserObject": {
+				"$ref": "file://./components/UserObject.json"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/AuthConfigObject.json

@@ -0,0 +1,13 @@
+{
+	"type": "array",
+	"description": "AuthConfigObject",
+	"minItems": 1,
+	"items": {
+		"type": "string",
+		"enum": [
+			"local",
+			"ldap",
+			"oauth"
+		]
+	}
+}

backend/embed/api_docs/components/CertificateAuthorityList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "CertificateAuthorityList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/CertificateAuthorityObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/CertificateAuthorityObject.json

@@ -0,0 +1,57 @@
+{
+	"type": "object",
+	"description": "CertificateAuthorityObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"name",
+		"acmesh_server",
+		"ca_bundle",
+		"max_domains",
+		"is_wildcard_supported",
+		"is_readonly"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"acmesh_server": {
+			"type": "string",
+			"minLength": 2,
+			"maxLength": 255
+		},
+		"ca_bundle": {
+			"type": "string",
+			"minLength": 0,
+			"maxLength": 255
+		},
+		"max_domains": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"is_wildcard_supported": {
+			"type": "boolean"
+		},
+		"is_readonly": {
+			"type": "boolean"
+		}
+	}
+}

backend/embed/api_docs/components/CertificateList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "CertificateList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/CertificateObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/CertificateObject.json

@@ -0,0 +1,86 @@
+{
+	"type": "object",
+	"description": "CertificateObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"expires_on",
+		"type",
+		"user_id",
+		"certificate_authority_id",
+		"dns_provider_id",
+		"name",
+		"is_ecc",
+		"status",
+		"domain_names"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"expires_on": {
+			"type": "integer",
+			"minimum": 0,
+			"nullable": true
+		},
+		"type": {
+			"type": "string",
+			"enum": ["custom", "http", "dns"]
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"certificate_authority_id": {
+			"type": "integer",
+			"minimum": 0
+		},
+		"certificate_authority": {
+			"$ref": "#/components/schemas/CertificateAuthorityObject"
+		},
+		"dns_provider_id": {
+			"type": "integer",
+			"minimum": 0,
+			"nullable": true
+		},
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"domain_names": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"type": "string",
+				"minLength": 4
+			}
+		},
+		"status": {
+			"type": "string",
+			"enum": ["ready", "requesting", "failed", "provided"]
+		},
+		"is_ecc": {
+			"type": "boolean"
+		},
+		"error_message": {
+			"type": "string"
+		},
+		"user": {
+			"$ref": "#/components/schemas/UserObject"
+		}
+	}
+}

backend/embed/api_docs/components/ConfigObject.json

@@ -0,0 +1,4 @@
+{
+	"type": "object",
+	"description": "ConfigObject"
+}

backend/embed/api_docs/components/DNSProviderList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "DNSProviderList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/DNSProviderObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/DNSProviderObject.json

@@ -0,0 +1,51 @@
+{
+	"type": "object",
+	"description": "DNSProviderObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"user_id",
+		"name",
+		"acmesh_name",
+		"dns_sleep",
+		"meta"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"acmesh_name": {
+			"type": "string",
+			"minLength": 4,
+			"maxLength": 50
+		},
+		"dns_sleep": {
+			"type": "integer"
+		},
+		"meta": {
+			"type": "object"
+		}
+	}
+}

backend/embed/api_docs/components/DeletedItemResponse.json

@@ -0,0 +1,15 @@
+{
+	"type": "object",
+	"description": "DeletedItemResponse",
+	"additionalProperties": false,
+	"required": ["result"],
+	"properties": {
+		"result": {
+			"type": "boolean",
+			"nullable": true
+		},
+		"error": {
+			"$ref": "#/components/schemas/ErrorObject"
+		}
+	}
+}

backend/embed/api_docs/components/ErrorObject.json

@@ -0,0 +1,17 @@
+{
+	"type": "object",
+	"description": "ErrorObject",
+	"additionalProperties": false,
+	"required": ["code", "message"],
+	"properties": {
+		"code": {
+			"type": "integer",
+			"description": "Error code",
+			"minimum": 0
+		},
+		"message": {
+			"type": "string",
+			"description": "Error message"
+		}
+	}
+}

backend/embed/api_docs/components/FilterObject.json

@@ -0,0 +1,24 @@
+{
+	"type": "object",
+	"description": "FilterObject",
+	"additionalProperties": false,
+	"required": ["field", "modifier", "value"],
+	"properties": {
+		"field": {
+			"type": "string",
+			"description": "Field to filter with"
+		},
+		"modifier": {
+			"type": "string",
+			"description": "Filter modifier",
+			"pattern": "^(equals|not|min|max|greater|lesser|contains|starts|ends|in|notin)$"
+		},
+		"value": {
+			"type": "array",
+			"description": "Values used for filtering",
+			"items": {
+				"type": "string"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/HealthObject.json

@@ -0,0 +1,31 @@
+{
+	"type": "object",
+	"description": "HealthObject",
+	"additionalProperties": false,
+	"required": ["version", "commit", "healthy", "setup"],
+	"properties": {
+		"version": {
+			"type": "string",
+			"description": "Version",
+			"minLength": 1
+		},
+		"commit": {
+			"type": "string",
+			"description": "Commit hash",
+			"minLength": 7
+		},
+		"healthy": {
+			"type": "boolean",
+			"description": "Healthy?"
+		},
+		"setup": {
+			"type": "boolean",
+			"description": "Is the application set up?"
+		},
+		"acme.sh": {
+			"type": "string",
+			"description": "Acme.sh version",
+			"minLength": 1
+		}
+	}
+}

backend/embed/api_docs/components/HostList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "HostList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/HostObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/HostObject.json

@@ -0,0 +1,55 @@
+{
+	"type": "object",
+	"description": "HostObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"user_id",
+		"provider",
+		"name",
+		"domain_names"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"provider": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"domain_names": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"type": "string",
+				"minLength": 4
+			}
+		},
+		"user": {
+			"$ref": "#/components/schemas/UserObject"
+		}
+	}
+}

backend/embed/api_docs/components/NginxTemplateList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "NginxTemplateList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/NginxTemplateObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/NginxTemplateObject.json

@@ -0,0 +1,46 @@
+{
+	"type": "object",
+	"description": "NginxTemplateObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"user_id",
+		"name",
+		"type",
+		"template"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"name": {
+			"type": "string",
+			"minLength": 1
+		},
+		"type": {
+			"type": "string",
+			"pattern": "^proxy|redirect|dead|stream|upstream$"
+		},
+		"template": {
+			"type": "string",
+			"minLength": 20
+		}
+	}
+}

backend/embed/api_docs/components/SettingList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "SettingList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/SettingObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/SettingObject.json

@@ -0,0 +1,51 @@
+{
+	"type": "object",
+	"description": "SettingObject",
+	"additionalProperties": false,
+	"required": ["id", "created_at", "updated_at", "name", "value"],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"name": {
+			"type": "string",
+			"minLength": 2,
+			"maxLength": 100
+		},
+		"description": {
+			"type": "string",
+			"minLength": 0,
+			"maxLength": 100
+		},
+		"value": {
+			"oneOf": [
+				{
+					"type": "array"
+				},
+				{
+					"type": "boolean"
+				},
+				{
+					"type": "object"
+				},
+				{
+					"type": "integer"
+				},
+				{
+					"type": "string"
+				}
+			]
+		}
+	}
+}

backend/embed/api_docs/components/SortObject.json

@@ -0,0 +1,17 @@
+{
+	"type": "object",
+	"description": "SortObject",
+	"additionalProperties": false,
+	"required": ["field", "direction"],
+	"properties": {
+		"field": {
+			"type": "string",
+			"description": "Field for sorting on"
+		},
+		"direction": {
+			"type": "string",
+			"description": "Sort order",
+			"pattern": "^(ASC|DESC)$"
+		}
+	}
+}

backend/embed/api_docs/components/StreamList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "StreamList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/StreamObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/StreamObject.json

@@ -0,0 +1,57 @@
+{
+	"type": "object",
+	"description": "StreamObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"expires_on",
+		"user_id",
+		"provider",
+		"name",
+		"domain_names"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"expires_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"provider": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"domain_names": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"type": "string",
+				"minLength": 4
+			}
+		}
+	}
+}

backend/embed/api_docs/components/TokenObject.json

@@ -0,0 +1,17 @@
+{
+	"type": "object",
+	"description": "TokenObject",
+	"additionalProperties": false,
+	"required": ["expires", "token"],
+	"properties": {
+		"expires": {
+			"type": "number",
+			"description": "Token Expiry Unix Time",
+			"minimum": 1
+		},
+		"token": {
+			"type": "string",
+			"description": "JWT Token"
+		}
+	}
+}

backend/embed/api_docs/components/UpstreamList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "UpstreamList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/UpstreamObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/UpstreamObject.json

@@ -0,0 +1,140 @@
+{
+	"type": "object",
+	"description": "UpstreamObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"user_id",
+		"name",
+		"nginx_template_id",
+		"ip_hash",
+		"ntlm",
+		"keepalive",
+		"keepalive_requests",
+		"keepalive_time",
+		"keepalive_timeout",
+		"advanced_config",
+		"status",
+		"error_message",
+		"servers"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"maxLength": 100
+		},
+		"nginx_template_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"ip_hash": {
+			"type": "boolean"
+		},
+		"ntlm": {
+			"type": "boolean"
+		},
+		"keepalive": {
+			"type": "integer"
+		},
+		"keepalive_requests": {
+			"type": "integer"
+		},
+		"keepalive_time": {
+			"type": "string"
+		},
+		"keepalive_timeout": {
+			"type": "string"
+		},
+		"advanced_config": {
+			"type": "string"
+		},
+		"status": {
+			"type": "string"
+		},
+		"error_message": {
+			"type": "string"
+		},
+		"user": {
+			"$ref": "#/components/schemas/UserObject"
+		},
+		"servers": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"additionalProperties": false,
+				"required": [
+					"id",
+					"created_at",
+					"updated_at",
+					"upstream_id",
+					"server",
+					"weight",
+					"max_conns",
+					"max_fails",
+					"fail_timeout",
+					"backup"
+				],
+				"properties": {
+					"id": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"created_at": {
+						"type": "integer",
+						"minimum": 1,
+						"description": "Created Unix time with milliseconds"
+					},
+					"updated_at": {
+						"type": "integer",
+						"minimum": 1,
+						"description": "Updated Unix time with milliseconds"
+					},
+					"upstream_id": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"server": {
+						"type": "string",
+						"minLength": 2
+					},
+					"weight": {
+						"type": "integer"
+					},
+					"max_conns": {
+						"type": "integer"
+					},
+					"max_fails": {
+						"type": "integer"
+					},
+					"fail_timeout": {
+						"type": "integer"
+					},
+					"backup": {
+						"type": "boolean"
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/components/UserAuthObject.json

@@ -0,0 +1,30 @@
+{
+	"type": "object",
+	"description": "UserAuthObject",
+	"additionalProperties": false,
+	"required": ["id", "user_id", "type", "created_at", "updated_at"],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"type": {
+			"type": "string",
+			"pattern": "^(local|ldap|oauth)$"
+		}
+	}
+}

backend/embed/api_docs/components/UserList.json

@@ -0,0 +1,40 @@
+{
+	"type": "object",
+	"description": "UserList",
+	"additionalProperties": false,
+	"required": ["total", "offset", "limit", "sort"],
+	"properties": {
+		"total": {
+			"type": "integer",
+			"description": "Total number of rows"
+		},
+		"offset": {
+			"type": "integer",
+			"description": "Pagination Offset"
+		},
+		"limit": {
+			"type": "integer",
+			"description": "Pagination Limit"
+		},
+		"sort": {
+			"type": "array",
+			"description": "Sorting",
+			"items": {
+				"$ref": "#/components/schemas/SortObject"
+			}
+		},
+		"filter": {
+			"type": "array",
+			"description": "Filters",
+			"items": {
+				"$ref": "#/components/schemas/FilterObject"
+			}
+		},
+		"items": {
+			"type": "array",
+			"items": {
+				"$ref": "#/components/schemas/UserObject"
+			}
+		}
+	}
+}

backend/embed/api_docs/components/UserObject.json

@@ -0,0 +1,69 @@
+{
+	"type": "object",
+	"description": "UserObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_at",
+		"updated_at",
+		"name",
+		"email",
+		"is_disabled"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Created Unix time with milliseconds"
+		},
+		"updated_at": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Updated Unix time with milliseconds"
+		},
+		"name": {
+			"type": "string",
+			"minLength": 2,
+			"maxLength": 50
+		},
+		"email": {
+			"type": "string",
+			"minLength": 5,
+			"maxLength": 150
+		},
+		"gravatar_url": {
+			"type": "string"
+		},
+		"is_disabled": {
+			"type": "boolean"
+		},
+		"is_system": {
+			"type": "boolean"
+		},
+		"auth": {
+			"type": "object",
+			"required": ["type"],
+			"properties": {
+				"id": {
+					"type": "integer"
+				},
+				"type": {
+					"type": "string",
+					"pattern": "^(local|ldap|oauth)$"
+				}
+			}
+		},
+		"capabilities": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"type": "string",
+				"minLength": 1
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/auth/get.json

@@ -0,0 +1,28 @@
+{
+	"operationId": "getAuthConfig",
+	"summary": "Returns auth configuration",
+	"tags": ["Auth"],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/AuthConfigObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": "todo"
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/auth/post.json

@@ -0,0 +1,75 @@
+{
+	"operationId": "requestToken",
+	"summary": "Request a new access token from credentials",
+	"tags": ["Auth"],
+	"requestBody": {
+		"description": "Credentials Payload",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.GetToken}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/TokenObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"expires": 1566540510,
+									"token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.ey...xaHKYr3Kk6MvkUjcC4",
+									"scope": "user"
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"403": {
+			"description": "403 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"additionalProperties": false,
+						"required": ["error"],
+						"properties": {
+							"result": {
+								"type": "object",
+								"nullable": true
+							},
+							"error": {
+								"$ref": "#/components/schemas/ErrorObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": null,
+								"error": {
+									"code": 403,
+									"message": "Not available during setup phase"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/auth/refresh/post.json

@@ -0,0 +1,34 @@
+{
+	"operationId": "refreshToken",
+	"summary": "Refresh your access token",
+	"tags": ["Auth"],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/TokenObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"expires": 1566540510,
+									"token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.ey...xaHKYr3Kk6MvkUjcC4",
+									"scope": "user"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/auth/sse/post.json

@@ -0,0 +1,34 @@
+{
+	"operationId": "requestSSEToken",
+	"summary": "Request a new SSE token",
+	"tags": ["Auth"],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/TokenObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"expires": 1566540510,
+									"token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.ey...xaHKYr3Kk6MvkUjcC4",
+									"scope": "user"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates-authorities/caID/delete.json

@@ -0,0 +1,39 @@
+{
+	"operationId": "deleteCertificateAuthority",
+	"summary": "Delete a Certificate Authority",
+	"tags": [
+		"Certificate Authorities"
+	],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "caID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "Numeric ID of the Certificate Authority",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": true
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates-authorities/caID/get.json

@@ -0,0 +1,53 @@
+{
+	"operationId": "getCertificateAuthority",
+	"summary": "Get a Certificate Authority object by ID",
+	"tags": ["Certificate Authorities"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "caID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Certificate Authority",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateAuthorityObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1627531400000,
+									"updated_at": 1627531400000,
+									"name": "ZeroSSL",
+									"acmesh_server": "zerossl",
+									"ca_bundle": "",
+									"max_domains": 10,
+									"is_wildcard_supported": true,
+									"is_readonly": false
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates-authorities/caID/put.json

@@ -0,0 +1,62 @@
+{
+	"operationId": "updateCertificateAuthority",
+	"summary": "Update an existing Certificate Authority",
+	"tags": ["Certificate Authorities"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "caID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Certificate Authority",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "Certificate Authority details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateCertificateAuthority}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateAuthorityObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1627531400000,
+									"updated_at": 1627531400000,
+									"name": "ZeroSSL",
+									"acmesh_server": "zerossl",
+									"ca_bundle": "",
+									"max_domains": 10,
+									"is_wildcard_supported": true,
+									"is_readonly": false
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates-authorities/get.json

@@ -0,0 +1,93 @@
+{
+	"operationId": "getCertificateAuthorities",
+	"summary": "Get a list of Certificate Authorities",
+	"tags": ["Certificate Authorities"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateAuthorityList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 2,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_at": 1627531400000,
+											"updated_at": 1627531400000,
+											"name": "ZeroSSL",
+											"acmesh_server": "zerossl",
+											"ca_bundle": "",
+											"max_domains": 10,
+											"is_wildcard_supported": true,
+											"is_setup": true
+										},
+										{
+											"id": 2,
+											"created_at": 1627531400000,
+											"updated_at": 1627531400000,
+											"name": "Let's Encrypt",
+											"acmesh_server": "https://acme-v02.api.letsencrypt.org/directory",
+											"ca_bundle": "",
+											"max_domains": 10,
+											"is_wildcard_supported": true,
+											"is_setup": true
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates-authorities/post.json

@@ -0,0 +1,49 @@
+{
+	"operationId": "createCertificateAuthority",
+	"summary": "Create a new Certificate Authority",
+	"tags": ["Certificate Authorities"],
+	"requestBody": {
+		"description": "Certificate Authority to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateCertificateAuthority}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateAuthorityObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1627531400000,
+									"updated_at": 1627531400000,
+									"name": "ZeroSSL",
+									"acmesh_server": "zerossl",
+									"ca_bundle": "",
+									"max_domains": 10,
+									"is_wildcard_supported": true,
+									"is_readonly": false
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates/certificateID/delete.json

@@ -0,0 +1,60 @@
+{
+	"operationId": "deleteCertificate",
+	"summary": "Delete a Certificate",
+	"tags": [
+		"Certificates"
+	],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "certificateID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "Numeric ID of the certificate",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": true
+							}
+						}
+					}
+				}
+			}
+		},
+		"400": {
+			"description": "400 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": null,
+								"error": {
+									"code": 400,
+									"message": "You cannot delete a certificate that is in use!"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates/certificateID/get.json

@@ -0,0 +1,56 @@
+{
+	"operationId": "getCertificate",
+	"summary": "Get a certificate object by ID",
+	"tags": ["Certificates"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "certificateID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the certificate",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1604536109000,
+									"updated_at": 1604536109000,
+									"expires_on": null,
+									"type": "dns",
+									"user_id": 1,
+									"certificate_authority_id": 2,
+									"dns_provider_id": 1,
+									"name": "test1.jc21.com.au",
+									"domain_names": ["test1.jc21.com.au"],
+									"is_ecc": 0,
+									"status": "ready"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates/certificateID/put.json

@@ -0,0 +1,65 @@
+{
+	"operationId": "updateCertificate",
+	"summary": "Update an existing Certificate",
+	"tags": ["Certificates"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "certificateID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the certificate",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "Certificate details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateCertificate}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1604536109000,
+									"updated_at": 1604536109000,
+									"expires_on": null,
+									"type": "dns",
+									"user_id": 1,
+									"certificate_authority_id": 2,
+									"dns_provider_id": 1,
+									"name": "test1.jc21.com.au",
+									"domain_names": ["test1.jc21.com.au"],
+									"is_ecc": 0,
+									"status": "ready"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates/get.json

@@ -0,0 +1,87 @@
+{
+	"operationId": "getCertificates",
+	"summary": "Get a list of certificates",
+	"tags": ["Certificates"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 1,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_at": 1604536109000,
+											"updated_at": 1604536109000,
+											"expires_on": null,
+											"type": "dns",
+											"user_id": 1,
+											"certificate_authority_id": 2,
+											"dns_provider_id": 1,
+											"name": "test1.jc21.com.au",
+											"domain_names": [
+												"test1.jc21.com.au"
+											],
+											"is_ecc": 0,
+											"status": "ready"
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/certificates/post.json

@@ -0,0 +1,52 @@
+{
+	"operationId": "createCertificate",
+	"summary": "Create a new Certificate",
+	"tags": ["Certificates"],
+	"requestBody": {
+		"description": "Certificate to create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateCertificate}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1604536109000,
+									"updated_at": 1604536109000,
+									"expires_on": null,
+									"type": "dns",
+									"user_id": 1,
+									"certificate_authority_id": 2,
+									"dns_provider_id": 1,
+									"name": "test1.jc21.com.au",
+									"domain_names": ["test1.jc21.com.au"],
+									"is_ecc": 0,
+									"status": "ready"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/config/get.json

@@ -0,0 +1,35 @@
+{
+	"operationId": "config",
+	"summary": "Returns the API Service configuration",
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/ConfigObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"data": "/data",
+									"log": {
+										"level": "debug",
+										"format": "nice"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/dns-providers/get.json

@@ -0,0 +1,83 @@
+{
+	"operationId": "getDNSProviders",
+	"summary": "Get a list of DNS Providers",
+	"tags": ["DNS Providers"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/DNSProviderList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 1,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_at": 1602593653000,
+											"updated_at": 1602593653000,
+											"user_id": 1,
+											"name": "Route53",
+											"acmesh_name": "dns_aws",
+											"meta": {
+												"AWS_ACCESS_KEY_ID": "abc123",
+												"AWS_SECRET_ACCESS_KEY": "def098"
+											}
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/dns-providers/post.json

@@ -0,0 +1,50 @@
+{
+	"operationId": "createDNSProvider",
+	"summary": "Create a new DNS Provider",
+	"tags": ["DNS Providers"],
+	"requestBody": {
+		"description": "DNS Provider to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateDNSProvider}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/DNSProviderObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1602593653000,
+									"updated_at": 1602593653000,
+									"user_id": 1,
+									"name": "Route53",
+									"acmesh_name": "dns_aws",
+									"meta": {
+										"AWS_ACCESS_KEY_ID": "abc123",
+										"AWS_SECRET_ACCESS_KEY": "def098"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/dns-providers/providerID/delete.json

@@ -0,0 +1,60 @@
+{
+	"operationId": "deleteDNSProvider",
+	"summary": "Delete a DNS Provider",
+	"tags": [
+		"DNS Providers"
+	],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "providerID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "Numeric ID of the DNS Provider",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": true
+							}
+						}
+					}
+				}
+			}
+		},
+		"400": {
+			"description": "400 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": null,
+								"error": {
+									"code": 400,
+									"message": "You cannot delete a DNS Provider that is in use!"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/dns-providers/providerID/get.json

@@ -0,0 +1,54 @@
+{
+	"operationId": "getDNSProvider",
+	"summary": "Get a DNS Provider object by ID",
+	"tags": ["DNS Providers"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "providerID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the DNS Provider",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/DNSProviderObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1602593653000,
+									"updated_at": 1602593653000,
+									"user_id": 1,
+									"name": "Route53",
+									"acmesh_name": "dns_aws",
+									"meta": {
+										"AWS_ACCESS_KEY_ID": "abc123",
+										"AWS_SECRET_ACCESS_KEY": "def098"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/dns-providers/providerID/put.json

@@ -0,0 +1,65 @@
+{
+	"operationId": "updateDNSProvider",
+	"summary": "Update an existing DNS Provider",
+	"tags": ["DNS Providers"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "providerID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the DNS Provider",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "DNS Provider details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateDNSProvider}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/DNSProviderObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"result": {
+										"id": 1,
+										"created_at": 1602593653000,
+										"updated_at": 1602593653000,
+										"user_id": 1,
+										"name": "Route53",
+										"acmesh_name": "dns_aws",
+										"meta": {
+											"AWS_ACCESS_KEY_ID": "abc123",
+											"AWS_SECRET_ACCESS_KEY": "def098"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/get.json

@@ -0,0 +1,44 @@
+{
+	"operationId": "health",
+	"summary": "Returns the API health status",
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HealthObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"version": "3.0.0",
+									"commit": "9f119b6",
+									"healthy": true,
+									"setup": true
+								}
+							}
+						},
+						"unhealthy": {
+							"value": {
+								"result": {
+									"version": "3.0.0",
+									"commit": "9f119b6",
+									"healthy": false,
+									"setup": true
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/hosts/get.json

@@ -0,0 +1,94 @@
+{
+	"operationId": "getHosts",
+	"summary": "Get a list of Hosts",
+	"tags": ["Hosts"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HostList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 1,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "domain_names",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_at": 1646279455000,
+											"updated_at": 1646279455000,
+											"user_id": 2,
+											"type": "proxy",
+											"nginx_template_id": 1,
+											"listen_interface": "",
+											"domain_names": ["jc21.com"],
+											"upstream_id": 0,
+											"certificate_id": 0,
+											"access_list_id": 0,
+											"ssl_forced": false,
+											"caching_enabled": false,
+											"block_exploits": false,
+											"allow_websocket_upgrade": false,
+											"http2_support": false,
+											"hsts_enabled": false,
+											"hsts_subdomains": false,
+											"paths": "",
+											"advanced_config": "",
+											"is_disabled": false
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/hosts/hostID/delete.json

@@ -1,11 +1,8 @@
 {
-	"operationId": "enableProxyHost",
+	"operationId": "deleteHost",
-	"summary": "Enable a Proxy Host",
+	"summary": "Delete a Host",
-	"tags": ["Proxy Hosts"],
+	"tags": [
-	"security": [
+		"Hosts"
-		{
-			"BearerAuth": ["proxy_hosts"]
-		}
 	],
 	"parameters": [
 		{
@@ -16,7 +13,8 @@
 				"minimum": 1
 			},
 			"required": true,
-			"example": 2
+			"description": "Numeric ID of the Host",
+			"example": 1
 		}
 	],
 	"responses": {
@@ -24,13 +22,15 @@
 			"description": "200 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
-							"value": true
+							"value": {
+								"result": true
+							}
 						}
-					},
-					"schema": {
-						"type": "boolean"
 					}
 				}
 			}
@@ -39,21 +39,22 @@
 			"description": "400 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
 							"value": {
+								"result": null,
 								"error": {
 									"code": 400,
-									"message": "Host is already enabled"
+									"message": "You cannot delete a host that is in use!"
 								}
 							}
 						}
-					},
-					"schema": {
-						"$ref": "../../../../../components/error.json"
 					}
 				}
 			}
 		}
 	}
-}
+}

backend/embed/api_docs/paths/hosts/hostID/get.json

@@ -0,0 +1,65 @@
+{
+	"operationId": "getHost",
+	"summary": "Get a Host object by ID",
+	"tags": ["Hosts"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "hostID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Host",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HostObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1646279455000,
+									"updated_at": 1646279455000,
+									"user_id": 2,
+									"type": "proxy",
+									"nginx_template_id": 1,
+									"listen_interface": "",
+									"domain_names": ["jc21.com"],
+									"upstream_id": 0,
+									"certificate_id": 0,
+									"access_list_id": 0,
+									"ssl_forced": false,
+									"caching_enabled": false,
+									"block_exploits": false,
+									"allow_websocket_upgrade": false,
+									"http2_support": false,
+									"hsts_enabled": false,
+									"hsts_subdomains": false,
+									"paths": "",
+									"advanced_config": "",
+									"is_disabled": false
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/hosts/hostID/nginx-config/get.json

@@ -0,0 +1,43 @@
+{
+	"operationId": "getHostNginxConfig",
+	"summary": "Get a Host Nginx Config object by ID",
+	"tags": ["Hosts"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "hostID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Host",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"type": "string"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": "# ------------------------------------------------------------\n# a.example.com\n# ------------------------------------------------------------\nserver {\n  listen 80;\n  server_name a.example.com ;\n  access_log /data/logs/host-1_access.log proxy;\n  error_log /data/logs/host-1_error.log warn;\n  # locations ?\n  # default location:\n  location / {\n    # Access Rules ? todo\n    # Access checks must...? todo\n    # Proxy!\n    add_header       X-Served-By $host;\n    proxy_set_header Host $host;\n    proxy_set_header X-Forwarded-Scheme $scheme;\n    proxy_set_header X-Forwarded-Proto  $scheme;\n    proxy_set_header X-Forwarded-For    $remote_addr;\n    proxy_http_version 1.1;\n    # proxy a single host\n    proxy_pass http://192.168.0.10:80;\n  }\n  # Legacy Custom Configuration\n  include /data/nginx/custom/server_proxy[.]conf;\n}\n"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/hosts/hostID/put.json

@@ -0,0 +1,74 @@
+{
+	"operationId": "updateHost",
+	"summary": "Update an existing Host",
+	"tags": ["Hosts"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "hostID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Host",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "Host details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateHost}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HostObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1646279455000,
+									"updated_at": 1646279455000,
+									"user_id": 2,
+									"type": "proxy",
+									"nginx_template_id": 1,
+									"listen_interface": "",
+									"domain_names": ["jc21.com"],
+									"upstream_id": 0,
+									"certificate_id": 0,
+									"access_list_id": 0,
+									"ssl_forced": false,
+									"caching_enabled": false,
+									"block_exploits": false,
+									"allow_websocket_upgrade": false,
+									"http2_support": false,
+									"hsts_enabled": false,
+									"hsts_subdomains": false,
+									"paths": "",
+									"advanced_config": "",
+									"is_disabled": false
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/hosts/post.json

@@ -0,0 +1,61 @@
+{
+	"operationId": "createHost",
+	"summary": "Create a new Host",
+	"tags": ["Hosts"],
+	"requestBody": {
+		"description": "Host to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateHost}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HostObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1645700556000,
+									"updated_at": 1645700556000,
+									"user_id": 2,
+									"type": "proxy",
+									"nginx_template_id": 1,
+									"listen_interface": "",
+									"domain_names": ["jc21.com"],
+									"upstream_id": 0,
+									"certificate_id": 0,
+									"access_list_id": 0,
+									"ssl_forced": false,
+									"caching_enabled": false,
+									"block_exploits": false,
+									"allow_websocket_upgrade": false,
+									"http2_support": false,
+									"hsts_enabled": false,
+									"hsts_subdomains": false,
+									"paths": "",
+									"advanced_config": "",
+									"is_disabled": false
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/nginx-templates/get.json

@@ -0,0 +1,80 @@
+{
+	"operationId": "getNginxTemplates",
+	"summary": "Get a list of Nginx Templates",
+	"tags": ["Nginx Templates"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 1,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "created_at",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_at": 1646218093000,
+											"updated_at": 1646218093000,
+											"user_id": 1,
+											"name": "Default Proxy Template",
+											"type": "proxy",
+											"template": "# this is a proxy template"
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/nginx-templates/post.json

@@ -0,0 +1,47 @@
+{
+	"operationId": "createNginxTemplate",
+	"summary": "Create a new Nginx Template",
+	"tags": ["Nginx Templates"],
+	"requestBody": {
+		"description": "Template to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateNginxTemplate}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 10,
+									"created_at": 1646218093000,
+									"updated_at": 1646218093000,
+									"user_id": 1,
+									"name": "My proxy template",
+									"type": "proxy",
+									"template": "# this is a proxy template"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/nginx-templates/templateID/delete.json

@@ -1,22 +1,18 @@
 {
-	"operationId": "disableProxyHost",
+	"operationId": "deleteNginxTemplate",
-	"summary": "Disable a Proxy Host",
+	"summary": "Delete a Nginx Template",
-	"tags": ["Proxy Hosts"],
+	"tags": ["Nginx Templates"],
-	"security": [
-		{
-			"BearerAuth": ["proxy_hosts"]
-		}
-	],
 	"parameters": [
 		{
 			"in": "path",
-			"name": "hostID",
+			"name": "templateID",
 			"schema": {
 				"type": "integer",
 				"minimum": 1
 			},
 			"required": true,
-			"example": 2
+			"description": "Numeric ID of the Template",
+			"example": 1
 		}
 	],
 	"responses": {
@@ -24,13 +20,15 @@
 			"description": "200 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
-							"value": true
+							"value": {
+								"result": true
+							}
 						}
-					},
-					"schema": {
-						"type": "boolean"
 					}
 				}
 			}
@@ -39,18 +37,19 @@
 			"description": "400 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
 							"value": {
+								"result": null,
 								"error": {
 									"code": 400,
-									"message": "Host is already disabled"
+									"message": "You cannot delete a template that is in use!"
 								}
 							}
 						}
-					},
-					"schema": {
-						"$ref": "../../../../../components/error.json"
 					}
 				}
 			}

backend/embed/api_docs/paths/nginx-templates/templateID/get.json

@@ -0,0 +1,51 @@
+{
+	"operationId": "getNginxTemplate",
+	"summary": "Get a Nginx Template object by ID",
+	"tags": ["Nginx Templates"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "templateID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Host Template",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1646218093000,
+									"updated_at": 1646218093000,
+									"user_id": 1,
+									"name": "Default Proxy Template",
+									"type": "proxy",
+									"template": "# this is a proxy template"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/nginx-templates/templateID/put.json

@@ -0,0 +1,60 @@
+{
+	"operationId": "updateNginxTemplate",
+	"summary": "Update an existing Nginx Template",
+	"tags": ["Nginx Templates"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "templateID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Template",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "Template details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateNginxTemplate}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1646218093000,
+									"updated_at": 1646218093000,
+									"user_id": 1,
+									"name": "My renamed proxy template",
+									"type": "proxy",
+									"template": "# this is a proxy template"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/schema/get.json

@@ -1,10 +1,9 @@
 {
 	"operationId": "schema",
 	"summary": "Returns this swagger API schema",
-	"tags": ["Public"],
 	"responses": {
 		"200": {
 			"description": "200 response"
 		}
 	}
-}
+}

backend/embed/api_docs/paths/settings/get.json

@@ -0,0 +1,81 @@
+{
+	"operationId": "getSettings",
+	"summary": "Get a list of settings",
+	"tags": ["Settings"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/SettingList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 1,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_at": 1578010090000,
+											"updated_at": 1578010095000,
+											"name": "default-site",
+											"value": {
+												"html": "<p>not found</p>",
+												"type": "custom"
+											}
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/settings/name/get.json

@@ -0,0 +1,52 @@
+{
+	"operationId": "getSetting",
+	"summary": "Get a setting object by name",
+	"tags": ["Settings"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "name",
+			"schema": {
+				"type": "string",
+				"minLength": 2
+			},
+			"required": true,
+			"description": "Name of the setting",
+			"example": "default-site"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/SettingObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 2,
+									"created_at": 1578010090000,
+									"updated_at": 1578010095000,
+									"name": "default-site",
+									"value": {
+										"html": "<p>not found</p>",
+										"type": "custom"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/settings/name/put.json

@@ -0,0 +1,61 @@
+{
+	"operationId": "updateSetting",
+	"summary": "Update an existing Setting",
+	"tags": ["Settings"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "name",
+			"schema": {
+				"type": "string",
+				"minLength": 2
+			},
+			"required": true,
+			"description": "Name of the setting",
+			"example": "default-site"
+		}
+	],
+	"requestBody": {
+		"description": "Setting details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateSetting}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/SettingObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 2,
+									"created_at": 1578010090000,
+									"updated_at": 1578010090000,
+									"name": "default-site",
+									"value": {
+										"html": "<p>not found</p>",
+										"type": "custom"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/settings/post.json

@@ -0,0 +1,48 @@
+{
+	"operationId": "createSetting",
+	"summary": "Create a new Setting",
+	"tags": ["Settings"],
+	"requestBody": {
+		"description": "Setting to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateSetting}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/SettingObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 2,
+									"created_at": 1578010090000,
+									"updated_at": 1578010090000,
+									"name": "default-site",
+									"value": {
+										"html": "<p>not found</p>",
+										"type": "custom"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/streams/get.json

@@ -0,0 +1,70 @@
+{
+	"operationId": "getStreams",
+	"summary": "Get a list of Streams",
+	"tags": ["Streams"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 1,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										}
+									],
+									"items": ["TODO"]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/streams/post.json

@@ -0,0 +1,39 @@
+{
+	"operationId": "createStream",
+	"summary": "Create a new Stream",
+	"tags": ["Streams"],
+	"requestBody": {
+		"description": "Stream to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateStream}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": "TODO"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/streams/streamID/delete.json

@@ -1,11 +1,8 @@
 {
-	"operationId": "disableStream",
+	"operationId": "deleteStream",
-	"summary": "Disable a Stream",
+	"summary": "Delete a Stream",
-	"tags": ["Streams"],
+	"tags": [
-	"security": [
+		"Streams"
-		{
-			"BearerAuth": ["streams"]
-		}
 	],
 	"parameters": [
 		{
@@ -16,7 +13,8 @@
 				"minimum": 1
 			},
 			"required": true,
-			"example": 2
+			"description": "Numeric ID of the Stream",
+			"example": 1
 		}
 	],
 	"responses": {
@@ -24,13 +22,15 @@
 			"description": "200 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
-							"value": true
+							"value": {
+								"result": true
+							}
 						}
-					},
-					"schema": {
-						"type": "boolean"
 					}
 				}
 			}
@@ -39,21 +39,22 @@
 			"description": "400 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
 							"value": {
+								"result": null,
 								"error": {
 									"code": 400,
-									"message": "Host is already disabled"
+									"message": "You cannot delete a Stream that is in use!"
 								}
 							}
 						}
-					},
-					"schema": {
-						"$ref": "../../../../../components/error.json"
 					}
 				}
 			}
 		}
 	}
-}
+}

backend/embed/api_docs/paths/streams/streamID/get.json

@@ -1,12 +1,7 @@
 {
-	"operationId": "deleteStream",
+	"operationId": "getStream",
-	"summary": "Delete a Stream",
+	"summary": "Get a Stream object by ID",
 	"tags": ["Streams"],
-	"security": [
-		{
-			"BearerAuth": ["streams"]
-		}
-	],
 	"parameters": [
 		{
 			"in": "path",
@@ -16,7 +11,8 @@
 				"minimum": 1
 			},
 			"required": true,
-			"example": 2
+			"description": "ID of the Stream",
+			"example": 1
 		}
 	],
 	"responses": {
@@ -24,13 +20,21 @@
 			"description": "200 response",
 			"content": {
 				"application/json": {
-					"examples": {
+					"schema": {
-						"default": {
+						"type": "object",
-							"value": true
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamObject"
+							}
 						}
 					},
-					"schema": {
+					"examples": {
-						"type": "boolean"
+						"default": {
+							"value": {
+								"result": "TODO"
+							}
+						}
 					}
 				}
 			}

backend/embed/api_docs/paths/streams/streamID/put.json

@@ -0,0 +1,52 @@
+{
+	"operationId": "updateStream",
+	"summary": "Update an existing Stream",
+	"tags": ["Streams"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "streamID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Stream",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "Stream details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateStream}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": "TODO"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/upstreams/get.json

@@ -0,0 +1,286 @@
+{
+	"operationId": "getUpstreams",
+	"summary": "Get a list of Upstreams",
+	"tags": ["Upstreams"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "id,name.asc,value.desc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UpstreamList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 5,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_at": 1672804124000,
+											"updated_at": 1672804124000,
+											"user_id": 2,
+											"name": "API servers",
+											"nginx_template_id": 5,
+											"ip_hash": true,
+											"ntlm": false,
+											"keepalive": 10,
+											"keepalive_requests": 10,
+											"keepalive_time": "60s",
+											"keepalive_timeout": "3s",
+											"advanced_config": "",
+											"status": "ok",
+											"error_message": "",
+											"servers": [
+												{
+													"id": 1,
+													"created_at": 1672804124000,
+													"updated_at": 1672804124000,
+													"upstream_group_id": 1,
+													"server": "192.168.0.10:80",
+													"weight": 100,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												},
+												{
+													"id": 2,
+													"created_at": 1672804124000,
+													"updated_at": 1672804124000,
+													"upstream_group_id": 1,
+													"server": "192.168.0.11:80",
+													"weight": 50,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												}
+											]
+										},
+										{
+											"id": 2,
+											"created_at": 1672804197000,
+											"updated_at": 1672804197000,
+											"user_id": 2,
+											"name": "API servers 2",
+											"nginx_template_id": 5,
+											"ip_hash": false,
+											"ntlm": false,
+											"keepalive": 0,
+											"keepalive_requests": 0,
+											"keepalive_time": "",
+											"keepalive_timeout": "",
+											"advanced_config": "",
+											"status": "ok",
+											"error_message": "",
+											"servers": [
+												{
+													"id": 3,
+													"created_at": 1672804197000,
+													"updated_at": 1672804197000,
+													"upstream_group_id": 2,
+													"server": "192.168.0.10:80",
+													"weight": 100,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												},
+												{
+													"id": 4,
+													"created_at": 1672804197000,
+													"updated_at": 1672804197000,
+													"upstream_group_id": 2,
+													"server": "192.168.0.11:80",
+													"weight": 50,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												}
+											]
+										},
+										{
+											"id": 3,
+											"created_at": 1672804200000,
+											"updated_at": 1672804200000,
+											"user_id": 2,
+											"name": "API servers 2",
+											"nginx_template_id": 5,
+											"ip_hash": false,
+											"ntlm": false,
+											"keepalive": 0,
+											"keepalive_requests": 0,
+											"keepalive_time": "",
+											"keepalive_timeout": "",
+											"advanced_config": "",
+											"status": "ok",
+											"error_message": "",
+											"servers": [
+												{
+													"id": 5,
+													"created_at": 1672804200000,
+													"updated_at": 1672804200000,
+													"upstream_group_id": 3,
+													"server": "192.168.0.10:80",
+													"weight": 100,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												},
+												{
+													"id": 6,
+													"created_at": 1672804200000,
+													"updated_at": 1672804200000,
+													"upstream_group_id": 3,
+													"server": "192.168.0.11:80",
+													"weight": 50,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												}
+											]
+										},
+										{
+											"id": 4,
+											"created_at": 1672804201000,
+											"updated_at": 1672804201000,
+											"user_id": 2,
+											"name": "API servers 2",
+											"nginx_template_id": 5,
+											"ip_hash": false,
+											"ntlm": false,
+											"keepalive": 0,
+											"keepalive_requests": 0,
+											"keepalive_time": "",
+											"keepalive_timeout": "",
+											"advanced_config": "",
+											"status": "ok",
+											"error_message": "",
+											"servers": [
+												{
+													"id": 7,
+													"created_at": 1672804201000,
+													"updated_at": 1672804201000,
+													"upstream_group_id": 4,
+													"server": "192.168.0.10:80",
+													"weight": 100,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												},
+												{
+													"id": 8,
+													"created_at": 1672804201000,
+													"updated_at": 1672804201000,
+													"upstream_group_id": 4,
+													"server": "192.168.0.11:80",
+													"weight": 50,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												}
+											]
+										},
+										{
+											"id": 5,
+											"created_at": 1672804201000,
+											"updated_at": 1672804201000,
+											"user_id": 2,
+											"name": "API servers 2",
+											"nginx_template_id": 5,
+											"ip_hash": false,
+											"ntlm": false,
+											"keepalive": 0,
+											"keepalive_requests": 0,
+											"keepalive_time": "",
+											"keepalive_timeout": "",
+											"advanced_config": "",
+											"status": "ok",
+											"error_message": "",
+											"servers": [
+												{
+													"id": 9,
+													"created_at": 1672804201000,
+													"updated_at": 1672804201000,
+													"upstream_group_id": 5,
+													"server": "192.168.0.10:80",
+													"weight": 100,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												},
+												{
+													"id": 10,
+													"created_at": 1672804201000,
+													"updated_at": 1672804201000,
+													"upstream_group_id": 5,
+													"server": "192.168.0.11:80",
+													"weight": 50,
+													"max_conns": 0,
+													"max_fails": 0,
+													"fail_timeout": 0,
+													"backup": false
+												}
+											]
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/upstreams/post.json

@@ -0,0 +1,81 @@
+{
+	"operationId": "createUpstream",
+	"summary": "Create a new Upstream",
+	"tags": ["Upstreams"],
+	"requestBody": {
+		"description": "Upstream to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateUpstream}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UpstreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 6,
+									"created_at": 1672806857000,
+									"updated_at": 1672806857000,
+									"user_id": 2,
+									"name": "API servers 2",
+									"nginx_template_id": 5,
+									"ip_hash": false,
+									"ntlm": false,
+									"keepalive": 0,
+									"keepalive_requests": 0,
+									"keepalive_time": "",
+									"keepalive_timeout": "",
+									"advanced_config": "",
+									"status": "ready",
+									"error_message": "",
+									"servers": [
+										{
+											"id": 11,
+											"created_at": 1672806857000,
+											"updated_at": 1672806857000,
+											"upstream_id": 6,
+											"server": "192.168.0.10:80",
+											"weight": 100,
+											"max_conns": 0,
+											"max_fails": 0,
+											"fail_timeout": 0,
+											"backup": false
+										},
+										{
+											"id": 12,
+											"created_at": 1672806857000,
+											"updated_at": 1672806857000,
+											"upstream_id": 6,
+											"server": "192.168.0.11:80",
+											"weight": 50,
+											"max_conns": 0,
+											"max_fails": 0,
+											"fail_timeout": 0,
+											"backup": false
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/upstreams/upstreamID/delete.json

@@ -1,22 +1,18 @@
 {
-	"operationId": "disableDeadHost",
+	"operationId": "deleteUpstream",
-	"summary": "Disable a 404 Host",
+	"summary": "Delete a Upstream",
-	"tags": ["404 Hosts"],
+	"tags": ["Upstreams"],
-	"security": [
-		{
-			"BearerAuth": ["dead_hosts"]
-		}
-	],
 	"parameters": [
 		{
 			"in": "path",
-			"name": "hostID",
+			"name": "upstreamID",
 			"schema": {
 				"type": "integer",
 				"minimum": 1
 			},
 			"required": true,
-			"example": 2
+			"description": "Numeric ID of the Upstream",
+			"example": 1
 		}
 	],
 	"responses": {
@@ -24,13 +20,15 @@
 			"description": "200 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
-							"value": true
+							"value": {
+								"result": true
+							}
 						}
-					},
-					"schema": {
-						"type": "boolean"
 					}
 				}
 			}
@@ -39,18 +37,19 @@
 			"description": "400 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
 							"value": {
+								"result": null,
 								"error": {
 									"code": 400,
-									"message": "Host is already disabled"
+									"message": "You cannot delete a Upstream that is in use!"
 								}
 							}
 						}
-					},
-					"schema": {
-						"$ref": "../../../../../components/error.json"
 					}
 				}
 			}

backend/embed/api_docs/paths/upstreams/upstreamID/get.json

@@ -0,0 +1,82 @@
+{
+	"operationId": "getUpstream",
+	"summary": "Get a Upstream object by ID",
+	"tags": ["Upstreams"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "upstreamID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Upstream",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UpstreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1672786008000,
+									"updated_at": 1672786008000,
+									"user_id": 2,
+									"name": "API servers 3",
+									"ip_hash": true,
+									"ntlm": false,
+									"keepalive": 10,
+									"keepalive_requests": 10,
+									"keepalive_time": "60s",
+									"keepalive_timeout": "3s",
+									"advanced_config": "",
+									"servers": [
+										{
+											"id": 1,
+											"created_at": 1672786009000,
+											"updated_at": 1672786009000,
+											"upstream_id": 1,
+											"server": "api1.localhost:1234",
+											"weight": 100,
+											"max_conns": 0,
+											"max_fails": 0,
+											"fail_timeout": 0,
+											"backup": false
+										},
+										{
+											"id": 2,
+											"created_at": 1672786009000,
+											"updated_at": 1672786009000,
+											"upstream_id": 1,
+											"server": "api2.localhost:1234",
+											"weight": 50,
+											"max_conns": 0,
+											"max_fails": 0,
+											"fail_timeout": 0,
+											"backup": true
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/upstreams/upstreamID/nginx-config/get.json

@@ -0,0 +1,43 @@
+{
+	"operationId": "getUpstreamNginxConfig",
+	"summary": "Get a Upstream Nginx Config object by ID",
+	"tags": ["Upstreams"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "upstreamID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Upstream",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"type": "string"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": "# ------------------------------------------------------------\n# Upstream 1: API servers\n# ------------------------------------------------------------\nupstream npm_upstream_1 {\nserver 192.168.0.10:80 weight=100 ;\n  server 192.168.0.11:80 weight=50 ;\n}\n"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/upstreams/upstreamID/put.json

@@ -0,0 +1,94 @@
+{
+	"operationId": "updateUpstream",
+	"summary": "Update an existing Upstream",
+	"tags": ["Upstreams"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "upstreamID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Upstream",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "Upstream details to update",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.UpdateUpstream}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UpstreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_at": 1673234177000,
+									"updated_at": 1673244559000,
+									"user_id": 2,
+									"name": "API servers 2",
+									"nginx_template_id": 5,
+									"ip_hash": false,
+									"ntlm": false,
+									"keepalive": 0,
+									"keepalive_requests": 0,
+									"keepalive_time": "",
+									"keepalive_timeout": "",
+									"advanced_config": "",
+									"status": "ready",
+									"error_message": "",
+									"servers": [
+										{
+											"id": 1,
+											"created_at": 1673234177000,
+											"updated_at": 1673244559000,
+											"upstream_id": 1,
+											"server": "192.168.0.10:80",
+											"weight": 100,
+											"max_conns": 0,
+											"max_fails": 0,
+											"fail_timeout": 0,
+											"backup": false
+										},
+										{
+											"id": 2,
+											"created_at": 1673234177000,
+											"updated_at": 1673244559000,
+											"upstream_id": 1,
+											"server": "192.168.0.11:80",
+											"weight": 50,
+											"max_conns": 0,
+											"max_fails": 0,
+											"fail_timeout": 0,
+											"backup": false
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/users/get.json

@@ -0,0 +1,111 @@
+{
+	"operationId": "getUsers",
+	"summary": "Get a list of users",
+	"tags": ["Users"],
+	"parameters": [
+		{
+			"in": "query",
+			"name": "offset",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row offset, default 0",
+			"example": 0
+		},
+		{
+			"in": "query",
+			"name": "limit",
+			"schema": {
+				"type": "number"
+			},
+			"description": "The pagination row limit, default 10",
+			"example": 10
+		},
+		{
+			"in": "query",
+			"name": "sort",
+			"schema": {
+				"type": "string"
+			},
+			"description": "The sorting of the list",
+			"example": "name,email.asc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UserList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 3,
+									"offset": 0,
+									"limit": 100,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										},
+										{
+											"field": "email",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"name": "Jamie Curnow",
+											"email": "jc@jc21.com",
+											"created_at": 1578010090000,
+											"updated_at": 1578010095000,
+											"gravatar_url": "https://www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?d=mm&r=pg&s=128",
+											"is_disabled": false,
+											"capabilities": ["full-admin"]
+										},
+										{
+											"id": 2,
+											"name": "John Doe",
+											"email": "johdoe@example.com",
+											"created_at": 1578010100000,
+											"updated_at": 1578010105000,
+											"gravatar_url": "https://www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?d=mm&r=pg&s=128",
+											"is_disabled": false,
+											"capabilities": [
+												"hosts.view",
+												"hosts.manage"
+											]
+										},
+										{
+											"id": 3,
+											"name": "Jane Doe",
+											"email": "janedoe@example.com",
+											"created_at": 1578010110000,
+											"updated_at": 1578010115000,
+											"gravatar_url": "https://www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?d=mm&r=pg&s=128",
+											"is_disabled": false,
+											"capabilities": [
+												"hosts.view",
+												"hosts.manage"
+											]
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/users/post.json

@@ -0,0 +1,81 @@
+{
+	"operationId": "createUser",
+	"summary": "Create a new User",
+	"tags": ["Users"],
+	"requestBody": {
+		"description": "User to Create",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.CreateUser}}"
+			}
+		}
+	},
+	"responses": {
+		"201": {
+			"description": "201 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UserObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"name": "Jamie Curnow",
+									"email": "jc@jc21.com",
+									"created_at": 1578010100000,
+									"updated_at": 1578010100000,
+									"gravatar_url": "https://www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?d=mm&r=pg&s=128",
+									"is_disabled": false,
+									"auth": {
+										"$ref": "#/components/schemas/UserAuthObject"
+									},
+									"capabilities": ["full-admin"]
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"400": {
+			"description": "400 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["error"],
+						"properties": {
+							"result": {
+								"type": "object",
+								"nullable": true
+							},
+							"error": {
+								"$ref": "#/components/schemas/ErrorObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"error": {
+									"code": 400,
+									"message": "An user already exists with this email address"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/users/userID/auth/post.json

@@ -0,0 +1,66 @@
+{
+	"operationId": "setPassword",
+	"summary": "Set a User's password",
+	"tags": ["Users"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "userID",
+			"schema": {
+				"oneOf": [
+					{
+						"type": "integer",
+						"minimum": 1
+					},
+					{
+						"type": "string",
+						"pattern": "^me$"
+					}
+				]
+			},
+			"required": true,
+			"description": "Numeric ID of the user or 'me' to set yourself",
+			"example": 1
+		}
+	],
+	"requestBody": {
+		"description": "Credentials to set",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.SetAuth}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"type": "object",
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UserAuthObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 2,
+									"created_at": 1648422222000,
+									"updated_at": 1648423979000,
+									"user_id": 3,
+									"type": "password"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

backend/embed/api_docs/paths/users/userID/delete.json

@@ -1,22 +1,20 @@
 {
-	"operationId": "enableDeadHost",
+	"operationId": "deleteUser",
-	"summary": "Enable a 404 Host",
+	"summary": "Delete a User",
-	"tags": ["404 Hosts"],
+	"tags": [
-	"security": [
+		"Users"
-		{
-			"BearerAuth": ["dead_hosts"]
-		}
 	],
 	"parameters": [
 		{
 			"in": "path",
-			"name": "hostID",
+			"name": "userID",
 			"schema": {
 				"type": "integer",
 				"minimum": 1
 			},
 			"required": true,
-			"example": 2
+			"description": "Numeric ID of the user",
+			"example": 1
 		}
 	],
 	"responses": {
@@ -24,13 +22,15 @@
 			"description": "200 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
-							"value": true
+							"value": {
+								"result": true
+							}
 						}
-					},
-					"schema": {
-						"type": "boolean"
 					}
 				}
 			}
@@ -39,21 +39,22 @@
 			"description": "400 response",
 			"content": {
 				"application/json": {
+					"schema": {
+						"$ref": "#/components/schemas/DeletedItemResponse"
+					},
 					"examples": {
 						"default": {
 							"value": {
+								"result": null,
 								"error": {
 									"code": 400,
-									"message": "Host is already enabled"
+									"message": "You cannot delete yourself!"
 								}
 							}
 						}
-					},
-					"schema": {
-						"$ref": "../../../../../components/error.json"
 					}
 				}
 			}
 		}
 	}
-}
+}