Revert "Cypress debugging"

This reverts commit 437b06b64b.

.dockerignore

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -6,20 +6,30 @@ labels: bug
 assignees: ''
 
 ---
-
-**Are you in the right place?**
+<!--
+ 
+Are you in the right place?
 - If you are looking for support on how to get your upstream server forwarding, please consider asking the community on Reddit.
 - If you are writing code changes to contribute and need to ask about the internals of the software, Gitter is the best place to ask.
 - If you think you found a bug with NPM (not Nginx, or your upstream server or MySql) then you are in the *right place.*
 
+-->
+
 **Checklist**
 - Have you pulled and found the error with `jc21/nginx-proxy-manager:latest` docker image?
+  - Yes / No
 - Are you sure you're not using someone else's docker image?
-- If having problems with Lets Encrypt, have you made absolutely sure your site is accessible from outside of your network?
+  - Yes / No
+- Have you searched for similar issues (both open and closed)?
+  - Yes / No
 
 **Describe the bug**
-- A clear and concise description of what the bug is.
-- What version of Nginx Proxy Manager is reported on the login page?
+<!-- A clear and concise description of what the bug is. -->
+
+
+**Nginx Proxy Manager Version**
+<!-- What version of Nginx Proxy Manager is reported on the login page? -->
+
 
 **To Reproduce**
 Steps to reproduce the behavior:
@@ -28,14 +38,18 @@ Steps to reproduce the behavior:
 3. Scroll down to '....'
 4. See error
 
+
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what you expected to happen. -->
+
 
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
+<!-- If applicable, add screenshots to help explain your problem. -->
+
 
 **Operating System**
-- Please specify if using a Rpi, Mac, orchestration tool or any other setups that might affect the reproduction of this error.
+<!-- Please specify if using a Rpi, Mac, orchestration tool or any other setups that might affect the reproduction of this error. -->
+
 
 **Additional context**
-Add any other context about the problem here, docker version, browser version if applicable to the problem. Too much info is better than too little.
+<!-- Add any other context about the problem here, docker version, browser version, logs if applicable to the problem. Too much info is better than too little. -->

.github/ISSUE_TEMPLATE/dns_challenge_request.md

@@ -0,0 +1,18 @@
+---
+name: DNS challenge provider request
+about: Suggest a new provider to be available for a certificate DNS challenge
+title: ''
+labels: dns provider request
+assignees: ''
+
+---
+
+**What provider would you like to see added to NPM?**
+<!-- What is this provider called? -->
+
+
+**Have you checked if a certbot plugin exists?**
+<!-- 
+Currently NPM only supports DNS challenge providers for which a certbot plugin exists. 
+You can visit pypi.org, and search for a package with the name `certbot-dns-<privider>`.
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,19 +7,26 @@ assignees: ''
 
 ---
 
-**Are you in the right place?**
+<!--
+
+Are you in the right place?
 - If you are looking for support on how to get your upstream server forwarding, please consider asking the community on Reddit.
 - If you are writing code changes to contribute and need to ask about the internals of the software, Gitter is the best place to ask.
-- If you have a feature request for NPM then you are in the *right place.*
+- If you think you found a bug with NPM (not Nginx, or your upstream server or MySql) then you are in the *right place.*
+
+-->
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
 
 **Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+<!-- A clear and concise description of what you want to happen. -->
+
 
 **Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Add any other context or screenshots about the feature request here. -->

.gitignore

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

.version

@@ -1 +1 @@
-2.8.1
+3.0.0a

DEV-README.md

@@ -0,0 +1,93 @@
+# Development
+
+```bash
+git clone nginxproxymanager
+cd nginxproxymanager
+./scripts/start-dev
+# wait a minute or 2 for the package to build after container start
+curl http://127.0.0.1:3081/api/
+```
+
+## Using Local Test Certificate Authorities
+
+It's handy to use these instead of hitting production or staging acme servers
+when testing lots of stuff.
+
+Firstly create your first user using the api:
+
+```bash
+curl --request POST \
+  --url http://127.0.0.1:3081/api/users \
+  --header 'Content-Type: application/json' \
+  --data '{
+    "name": "Bobby Tables",
+    "nickname": "Bobby",
+    "email": "you@example.com",
+    "roles": ["admin"],
+    "is_disabled": false,
+    "auth": {
+      "type": "password",
+      "secret": "changeme"
+    }
+}'
+```
+
+Then login in with those credentials to get your JWT token and set
+that as an environment variable:
+
+```bash
+NPM_TOKEN=$(curl --request POST \
+  --url http://127.0.0.1:3081/api/tokens \
+  --header 'Content-Type: application/json' \
+  --data '{
+    "type": "password",
+    "identity": "you@example.com",
+    "secret": "changeme"
+}' | jq -r '.result.token')
+```
+
+Then choose one or both of the following CA's to set up.
+
+### SmallStep Acme CA
+
+[StepCA](https://github.com/smallstep/certificates) is SmallSteps's test CA server.
+
+- ✅ HTTP Validation
+- ✅ DNS Validation
+
+Create a Certificate Authority that points to the Step CA:
+
+```bash
+curl --request POST \
+  --url http://127.0.0.1:3081/api/certificate-authorities \
+  --header "Authorization: Bearer ${NPM_TOKEN}" \
+  --header 'Content-Type: application/json' \
+  --data '{
+    "name": "Step CA",
+    "acmesh_server": "https://ca.internal/acme/acme/directory",
+    "ca_bundle": "/etc/ssl/certs/NginxProxyManager.crt",
+    "max_domains": 2
+}'
+```
+
+### Pebble Test Acme CA
+
+[Pebble](https://github.com/letsencrypt/pebble) is Let's Encrypt's own test CA server.
+
+- ✅ HTTP Validation
+- ❌ DNS Validation
+
+Create a Certificate Authority that points to the Pebble CA:
+
+```bash
+curl --request POST \
+  --url http://127.0.0.1:3081/api/certificate-authorities \
+  --header "Authorization: Bearer ${NPM_TOKEN}" \
+  --header 'Content-Type: application/json' \
+  --data '{
+    "name": "Pebble CA",
+    "acmesh_server": "https://pebble/dir",
+    "ca_bundle": "/etc/ssl/certs/pebble.minica.pem",
+    "max_domains": 2
+}'
+```

Jenkinsfile

@@ -8,14 +8,18 @@ pipeline {
 		ansiColor('xterm')
 	}
 	environment {
-		IMAGE                      = "nginx-proxy-manager"
+		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('/', '-')}"
 		COMPOSE_PROJECT_NAME       = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}"
 		COMPOSE_FILE               = 'docker/docker-compose.ci.yml'
 		COMPOSE_INTERACTIVE_NO_CLI = 1
 		BUILDX_NAME                = "${COMPOSE_PROJECT_NAME}"
+		DOCS_BUCKET                = 'jc21-npm-site-next' // TODO: change to prod when official
+		DOCS_CDN                   = 'E2Z0128EHS0Q23'     // TODO: same
 	}
 	stages {
 		stage('Environment') {
@@ -26,7 +30,9 @@ pipeline {
 					}
 					steps {
 						script {
-							env.BUILDX_PUSH_TAGS = "-t docker.io/jc21/${IMAGE}:${BUILD_VERSION} -t docker.io/jc21/${IMAGE}:${MAJOR_VERSION} -t docker.io/jc21/${IMAGE}:latest"
+							env.BUILDX_PUSH_TAGS = "-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'
 						}
 					}
 				}
@@ -39,99 +45,77 @@ pipeline {
 					steps {
 						script {
 							// Defaults to the Branch name, which is applies to all branches AND pr's
-							env.BUILDX_PUSH_TAGS = "-t docker.io/jc21/${IMAGE}:github-${BRANCH_LOWER}"
+							// env.BUILDX_PUSH_TAGS = "-t docker.io/jc21/${IMAGE}:github-${BRANCH_LOWER}"
+							env.BUILDX_PUSH_TAGS = "-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('Frontend') {
 			steps {
-				sh './scripts/frontend-build'
+				sh './scripts/ci/build-frontend'
 			}
+			/*
+			post {
+				always {
+					junit 'frontend/eslint.xml'
+					junit 'frontend/junit.xml'
+				}
+			}
+			*/
 		}
 		stage('Backend') {
 			steps {
-				echo 'Checking Syntax ...'
-				// See: https://github.com/yarnpkg/yarn/issues/3254
-				sh '''docker run --rm \\
-					-v "$(pwd)/backend:/app" \\
-					-v "$(pwd)/global:/app/global" \\
-					-w /app \\
-					node:latest \\
-					sh -c "yarn install && yarn eslint . && rm -rf node_modules"
-				'''
-
-				echo 'Docker Build ...'
-				sh '''docker build --pull --no-cache --squash --compress \\
-					-t "${IMAGE}:ci-${BUILD_NUMBER}" \\
-					-f docker/Dockerfile \\
-					--build-arg TARGETPLATFORM=linux/amd64 \\
-					--build-arg BUILDPLATFORM=linux/amd64 \\
-					--build-arg BUILD_VERSION="${BUILD_VERSION}" \\
-					--build-arg BUILD_COMMIT="${BUILD_COMMIT}" \\
-					--build-arg BUILD_DATE="$(date '+%Y-%m-%d %T %Z')" \\
-					.
-				'''
-			}
-		}
-		stage('Integration Tests Sqlite') {
-			steps {
-				// Bring up a stack
-				sh 'docker-compose up -d fullstack-sqlite'
-				sh './scripts/wait-healthy $(docker-compose ps -q fullstack-sqlite) 120'
-
-				// Run tests
-				sh 'rm -rf test/results'
-				sh 'docker-compose up cypress-sqlite'
-				// Get results
-				sh 'docker cp -L "$(docker-compose ps -q cypress-sqlite):/test/results" test/'
+				withCredentials([string(credentialsId: 'npm-sentry-dsn', variable: 'SENTRY_DSN')]) {
+					withCredentials([usernamePassword(credentialsId: 'oss-index-token', passwordVariable: 'NANCY_TOKEN', usernameVariable: 'NANCY_USER')]) {
+						sh './scripts/ci/test-backend'
+					}
+					sh './scripts/ci/build-backend'
+					sh '''docker build --pull --no-cache \\
+						-t "${IMAGE}:${BRANCH_LOWER}-ci-${BUILD_NUMBER}" \\
+						-f docker/Dockerfile \\
+						--build-arg BUILD_COMMIT="${BUILD_COMMIT}" \\
+						--build-arg BUILD_DATE="$(date '+%Y-%m-%d %T %Z')" \\
+						--build-arg BUILD_VERSION="${BUILD_VERSION}" \\
+						.
+					'''
+				}
 			}
 			post {
-				always {
-					// Dumps to analyze later
-					sh 'mkdir -p debug'
-					sh 'docker-compose logs fullstack-sqlite | gzip > debug/docker_fullstack_sqlite.log.gz'
-					sh 'docker-compose logs db | gzip > debug/docker_db.log.gz'
-					// Cypress videos and screenshot artifacts
-					dir(path: 'test/results') {
-						archiveArtifacts allowEmptyArchive: true, artifacts: '**/*', excludes: '**/*.xml'
-					}
-					junit 'test/results/junit/*'
+				success {
+					archiveArtifacts allowEmptyArchive: false, artifacts: 'bin/*'
 				}
 			}
 		}
-		stage('Integration Tests Mysql') {
+		stage('Test') {
+			when {
+				not {
+					equals expected: 'UNSTABLE', actual: currentBuild.result
+				}
+			}
 			steps {
-				// Bring up a stack
-				sh 'docker-compose up -d fullstack-mysql'
-				sh './scripts/wait-healthy $(docker-compose ps -q fullstack-mysql) 120'
-
-				// Run tests
-				sh 'rm -rf test/results'
-				sh 'docker-compose up cypress-mysql'
-				// Get results
-				sh 'docker cp -L "$(docker-compose ps -q cypress-mysql):/test/results" test/'
+				// Docker image check
+				/*
+				sh '''docker run --rm \
+					-v /var/run/docker.sock:/var/run/docker.sock \
+					-v "$(pwd)/docker:/app" \
+					-e CI=true \
+					wagoodman/dive:latest --ci-config /app/.dive-ci \
+					"${IMAGE}:${BRANCH_LOWER}-ci-${BUILD_NUMBER}"
+				'''
+				*/
+				sh './scripts/ci/fulltest-cypress'
 			}
 			post {
 				always {
 					// Dumps to analyze later
 					sh 'mkdir -p debug'
-					sh 'docker-compose logs fullstack-mysql | gzip > debug/docker_fullstack_mysql.log.gz'
-					sh 'docker-compose logs db | gzip > debug/docker_db.log.gz'
-					// Cypress videos and screenshot artifacts
-					dir(path: 'test/results') {
-						archiveArtifacts allowEmptyArchive: true, artifacts: '**/*', excludes: '**/*.xml'
-					}
+					sh 'docker-compose logs fullstack > debug/docker_fullstack.log'
+					sh 'docker-compose logs stepca > debug/docker_stepca.log'
+					sh 'docker-compose logs pdns > debug/docker_pdns.log'
+					sh 'docker-compose logs pdns-db > debug/docker_pdns-db.log'
+					sh 'docker-compose logs dnsrouter > debug/docker_dnsrouter.log'
 					junit 'test/results/junit/*'
 				}
 			}
@@ -148,11 +132,14 @@ pipeline {
 					sh 'yarn build'
 				}
 
+				// API Docs:
+				sh 'docker-compose exec -T fullstack curl -s --output /temp-docs/api-schema.json "http://fullstack:81/api/schema"'
+				sh 'mkdir -p "docs/.vuepress/dist/api"'
+				sh 'mv docs/api-schema.json docs/.vuepress/dist/api/'
+
 				dir(path: 'docs/.vuepress/dist') {
 					sh 'tar -czf ../../docs.tgz *'
 				}
-
-				archiveArtifacts(artifacts: 'docs/docs.tgz', allowEmptyArchive: false)
 			}
 		}
 		stage('MultiArch Build') {
@@ -162,18 +149,19 @@ pipeline {
 				}
 			}
 			steps {
-				withCredentials([usernamePassword(credentialsId: 'jc21-dockerhub', passwordVariable: 'dpass', usernameVariable: 'duser')]) {
-					// Docker Login
-					sh "docker login -u '${duser}' -p '${dpass}'"
-					// Buildx with push from cache
-					sh "./scripts/buildx --push ${BUILDX_PUSH_TAGS}"
+				withCredentials([string(credentialsId: 'npm-sentry-dsn', variable: 'SENTRY_DSN')]) {
+					withCredentials([usernamePassword(credentialsId: 'jc21-dockerhub', passwordVariable: 'dpass', usernameVariable: 'duser')]) {
+						sh 'docker login -u "${duser}" -p "${dpass}"'
+						sh './scripts/buildx --push ${BUILDX_PUSH_TAGS}'
+						// sh './scripts/buildx -o type=local,dest=docker-build'
+					}
 				}
 			}
 		}
 		stage('Docs Deploy') {
 			when {
 				allOf {
-					branch 'master'
+					branch 'v3' // TOODO: change to master when ready
 					not {
 						equals expected: 'UNSTABLE', actual: currentBuild.result
 					}
@@ -183,7 +171,7 @@ pipeline {
 				withCredentials([[$class: 'AmazonWebServicesCredentialsBinding', accessKeyVariable: 'AWS_ACCESS_KEY_ID', credentialsId: 'npm-s3-docs', secretKeyVariable: 'AWS_SECRET_ACCESS_KEY']]) {
 					sh """docker run --rm \\
 						--name \${COMPOSE_PROJECT_NAME}-docs-upload \\
-						-e S3_BUCKET=jc21-npm-site \\
+						-e S3_BUCKET=$DOCS_BUCKET \\
 						-e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \\
 						-e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \\
 						-v \$(pwd):/app \\
@@ -197,7 +185,7 @@ pipeline {
 						-e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \\
 						-e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \\
 						jc21/ci-tools \\
-						aws cloudfront create-invalidation --distribution-id EN1G6DEWZUTDT --paths '/*'
+						aws cloudfront create-invalidation --distribution-id $DOCS_CDN --paths '/*'
 					"""
 				}
 			}
@@ -213,27 +201,34 @@ pipeline {
 			}
 			steps {
 				script {
-					def comment = pullRequest.comment("Docker Image for build ${BUILD_NUMBER} is available on [DockerHub](https://cloud.docker.com/repository/docker/jc21/${IMAGE}) as `jc21/${IMAGE}:github-${BRANCH_LOWER}`")
+					def comment = pullRequest.comment("This is an automated message from CI:\n\nDocker Image for build ${BUILD_NUMBER} is available on [DockerHub](https://cloud.docker.com/repository/docker/${DOCKER_ORG}/${IMAGE}) as `${DOCKER_ORG}/${IMAGE}:github-${BRANCH_LOWER}`\n\n**Note:** ensure you backup your NPM instance before testing this PR image! Especially if this PR contains database changes.")
 				}
 			}
 		}
 	}
 	post {
 		always {
-			sh 'docker-compose down --rmi all --remove-orphans --volumes -t 30'
-			sh 'echo Reverting ownership'
-			sh 'docker run --rm -v $(pwd):/data jc21/ci-tools chown -R $(id -u):$(id -g) /data'
+			sh 'docker-compose down --rmi all --remove-orphans --volumes -t 30 || true'
+			sh './scripts/ci/build-cleanup'
+			echo 'Reverting ownership'
+			sh 'docker run --rm -v $(pwd):/data jc21/gotools:latest chown -R "$(id -u):$(id -g)" /data'
 		}
 		success {
 			juxtapose event: 'success'
 			sh 'figlet "SUCCESS"'
 		}
 		failure {
+			dir(path: 'test') {
+				archiveArtifacts allowEmptyArchive: true, artifacts: 'results/**/*', excludes: '**/*.xml'
+			}
 			archiveArtifacts(artifacts: 'debug/**.*', allowEmptyArchive: true)
 			juxtapose event: 'failure'
 			sh 'figlet "FAILURE"'
 		}
 		unstable {
+			dir(path: 'test') {
+				archiveArtifacts allowEmptyArchive: true, artifacts: 'results/**/*', excludes: '**/*.xml'
+			}
 			archiveArtifacts(artifacts: 'debug/**.*', allowEmptyArchive: true)
 			juxtapose event: 'unstable'
 			sh 'figlet "UNSTABLE"'

README.md

@@ -1,25 +1,19 @@
 <p align="center">
 	<img src="https://nginxproxymanager.com/github.png">
 	<br><br>
-	<img src="https://img.shields.io/badge/version-2.8.1-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>
 	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
 		<img src="https://img.shields.io/docker/pulls/jc21/nginx-proxy-manager.svg?style=for-the-badge">
 	</a>
-	<a href="https://ci.nginxproxymanager.com/blue/organizations/jenkins/nginx-proxy-manager/branches/">
-		<img src="https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.nginxproxymanager.com%2Fjob%2Fnginx-proxy-manager%2Fjob%2Fmaster&style=for-the-badge">
-	</a>
-	<a href="https://gitter.im/nginx-proxy-manager/community">
-		<img alt="Gitter" src="https://img.shields.io/gitter/room/nginx-proxy-manager/community?style=for-the-badge">
-	</a>
 </p>
 
 This project comes as a pre-built docker image that enables you to easily forward to your websites
 running at home or otherwise, including free SSL, without having to know too much about Nginx or Letsencrypt.
 
-- [Quick Setup](https://nginxproxymanager.com#quick-setup)
+- [Quick Setup](#quick-setup)
 - [Full Setup](https://nginxproxymanager.com/setup/)
 - [Screenshots](https://nginxproxymanager.com/screenshots/)
 
@@ -35,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
@@ -53,209 +47,55 @@ I won't go in to too much detail here but here are the basics for someone new to
 4. Use the Nginx Proxy Manager as your gateway to forward to your other web based services
 
 
+## Quickest Setup
+
+1. Install Docker and Docker-Compose
+
+- [Docker Install documentation](https://docs.docker.com/install/)
+- [Docker-Compose Install documentation](https://docs.docker.com/compose/install/)
+
+2. Create a docker-compose.yml file similar to this:
+
+```yml
+version: '3'
+services:
+  app:
+    image: 'jc21/nginx-proxy-manager:v3'
+    restart: unless-stopped
+    ports:
+      - '80:80'
+      - '81:81'
+      - '443:443'
+    volumes:
+      - ./data:/data
+```
+
+3. Bring up your stack by running
+
+```bash
+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.
+
+[http://127.0.0.1:81](http://127.0.0.1:81)
+
 ## Contributors
 
-Special thanks to the following contributors:
+Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors).
 
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-	<tr>
-		<td align="center">
-			<a href="https://github.com/Subv">
-				<img src="https://avatars1.githubusercontent.com/u/357072?s=460&u=d8adcdc91d749ae53e177973ed9b6bb6c4c894a3&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Sebastian Valle</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/Indemnity83">
-				<img src="https://avatars3.githubusercontent.com/u/35218?s=460&u=7082004ff35138157c868d7d9c683ccebfce5968&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Kyle Klaus</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/theraw">
-				<img src="https://avatars1.githubusercontent.com/u/32969774?s=460&u=6b359971e15685fb0359e6a8c065a399b40dc228&v=4" width="80px;" alt=""/>
-				<br /><sub><b>ƬHE ЯAW</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/spalger">
-				<img src="https://avatars2.githubusercontent.com/u/1329312?s=400&u=565223e38f1c052afb4c5dcca3fcf1c63ba17ae7&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Spencer</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/Xantios">
-				<img src="https://avatars3.githubusercontent.com/u/1507836?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Xantios Krugor</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/dpanesso">
-				<img src="https://avatars2.githubusercontent.com/u/2687121?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>David Panesso</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/IronTooch">
-				<img src="https://avatars3.githubusercontent.com/u/27360514?s=460&u=69bf854a6647c55725f62ecb8d39249c6c0b2602&v=4" width="80px;" alt=""/>
-				<br /><sub><b>IronTooch</b></sub>
-			</a>
-		</td>
-	</tr>
-	<tr>
-		<td align="center">
-			<a href="https://github.com/damianog">
-				<img src="https://avatars1.githubusercontent.com/u/2786682?s=460&u=76c6136fae797abb76b951cd8a246dcaecaf21af&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Damiano</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/tfmm">
-				<img src="https://avatars3.githubusercontent.com/u/6880538?s=460&u=ce0160821cc4aa802df8395200f2d4956a5bc541&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Russ</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/margaale">
-				<img src="https://avatars3.githubusercontent.com/u/20794934?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Marcelo Castagna</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/Steven-Harris">
-				<img src="https://avatars2.githubusercontent.com/u/7720242?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Steven Harris</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/jlesage">
-				<img src="https://avatars0.githubusercontent.com/u/1791123?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Jocelyn Le Sage</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/cmer">
-				<img src="https://avatars0.githubusercontent.com/u/412?s=460&u=67dd8b2e3661bfd6f68ec1eaa5b9821bd8a321cd&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Carl Mercier</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/the1ts">
-				<img src="https://avatars1.githubusercontent.com/u/84956?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Paul Mansfield</b></sub>
-			</a>
-		</td>
-	</tr>
-	<tr>
-		<td align="center">
-			<a href="https://github.com/OhHeyAlan">
-				<img src="https://avatars0.githubusercontent.com/u/11955126?s=460&u=fbaa5a1a4f73ef8960132c703349bfd037fe2630&v=4" width="80px;" alt=""/>
-				<br /><sub><b>OhHeyAlan</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/dogmatic69">
-				<img src="https://avatars2.githubusercontent.com/u/94674?s=460&u=ca7647de53145c6283b6373ade5dc94ba99347db&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Carl Sutton</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/tg44">
-				<img src="https://avatars0.githubusercontent.com/u/31839?s=460&u=ad32f4cadfef5e5fb09cdfa4b7b7b36a99ba6811&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Gergő Törcsvári</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/vrenjith">
-				<img src="https://avatars3.githubusercontent.com/u/2093241?s=460&u=96ce93a9bebabdd0a60a2dc96cd093a41d5edaba&v=4" width="80px;" alt=""/>
-				<br /><sub><b>vrenjith</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/duhruh">
-				<img src="https://avatars2.githubusercontent.com/u/1133969?s=460&u=c0691e6131ec6d516416c1c6fcedb5034f877bbe&v=4" width="80px;" alt=""/>
-				<br /><sub><b>David Rivera</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/jipjan">
-				<img src="https://avatars2.githubusercontent.com/u/1384618?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Jaap-Jan de Wit</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/jmwebslave">
-				<img src="https://avatars2.githubusercontent.com/u/6118262?s=460&u=7db409c47135b1e141c366bbb03ed9fae6ac2638&v=4" width="80px;" alt=""/>
-				<br /><sub><b>James Morgan</b></sub>
-			</a>
-		</td>
-	</tr>
-	<tr>
-		<td align="center">
-			<a href="https://github.com/chaptergy">
-				<img src="https://avatars2.githubusercontent.com/u/26956711?s=460&u=7d9adebabb6b4e7af7cb05d98d751087a372304b&v=4" width="80px;" alt=""/>
-				<br /><sub><b>chaptergy</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/Philip-Mooney">
-				<img src="https://avatars0.githubusercontent.com/u/48624631?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Philip Mooney</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/WaterCalm">
-				<img src="https://avatars1.githubusercontent.com/u/23502129?s=400&v=4" width="80px;" alt=""/>
-				<br /><sub><b>WaterCalm</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/lebrou34">
-				<img src="https://avatars1.githubusercontent.com/u/16373103?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>lebrou34</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/lightglitch">
-				<img src="https://avatars0.githubusercontent.com/u/196953?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Mário Franco</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/klutchell">
-				<img src="https://avatars3.githubusercontent.com/u/20458272?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Kyle Harding</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/ahgraber">
-				<img src="https://avatars.githubusercontent.com/u/24922003?s=460&u=8376c9f00af9b6057ba4d2fb03b4f1b20a75277f&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Alex Graber</b></sub>
-			</a>
-		</td>
-	</tr>
-	<tr>
-		<td align="center">
-			<a href="https://github.com/MooBaloo">
-				<img src="https://avatars.githubusercontent.com/u/9493496?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>MooBaloo</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/Shuro">
-				<img src="https://avatars.githubusercontent.com/u/944030?s=460&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Shuro</b></sub>
-			</a>
-		</td>
-		<td align="center">
-			<a href="https://github.com/lorisbergeron">
-				<img src="https://avatars.githubusercontent.com/u/51918567?s=460&u=778e4ff284b7d7304450f98421c99f79298371fb&v=4" width="80px;" alt=""/>
-				<br /><sub><b>Loris Bergeron</b></sub>
-			</a>
-		</td>
-	</tr>
-</table>
-<!-- markdownlint-enable -->
-<!-- prettier-ignore-end -->
+## 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. [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,56 @@
+linters:
+    enable:
+        - bodyclose
+        - errcheck
+        - gosimple
+        - govet
+        - gosec
+        - goconst
+        - gocritic
+        - gocyclo
+        - gofmt
+        - goimports
+        - ineffassign
+        - misspell
+        - nakedret
+        - prealloc
+        #- revive
+        - staticcheck
+        - typecheck
+        - unused
+        - unconvert
+        - unparam
+linters-settings:
+    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/.nancy-ignore

@@ -0,0 +1,41 @@
+# If you need to ignore any of nancy's warnings add them
+
+# here with a reference to the package/version that
+
+# triggers them and rational for ignoring it.
+
+# pkg:golang/github.com/coreos/etcd@3.3.10
+
+# etcd before versions 3.3.23 and 3.4.10 does not perform any password length validation
+
+CVE-2020-15115
+
+# pkg:golang/github.com/coreos/etcd@3.3.10
+
+# In ectd before versions 3.4.10 and 3.3.23, gateway TLS authentication is only applied to endpoints detected in DNS SRV records
+
+CVE-2020-15136
+
+# pkg:golang/github.com/coreos/etcd@3.3.10
+
+# In etcd before versions 3.3.23 and 3.4.10, the etcd gateway is a simple TCP proxy to allow for basic service discovery and access
+
+CVE-2020-15114
+
+# pkg:golang/github.com/gorilla/websocket@1.4.0
+
+# Integer Overflow or Wraparound
+
+CWE-190
+
+# jwt-go before 4.0.0-preview1 allows attackers to bypass intended access restrict...
+
+CVE-2020-26160
+
+# https://ossindex.sonatype.org/vulnerability/sonatype-2021-1485
+
+sonatype-2021-1485
+
+# CWE-770: Allocation of Resources Without Limits or Throttling
+
+CVE-2022-41717

backend/.vscode/settings.json

@@ -1,8 +0,0 @@
-{
-	"editor.insertSpaces": false,
-	"editor.formatOnSave": true,
-	"files.trimTrailingWhitespace": true,
-	"editor.codeActionsOnSave": {
-		"source.fixAll.eslint": true
-	}
-}

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,69 @@
+version: "2"
+
+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
+            - 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 -ldflags="-X main.commit={{.GIT_COMMIT}} -X main.version={{.VERSION}}" -o ../dist/bin/server ./cmd/server/main.go
+              silent: true
+            - task: lint
+        vars:
+            GIT_COMMIT:
+                sh: git log -n 1 --format=%h
+            VERSION:
+                sh: cat ../.version
+        env:
+            GO111MODULE: on
+            CGO_ENABLED: 1
+
+    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 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 (process.env.NODE_ENV !== 'production') {
-	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({
-		'Strict-Transport-Security': 'includeSubDomains; max-age=631138519; preload',
-		'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/api/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 (process.env.NODE_ENV === 'development' || (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 (process.env.NODE_ENV === 'development') {
-			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/server/main.go

@@ -0,0 +1,54 @@
+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/setting"
+	"npm/internal/jobqueue"
+	"npm/internal/logger"
+)
+
+var commit string
+var version string
+var sentryDSN string
+
+func main() {
+	config.InitArgs(&version, &commit)
+	config.Init(&version, &commit, &sentryDSN)
+
+	database.Migrate(func() {
+		setting.ApplySettings()
+		database.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
+				err := database.GetInstance().Close()
+				if err != nil {
+					logger.Error("DatabaseCloseError", err)
+				}
+				// nolint
+				jobqueue.Shutdown()
+				break
+			}
+		}
+	})
+}

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": "mysql",
-    "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,33 +0,0 @@
-const config = require('config');
-
-if (!config.has('database')) {
-	throw new Error('Database config does not exist! Please read the instructions: https://github.com/jc21/nginx-proxy-manager/blob/master/doc/INSTALL.md');
-}
-
-function generateDbConfig() {
-	if (config.database.engine === 'knex-native') {
-		return config.database.knex;
-	} else
-		return {
-			client:     config.database.engine,
-			connection: {
-				host:     config.database.host,
-				user:     config.database.user,
-				password: config.database.password,
-				database: config.database.name,
-				port:     config.database.port
-			},
-			migrations: {
-				tableName: 'migrations'
-			}
-		};
-}
-
-
-let data = generateDbConfig();
-
-if (typeof config.database.version !== 'undefined') {
-	data.version = config.database.version;
-}
-
-module.exports = require('knex')(data);

backend/embed/api_docs/api.swagger.json

@@ -0,0 +1,297 @@
+{
+	"openapi": "3.0.0",
+	"info": {
+		"title": "Nginx Proxy Manager API",
+		"version": "{{VERSION}}"
+	},
+	"paths": {
+		"/": {
+			"get": {
+				"$ref": "file://./paths/get.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"
+			}
+		},
+		"/tokens": {
+			"get": {
+				"$ref": "file://./paths/tokens/get.json"
+			},
+			"post": {
+				"$ref": "file://./paths/tokens/post.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": {
+			"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/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,55 @@
+{
+	"type": "object",
+	"description": "CertificateAuthorityObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_on",
+		"modified_on",
+		"name",
+		"acmesh_server",
+		"ca_bundle",
+		"max_domains",
+		"is_wildcard_supported",
+		"is_readonly"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"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,85 @@
+{
+	"type": "object",
+	"description": "CertificateObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_on",
+		"modified_on",
+		"expires_on",
+		"type",
+		"user_id",
+		"certificate_authority_id",
+		"dns_provider_id",
+		"name",
+		"is_ecc",
+		"status",
+		"domain_names"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"expires_on": {
+			"type": "integer",
+			"minimum": 1,
+			"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
+		},
+		"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": "integer",
+			"minimum": 0,
+			"maximum": 1
+		},
+		"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,49 @@
+{
+	"type": "object",
+	"description": "DNSProviderObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_on",
+		"modified_on",
+		"user_id",
+		"name",
+		"acmesh_name",
+		"dns_sleep",
+		"meta"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"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,41 @@
+{
+	"type": "object",
+	"description": "HealthObject",
+	"additionalProperties": false,
+	"required": ["version", "commit", "healthy", "setup", "error_reporting"],
+	"properties": {
+		"version": {
+			"type": "string",
+			"description": "Version",
+			"example": "3.0.0",
+			"minLength": 1
+		},
+		"commit": {
+			"type": "string",
+			"description": "Commit hash",
+			"example": "946b88f",
+			"minLength": 7
+		},
+		"healthy": {
+			"type": "boolean",
+			"description": "Healthy?",
+			"example": true
+		},
+		"setup": {
+			"type": "boolean",
+			"description": "Is the application set up?",
+			"example": true
+		},
+		"error_reporting": {
+			"type": "boolean",
+			"description": "Will the application send any error reporting?",
+			"example": true
+		},
+		"acme.sh": {
+			"type": "string",
+			"description": "Acme.sh version",
+			"example": "v3.0.0",
+			"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,58 @@
+{
+	"type": "object",
+	"description": "HostObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_on",
+		"modified_on",
+		"expires_on",
+		"user_id",
+		"provider",
+		"name",
+		"domain_names"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"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
+			}
+		},
+		"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,44 @@
+{
+	"type": "object",
+	"description": "NginxTemplateObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_on",
+		"modified_on",
+		"user_id",
+		"name",
+		"type",
+		"template"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"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,49 @@
+{
+	"type": "object",
+	"description": "SettingObject",
+	"additionalProperties": false,
+	"required": ["id", "name", "value"],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"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,55 @@
+{
+	"type": "object",
+	"description": "StreamObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_on",
+		"modified_on",
+		"expires_on",
+		"user_id",
+		"provider",
+		"name",
+		"domain_names"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"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,19 @@
+{
+	"type": "object",
+	"description": "TokenObject",
+	"additionalProperties": false,
+	"required": ["expires", "token"],
+	"properties": {
+		"expires": {
+			"type": "number",
+			"description": "Token Expiry Unix Time",
+			"example": 1566540249,
+			"minimum": 1
+		},
+		"token": {
+			"type": "string",
+			"description": "JWT Token",
+			"example": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.ey...xaHKYr3Kk6MvkUjcC4"
+		}
+	}
+}

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,136 @@
+{
+	"type": "object",
+	"description": "UpstreamObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"created_on",
+		"modified_on",
+		"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_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"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_on",
+					"modified_on",
+					"upstream_id",
+					"server",
+					"weight",
+					"max_conns",
+					"max_fails",
+					"fail_timeout",
+					"backup"
+				],
+				"properties": {
+					"id": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"created_on": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"modified_on": {
+						"type": "integer",
+						"minimum": 1
+					},
+					"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,28 @@
+{
+	"type": "object",
+	"description": "UserAuthObject",
+	"additionalProperties": false,
+	"required": ["id", "user_id", "type", "created_on", "modified_on"],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"user_id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"type": {
+			"type": "string",
+			"pattern": "^password$"
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		}
+	}
+}

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,73 @@
+{
+	"type": "object",
+	"description": "UserObject",
+	"additionalProperties": false,
+	"required": [
+		"id",
+		"name",
+		"nickname",
+		"email",
+		"created_on",
+		"modified_on",
+		"is_disabled"
+	],
+	"properties": {
+		"id": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"name": {
+			"type": "string",
+			"minLength": 2,
+			"maxLength": 100
+		},
+		"nickname": {
+			"type": "string",
+			"minLength": 2,
+			"maxLength": 100
+		},
+		"email": {
+			"type": "string",
+			"minLength": 5,
+			"maxLength": 150
+		},
+		"created_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"modified_on": {
+			"type": "integer",
+			"minimum": 1
+		},
+		"gravatar_url": {
+			"type": "string"
+		},
+		"is_disabled": {
+			"type": "boolean"
+		},
+		"is_deleted": {
+			"type": "boolean"
+		},
+		"auth": {
+			"type": "object",
+			"required": ["type"],
+			"properties": {
+				"id": {
+					"type": "integer"
+				},
+				"type": {
+					"type": "string",
+					"pattern": "^password$"
+				}
+			}
+		},
+		"capabilities": {
+			"type": "array",
+			"minItems": 1,
+			"items": {
+				"type": "string",
+				"minLength": 1
+			}
+		}
+	}
+}

backend/embed/api_docs/main.go

@@ -0,0 +1,10 @@
+package doc
+
+import "embed"
+
+// SwaggerFiles contain all the files used for swagger schema generation
+//
+//go:embed api.swagger.json
+//go:embed components
+//go:embed paths
+var SwaggerFiles embed.FS

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,52 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateAuthorityObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1627531400,
+									"modified_on": 1627531400,
+									"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,61 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateAuthorityObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1627531400,
+									"modified_on": 1627531400,
+									"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,92 @@
+{
+	"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": {
+						"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_on": 1627531400,
+											"modified_on": 1627531400,
+											"name": "ZeroSSL",
+											"acmesh_server": "zerossl",
+											"ca_bundle": "",
+											"max_domains": 10,
+											"is_wildcard_supported": true,
+											"is_setup": true
+										},
+										{
+											"id": 2,
+											"created_on": 1627531400,
+											"modified_on": 1627531400,
+											"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,48 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateAuthorityObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1627531400,
+									"modified_on": 1627531400,
+									"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,61 @@
+{
+	"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": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1604536109,
+									"modified_on": 1604536109,
+									"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,70 @@
+{
+	"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": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1604536109,
+									"modified_on": 1604536109,
+									"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,90 @@
+{
+	"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": {
+						"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_on": 1604536109,
+											"modified_on": 1604536109,
+											"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,57 @@
+{
+	"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": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/CertificateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1604536109,
+									"modified_on": 1604536109,
+									"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,36 @@
+{
+	"operationId": "config",
+	"summary": "Returns the API Service configuration",
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"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,82 @@
+{
+	"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": {
+						"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_on": 1602593653,
+											"modified_on": 1602593653,
+											"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,49 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/DNSProviderObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1602593653,
+									"modified_on": 1602593653,
+									"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,53 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/DNSProviderObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1602593653,
+									"modified_on": 1602593653,
+									"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,64 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/DNSProviderObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"result": {
+										"id": 1,
+										"created_on": 1602593653,
+										"modified_on": 1602593653,
+										"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,47 @@
+{
+	"operationId": "health",
+	"summary": "Returns the API health status",
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HealthObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"version": "3.0.0",
+									"commit": "9f119b6",
+									"healthy": true,
+									"setup": true,
+									"error_reporting": true
+								}
+							}
+						},
+						"unhealthy": {
+							"value": {
+								"result": {
+									"version": "3.0.0",
+									"commit": "9f119b6",
+									"healthy": false,
+									"setup": true,
+									"error_reporting": true
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,93 @@
+{
+	"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": {
+						"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_on": 1646279455,
+											"modified_on": 1646279455,
+											"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

@@ -0,0 +1,60 @@
+{
+	"operationId": "deleteHost",
+	"summary": "Delete a Host",
+	"tags": [
+		"Hosts"
+	],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "hostID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "Numeric ID of the Host",
+			"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 host that is in use!"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,64 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HostObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1646279455,
+									"modified_on": 1646279455,
+									"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,42 @@
+{
+	"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": {
+						"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,73 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HostObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1646279455,
+									"modified_on": 1646279455,
+									"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,60 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/HostObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1645700556,
+									"modified_on": 1645700556,
+									"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,79 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 1,
+									"offset": 0,
+									"limit": 10,
+									"sort": [
+										{
+											"field": "created_on",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"created_on": 1646218093,
+											"modified_on": 1646218093,
+											"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,46 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 10,
+									"created_on": 1646218093,
+									"modified_on": 1646218093,
+									"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

@@ -0,0 +1,58 @@
+{
+	"operationId": "deleteNginxTemplate",
+	"summary": "Delete a Nginx Template",
+	"tags": ["Nginx Templates"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "templateID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "Numeric ID of the Template",
+			"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 template that is in use!"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,50 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1646218093,
+									"modified_on": 1646218093,
+									"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,59 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/NginxTemplateObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1646218093,
+									"modified_on": 1646218093,
+									"user_id": 1,
+									"name": "My renamed proxy template",
+									"type": "proxy",
+									"template": "# this is a proxy template"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,9 @@
+{
+	"operationId": "schema",
+	"summary": "Returns this swagger API schema",
+	"responses": {
+		"200": {
+			"description": "200 response"
+		}
+	}
+}

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

@@ -0,0 +1,84 @@
+{
+	"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": {
+						"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_on": 1578010090,
+											"modified_on": 1578010095,
+											"name": "default-site",
+											"value": {
+												"html": "<p>not found</p>",
+												"type": "custom"
+											}
+										}
+									]
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,55 @@
+{
+	"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": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/SettingObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 2,
+									"created_on": 1578010090,
+									"modified_on": 1578010095,
+									"name": "default-site",
+									"value": {
+										"html": "<p>not found</p>",
+										"type": "custom"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,64 @@
+{
+	"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": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/SettingObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 2,
+									"created_on": 1578010090,
+									"modified_on": 1578010090,
+									"name": "default-site",
+									"value": {
+										"html": "<p>not found</p>",
+										"type": "custom"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,51 @@
+{
+	"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": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/SettingObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 2,
+									"created_on": 1578010090,
+									"modified_on": 1578010090,
+									"name": "default-site",
+									"value": {
+										"html": "<p>not found</p>",
+										"type": "custom"
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,75 @@
+{
+	"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": {
+						"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,38 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": "TODO"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,60 @@
+{
+	"operationId": "deleteStream",
+	"summary": "Delete a Stream",
+	"tags": [
+		"Streams"
+	],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "streamID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "Numeric ID of the Stream",
+			"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 Stream that is in use!"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,46 @@
+{
+	"operationId": "getStream",
+	"summary": "Get a Stream object by ID",
+	"tags": [
+		"Streams"
+	],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "streamID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "ID of the Stream",
+			"example": 1
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": "TODO"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,55 @@
+{
+	"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": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": "TODO"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

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

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

@@ -0,0 +1,79 @@
+{
+	"operationId": "requestToken",
+	"summary": "Request a new access token from credentials",
+	"tags": [
+		"Tokens"
+	],
+	"requestBody": {
+		"description": "Credentials Payload",
+		"required": true,
+		"content": {
+			"application/json": {
+				"schema": "{{schema.GetToken}}"
+			}
+		}
+	},
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"required": [
+							"result"
+						],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/StreamObject"
+							}
+						}
+					},
+					"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": {
+								"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/upstreams/get.json

@@ -0,0 +1,285 @@
+{
+	"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": {
+						"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_on": 1672804124,
+											"modified_on": 1672804124,
+											"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_on": 1672804124,
+													"modified_on": 1672804124,
+													"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_on": 1672804124,
+													"modified_on": 1672804124,
+													"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_on": 1672804197,
+											"modified_on": 1672804197,
+											"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_on": 1672804197,
+													"modified_on": 1672804197,
+													"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_on": 1672804197,
+													"modified_on": 1672804197,
+													"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_on": 1672804200,
+											"modified_on": 1672804200,
+											"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_on": 1672804200,
+													"modified_on": 1672804200,
+													"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_on": 1672804200,
+													"modified_on": 1672804200,
+													"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_on": 1672804201,
+											"modified_on": 1672804201,
+											"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_on": 1672804201,
+													"modified_on": 1672804201,
+													"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_on": 1672804201,
+													"modified_on": 1672804201,
+													"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_on": 1672804201,
+											"modified_on": 1672804201,
+											"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_on": 1672804201,
+													"modified_on": 1672804201,
+													"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_on": 1672804201,
+													"modified_on": 1672804201,
+													"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,80 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UpstreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 6,
+									"created_on": 1672806857,
+									"modified_on": 1672806857,
+									"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_on": 1672806857,
+											"modified_on": 1672806857,
+											"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_on": 1672806857,
+											"modified_on": 1672806857,
+											"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

@@ -0,0 +1,58 @@
+{
+	"operationId": "deleteUpstream",
+	"summary": "Delete a Upstream",
+	"tags": ["Upstreams"],
+	"parameters": [
+		{
+			"in": "path",
+			"name": "upstreamID",
+			"schema": {
+				"type": "integer",
+				"minimum": 1
+			},
+			"required": true,
+			"description": "Numeric ID of the Upstream",
+			"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 Upstream that is in use!"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

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

@@ -0,0 +1,81 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UpstreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1672786008,
+									"modified_on": 1672786008,
+									"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_on": 1672786009,
+											"modified_on": 1672786009,
+											"upstream_id": 1,
+											"server": "api1.localhost:1234",
+											"weight": 100,
+											"max_conns": 0,
+											"max_fails": 0,
+											"fail_timeout": 0,
+											"backup": false
+										},
+										{
+											"id": 2,
+											"created_on": 1672786009,
+											"modified_on": 1672786009,
+											"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,42 @@
+{
+	"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": {
+						"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,93 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UpstreamObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"created_on": 1673234177,
+									"modified_on": 1673244559,
+									"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_on": 1673234177,
+											"modified_on": 1673244559,
+											"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_on": 1673234177,
+											"modified_on": 1673244559,
+											"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,117 @@
+{
+	"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,nickname.desc,email.asc"
+		}
+	],
+	"responses": {
+		"200": {
+			"description": "200 response",
+			"content": {
+				"application/json": {
+					"schema": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UserList"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"total": 3,
+									"offset": 0,
+									"limit": 100,
+									"sort": [
+										{
+											"field": "name",
+											"direction": "ASC"
+										},
+										{
+											"field": "nickname",
+											"direction": "DESC"
+										},
+										{
+											"field": "email",
+											"direction": "ASC"
+										}
+									],
+									"items": [
+										{
+											"id": 1,
+											"name": "Jamie Curnow",
+											"nickname": "James",
+											"email": "jc@jc21.com",
+											"created_on": 1578010090,
+											"modified_on": 1578010095,
+											"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",
+											"nickname": "John",
+											"email": "johdoe@example.com",
+											"created_on": 1578010100,
+											"modified_on": 1578010105,
+											"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",
+											"nickname": "Jane",
+											"email": "janedoe@example.com",
+											"created_on": 1578010110,
+											"modified_on": 1578010115,
+											"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,79 @@
+{
+	"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": {
+						"required": ["result"],
+						"properties": {
+							"result": {
+								"$ref": "#/components/schemas/UserObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"result": {
+									"id": 1,
+									"name": "Jamie Curnow",
+									"nickname": "James",
+									"email": "jc@jc21.com",
+									"created_on": 1578010100,
+									"modified_on": 1578010100,
+									"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": {
+						"required": ["error"],
+						"properties": {
+							"result": {
+								"nullable": true
+							},
+							"error": {
+								"$ref": "#/components/schemas/ErrorObject"
+							}
+						}
+					},
+					"examples": {
+						"default": {
+							"value": {
+								"error": {
+									"code": 400,
+									"message": "An user already exists with this email address"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}