mirror of
https://github.com/NginxProxyManager/nginx-proxy-manager.git
synced 2025-12-06 08:16:51 +00:00
Compare commits
216 Commits
5d6916dcf0
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
847c58b170 | ||
|
|
89b8b747e1 | ||
|
|
3231023513 | ||
|
|
dc89635971 | ||
|
|
cfa98361d1 | ||
|
|
c2177abe39 | ||
|
|
2c6d614597 | ||
|
|
484ce8db3c | ||
|
|
2c11c0c7e2 | ||
|
|
f1039ce2ef | ||
|
|
d49ff6e7c2 | ||
|
|
a87f24c9dc | ||
|
|
decdfec447 | ||
|
|
32ab3faf57 | ||
|
|
c7f999fa7a | ||
|
|
de7d3b0d19 | ||
|
|
2d4b7399c0 | ||
|
|
316b758455 | ||
|
|
890d06c863 | ||
|
|
81f2aa17d4 | ||
|
|
9b4c34915c | ||
|
|
fce569ca21 | ||
|
|
87ec9c4bdf | ||
|
|
2650648d68 | ||
|
|
fdc0c29f28 | ||
|
|
6cae088432 | ||
|
|
9d8c4cc30b | ||
|
|
66ebecdb43 | ||
|
|
60f3ee03c0 | ||
|
|
a4d54a0291 | ||
|
|
7536b1b1c9 | ||
|
|
5288fbd7af | ||
|
|
2c630bbdca | ||
|
|
0ec1a09c30 | ||
|
|
118c4793e3 | ||
|
|
d7384c568f | ||
|
|
0bcfe0bba6 | ||
|
|
74cbfb2c58 | ||
|
|
8ef65caa5a | ||
|
|
bc341c1dff | ||
|
|
5fc9febf1f | ||
|
|
b23ceebfd8 | ||
|
|
c281fc54a1 | ||
|
|
d0f7dc5b48 | ||
|
|
fb53df862e | ||
|
|
8d8463ae41 | ||
|
|
8774cfe5f9 | ||
|
|
4ca5cadd19 | ||
|
|
45a8d50e03 | ||
|
|
960d4bfe6f | ||
|
|
8c3c964c52 | ||
|
|
afd6134a3e | ||
|
|
9b2d60e67b | ||
|
|
9807e25d45 | ||
|
|
824c895f52 | ||
|
|
7f9b9dfea4 | ||
|
|
d848ba9f65 | ||
|
|
47db5c9aa6 | ||
|
|
79a9653b26 | ||
|
|
e5aae1f365 | ||
|
|
8959190d32 | ||
|
|
7e875eb27a | ||
|
|
cf7306e766 | ||
|
|
1c442dcce6 | ||
|
|
dadd10f89b | ||
|
|
8838dabe8a | ||
|
|
75c012b558 | ||
|
|
9be1381ffe | ||
|
|
f40fe56572 | ||
|
|
b4fd242eb7 | ||
|
|
911476f82f | ||
|
|
963125f963 | ||
|
|
e86a34f2f3 | ||
|
|
6ce9567e48 | ||
|
|
f02145c5ef | ||
|
|
66fa08fd8e | ||
|
|
d783cc3b90 | ||
|
|
17cc75fe7d | ||
|
|
15394c6532 | ||
|
|
2d6252d75d | ||
|
|
adee0e39de | ||
|
|
5dde98cf3e | ||
|
|
c41451618e | ||
|
|
1a3d45f6bc | ||
|
|
2ea54975b6 | ||
|
|
0373017a9f | ||
|
|
b043e70fc0 | ||
|
|
2b5182d339 | ||
|
|
3c5ff81a54 | ||
|
|
8aa46c1f40 | ||
|
|
b26db50ae7 | ||
|
|
d66bb2104a | ||
|
|
8e900dbc92 | ||
|
|
66aac3eb3e | ||
|
|
221c3eddbc | ||
|
|
8460b28597 | ||
|
|
0344bb3c19 | ||
|
|
1a36bdce76 | ||
|
|
06d7db43f7 | ||
|
|
4557244744 | ||
|
|
f649288098 | ||
|
|
28df6db52b | ||
|
|
eee749652c | ||
|
|
f6aa25b9b3 | ||
|
|
40db26b686 | ||
|
|
f36d4e6906 | ||
|
|
86c7cbddab | ||
|
|
e52975bf6c | ||
|
|
ff792f76af | ||
|
|
711f312b71 | ||
|
|
9f0f89ff03 | ||
|
|
f3633cb696 | ||
|
|
8773ce25d7 | ||
|
|
c3954e9845 | ||
|
|
87eef10ff8 | ||
|
|
dc03ad8239 | ||
|
|
441a7262cd | ||
|
|
1600599410 | ||
|
|
74d381e7fa | ||
|
|
ae5faa75fa | ||
|
|
ba79bbc750 | ||
|
|
a7231777aa | ||
|
|
2578105f86 | ||
|
|
3a6b221b0c | ||
|
|
12b000abb9 | ||
|
|
39c9bbb167 | ||
|
|
30c2781a02 | ||
|
|
53e78dcc17 | ||
|
|
62092b2ddc | ||
|
|
2c26ed8b11 | ||
|
|
e3f5cd9a58 | ||
|
|
fba14817e7 | ||
|
|
6825a9773b | ||
|
|
8bc3078d87 | ||
|
|
8aeb2fa661 | ||
|
|
4bd545c88e | ||
|
|
7f0cce944d | ||
|
|
7cde6ee7ca | ||
|
|
df1b414c2e | ||
|
|
b6dbb68ef3 | ||
|
|
b434bba12f | ||
|
|
f1d7203212 | ||
|
|
990ba28831 | ||
|
|
311d6a1541 | ||
|
|
5e7276e65b | ||
|
|
2bcb942f93 | ||
|
|
b3dac3df08 | ||
|
|
64c5a863f8 | ||
|
|
cd94863850 | ||
|
|
fd1d33444a | ||
|
|
5aa56c63d4 | ||
|
|
8fdb6091f3 | ||
|
|
58182fcbdf | ||
|
|
b3b1e94b8c | ||
|
|
6fa2d6a98a | ||
|
|
3c252db46f | ||
|
|
8eba31913f | ||
|
|
e4e3415120 | ||
|
|
a03bb7ebce | ||
|
|
51e25d1a40 | ||
|
|
123f7d1999 | ||
|
|
9de40f067b | ||
|
|
b21d6d9d78 | ||
|
|
bf1ad15ed7 | ||
|
|
1209303a1d | ||
|
|
cd3a09ebf6 | ||
|
|
d0e20d4f1b | ||
|
|
ceb098fcfe | ||
|
|
639ba3a525 | ||
|
|
e88d55f1d2 | ||
|
|
4cb85f6480 | ||
|
|
df7dea2d16 | ||
|
|
23f4948bde | ||
|
|
0ceb7d0892 | ||
|
|
f35671db21 | ||
|
|
a3a0614948 | ||
|
|
a85b5f664f | ||
|
|
06b67ed4bc | ||
|
|
4a0e27572e | ||
|
|
fbea8dfa9e | ||
|
|
8c37348b65 | ||
|
|
2b3e9d72f4 | ||
|
|
a3e5235d81 | ||
|
|
9875fa92f1 | ||
|
|
7e28d8a5d6 | ||
|
|
8991e88ff3 | ||
|
|
e2a8ffa2d3 | ||
|
|
ef5156b613 | ||
|
|
b9a34ebb7e | ||
|
|
7642d0a000 | ||
|
|
7a6a9de0ea | ||
|
|
a5d50f9588 | ||
|
|
612695c2e8 | ||
|
|
71a2277b9b | ||
|
|
5acf287ea7 | ||
|
|
e34206b526 | ||
|
|
6b00adf8b9 | ||
|
|
a93558278e | ||
|
|
bc2867b357 | ||
|
|
52093ba258 | ||
|
|
24216f1f2f | ||
|
|
52e528f217 | ||
|
|
4709f9826c | ||
|
|
74a8c5d806 | ||
|
|
82a1a86c3a | ||
|
|
95957a192c | ||
|
|
906ce8ced2 | ||
|
|
e0985bee43 | ||
|
|
51dd6e6a1b | ||
|
|
89abb9d559 | ||
|
|
a2ea63a539 | ||
|
|
bfcd057755 | ||
|
|
08bdc23131 | ||
|
|
c9aba0c928 | ||
|
|
4397f57a51 | ||
|
|
356eaa0691 |
285
Jenkinsfile
vendored
285
Jenkinsfile
vendored
@@ -1,285 +0,0 @@
|
|||||||
import groovy.transform.Field
|
|
||||||
|
|
||||||
@Field
|
|
||||||
def shOutput = ""
|
|
||||||
def buildxPushTags = ""
|
|
||||||
|
|
||||||
pipeline {
|
|
||||||
agent {
|
|
||||||
label 'docker-multiarch'
|
|
||||||
}
|
|
||||||
options {
|
|
||||||
buildDiscarder(logRotator(numToKeepStr: '5'))
|
|
||||||
disableConcurrentBuilds()
|
|
||||||
ansiColor('xterm')
|
|
||||||
}
|
|
||||||
environment {
|
|
||||||
IMAGE = 'nginx-proxy-manager'
|
|
||||||
BUILD_VERSION = getVersion()
|
|
||||||
MAJOR_VERSION = '2'
|
|
||||||
BRANCH_LOWER = "${BRANCH_NAME.toLowerCase().replaceAll('\\\\', '-').replaceAll('/', '-').replaceAll('\\.', '-')}"
|
|
||||||
BUILDX_NAME = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}"
|
|
||||||
COMPOSE_INTERACTIVE_NO_CLI = 1
|
|
||||||
}
|
|
||||||
stages {
|
|
||||||
stage('Environment') {
|
|
||||||
parallel {
|
|
||||||
stage('Master') {
|
|
||||||
when {
|
|
||||||
branch 'master'
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
script {
|
|
||||||
buildxPushTags = "-t docker.io/jc21/${IMAGE}:${BUILD_VERSION} -t docker.io/jc21/${IMAGE}:${MAJOR_VERSION} -t docker.io/jc21/${IMAGE}:latest"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Other') {
|
|
||||||
when {
|
|
||||||
not {
|
|
||||||
branch 'master'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
script {
|
|
||||||
// Defaults to the Branch name, which is applies to all branches AND pr's
|
|
||||||
buildxPushTags = "-t docker.io/nginxproxymanager/${IMAGE}-dev:${BRANCH_LOWER}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Versions') {
|
|
||||||
steps {
|
|
||||||
sh 'cat frontend/package.json | jq --arg BUILD_VERSION "${BUILD_VERSION}" \'.version = $BUILD_VERSION\' | sponge frontend/package.json'
|
|
||||||
sh 'echo -e "\\E[1;36mFrontend Version is:\\E[1;33m $(cat frontend/package.json | jq -r .version)\\E[0m"'
|
|
||||||
sh 'cat backend/package.json | jq --arg BUILD_VERSION "${BUILD_VERSION}" \'.version = $BUILD_VERSION\' | sponge backend/package.json'
|
|
||||||
sh 'echo -e "\\E[1;36mBackend Version is:\\E[1;33m $(cat backend/package.json | jq -r .version)\\E[0m"'
|
|
||||||
sh 'sed -i -E "s/(version-)[0-9]+\\.[0-9]+\\.[0-9]+(-green)/\\1${BUILD_VERSION}\\2/" README.md'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Docker Login') {
|
|
||||||
steps {
|
|
||||||
withCredentials([usernamePassword(credentialsId: 'jc21-dockerhub', passwordVariable: 'dpass', usernameVariable: 'duser')]) {
|
|
||||||
sh 'docker login -u "${duser}" -p "${dpass}"'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Builds') {
|
|
||||||
parallel {
|
|
||||||
stage('Project') {
|
|
||||||
steps {
|
|
||||||
script {
|
|
||||||
// Frontend and Backend
|
|
||||||
def shStatusCode = sh(label: 'Checking and Building', returnStatus: true, script: '''
|
|
||||||
set -e
|
|
||||||
./scripts/ci/frontend-build > ${WORKSPACE}/tmp-sh-build 2>&1
|
|
||||||
./scripts/ci/test-and-build > ${WORKSPACE}/tmp-sh-build 2>&1
|
|
||||||
''')
|
|
||||||
shOutput = readFile "${env.WORKSPACE}/tmp-sh-build"
|
|
||||||
if (shStatusCode != 0) {
|
|
||||||
error "${shOutput}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
post {
|
|
||||||
always {
|
|
||||||
sh 'rm -f ${WORKSPACE}/tmp-sh-build'
|
|
||||||
}
|
|
||||||
failure {
|
|
||||||
npmGithubPrComment("CI Error:\n\n```\n${shOutput}\n```", true)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Docs') {
|
|
||||||
steps {
|
|
||||||
dir(path: 'docs') {
|
|
||||||
sh 'yarn install'
|
|
||||||
sh 'yarn build'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Test Sqlite') {
|
|
||||||
environment {
|
|
||||||
COMPOSE_PROJECT_NAME = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}_sqlite"
|
|
||||||
COMPOSE_FILE = 'docker/docker-compose.ci.yml:docker/docker-compose.ci.sqlite.yml'
|
|
||||||
}
|
|
||||||
when {
|
|
||||||
not {
|
|
||||||
equals expected: 'UNSTABLE', actual: currentBuild.result
|
|
||||||
}
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
sh 'rm -rf ./test/results/junit/*'
|
|
||||||
sh './scripts/ci/fulltest-cypress'
|
|
||||||
}
|
|
||||||
post {
|
|
||||||
always {
|
|
||||||
// Dumps to analyze later
|
|
||||||
sh 'mkdir -p debug/sqlite'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q fullstack) > debug/sqlite/docker_fullstack.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q stepca) > debug/sqlite/docker_stepca.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q pdns) > debug/sqlite/docker_pdns.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q pdns-db) > debug/sqlite/docker_pdns-db.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q dnsrouter) > debug/sqlite/docker_dnsrouter.log 2>&1'
|
|
||||||
junit 'test/results/junit/*'
|
|
||||||
sh 'docker compose down --remove-orphans --volumes -t 30 || true'
|
|
||||||
}
|
|
||||||
unstable {
|
|
||||||
dir(path: 'test/results') {
|
|
||||||
archiveArtifacts(allowEmptyArchive: true, artifacts: '**/*', excludes: '**/*.xml')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Test Mysql') {
|
|
||||||
environment {
|
|
||||||
COMPOSE_PROJECT_NAME = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}_mysql"
|
|
||||||
COMPOSE_FILE = 'docker/docker-compose.ci.yml:docker/docker-compose.ci.mysql.yml'
|
|
||||||
}
|
|
||||||
when {
|
|
||||||
not {
|
|
||||||
equals expected: 'UNSTABLE', actual: currentBuild.result
|
|
||||||
}
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
sh 'rm -rf ./test/results/junit/*'
|
|
||||||
sh './scripts/ci/fulltest-cypress'
|
|
||||||
}
|
|
||||||
post {
|
|
||||||
always {
|
|
||||||
// Dumps to analyze later
|
|
||||||
sh 'mkdir -p debug/mysql'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q fullstack) > debug/mysql/docker_fullstack.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q stepca) > debug/mysql/docker_stepca.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q pdns) > debug/mysql/docker_pdns.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q pdns-db) > debug/mysql/docker_pdns-db.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q dnsrouter) > debug/mysql/docker_dnsrouter.log 2>&1'
|
|
||||||
junit 'test/results/junit/*'
|
|
||||||
sh 'docker compose down --remove-orphans --volumes -t 30 || true'
|
|
||||||
}
|
|
||||||
unstable {
|
|
||||||
dir(path: 'test/results') {
|
|
||||||
archiveArtifacts(allowEmptyArchive: true, artifacts: '**/*', excludes: '**/*.xml')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Test Postgres') {
|
|
||||||
environment {
|
|
||||||
COMPOSE_PROJECT_NAME = "npm_${BRANCH_LOWER}_${BUILD_NUMBER}_postgres"
|
|
||||||
COMPOSE_FILE = 'docker/docker-compose.ci.yml:docker/docker-compose.ci.postgres.yml'
|
|
||||||
}
|
|
||||||
when {
|
|
||||||
not {
|
|
||||||
equals expected: 'UNSTABLE', actual: currentBuild.result
|
|
||||||
}
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
sh 'rm -rf ./test/results/junit/*'
|
|
||||||
sh './scripts/ci/fulltest-cypress'
|
|
||||||
}
|
|
||||||
post {
|
|
||||||
always {
|
|
||||||
// Dumps to analyze later
|
|
||||||
sh 'mkdir -p debug/postgres'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q fullstack) > debug/postgres/docker_fullstack.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q stepca) > debug/postgres/docker_stepca.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q pdns) > debug/postgres/docker_pdns.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q pdns-db) > debug/postgres/docker_pdns-db.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q dnsrouter) > debug/postgres/docker_dnsrouter.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q db-postgres) > debug/postgres/docker_db-postgres.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q authentik) > debug/postgres/docker_authentik.log 2>&1'
|
|
||||||
sh 'docker logs $(docker compose ps --all -q authentik-redis) > debug/postgres/docker_authentik-redis.log 2>&1'
|
|
||||||
sh 'docker logs $(docke rcompose ps --all -q authentik-ldap) > debug/postgres/docker_authentik-ldap.log 2>&1'
|
|
||||||
|
|
||||||
junit 'test/results/junit/*'
|
|
||||||
sh 'docker compose down --remove-orphans --volumes -t 30 || true'
|
|
||||||
}
|
|
||||||
unstable {
|
|
||||||
dir(path: 'test/results') {
|
|
||||||
archiveArtifacts(allowEmptyArchive: true, artifacts: '**/*', excludes: '**/*.xml')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('MultiArch Build') {
|
|
||||||
when {
|
|
||||||
not {
|
|
||||||
equals expected: 'UNSTABLE', actual: currentBuild.result
|
|
||||||
}
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
sh "./scripts/buildx --push ${buildxPushTags}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('Docs / Comment') {
|
|
||||||
parallel {
|
|
||||||
stage('Docs Job') {
|
|
||||||
when {
|
|
||||||
allOf {
|
|
||||||
branch pattern: "^(develop|master)\$", comparator: "REGEXP"
|
|
||||||
not {
|
|
||||||
equals expected: 'UNSTABLE', actual: currentBuild.result
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
build wait: false, job: 'nginx-proxy-manager-docs', parameters: [string(name: 'docs_branch', value: "$BRANCH_NAME")]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stage('PR Comment') {
|
|
||||||
when {
|
|
||||||
allOf {
|
|
||||||
changeRequest()
|
|
||||||
not {
|
|
||||||
equals expected: 'UNSTABLE', actual: currentBuild.result
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
steps {
|
|
||||||
script {
|
|
||||||
npmGithubPrComment("""Docker Image for build ${BUILD_NUMBER} is available on [DockerHub](https://cloud.docker.com/repository/docker/nginxproxymanager/${IMAGE}-dev):
|
|
||||||
```
|
|
||||||
nginxproxymanager/${IMAGE}-dev:${BRANCH_LOWER}
|
|
||||||
```
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> Ensure you backup your NPM instance before testing this image! Especially if there are database changes.
|
|
||||||
> This is a different docker image namespace than the official image.
|
|
||||||
|
|
||||||
> [!WARNING]
|
|
||||||
> Changes and additions to DNS Providers require verification by at least 2 members of the community!
|
|
||||||
""", true)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
post {
|
|
||||||
always {
|
|
||||||
sh 'echo Reverting ownership'
|
|
||||||
sh 'docker run --rm -v "$(pwd):/data" jc21/ci-tools chown -R "$(id -u):$(id -g)" /data'
|
|
||||||
printResult(true)
|
|
||||||
}
|
|
||||||
failure {
|
|
||||||
archiveArtifacts(artifacts: 'debug/**/*.*', allowEmptyArchive: true)
|
|
||||||
}
|
|
||||||
unstable {
|
|
||||||
archiveArtifacts(artifacts: 'debug/**/*.*', allowEmptyArchive: true)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
def getVersion() {
|
|
||||||
ver = sh(script: 'cat .version', returnStdout: true)
|
|
||||||
return ver.trim()
|
|
||||||
}
|
|
||||||
|
|
||||||
def getCommit() {
|
|
||||||
ver = sh(script: 'git log -n 1 --format=%h', returnStdout: true)
|
|
||||||
return ver.trim()
|
|
||||||
}
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://nginxproxymanager.com/github.png">
|
<img src="https://nginxproxymanager.com/github.png">
|
||||||
<br><br>
|
<br><br>
|
||||||
<img src="https://img.shields.io/badge/version-2.13.0-green.svg?style=for-the-badge">
|
<img src="https://img.shields.io/badge/version-2.13.5-green.svg?style=for-the-badge">
|
||||||
<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
|
<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">
|
<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
|
||||||
</a>
|
</a>
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import fileUpload from "express-fileupload";
|
|||||||
import { isDebugMode } from "./lib/config.js";
|
import { isDebugMode } from "./lib/config.js";
|
||||||
import cors from "./lib/express/cors.js";
|
import cors from "./lib/express/cors.js";
|
||||||
import jwt from "./lib/express/jwt.js";
|
import jwt from "./lib/express/jwt.js";
|
||||||
import { express as logger } from "./logger.js";
|
import { debug, express as logger } from "./logger.js";
|
||||||
import mainRoutes from "./routes/main.js";
|
import mainRoutes from "./routes/main.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -80,7 +80,7 @@ app.use((err, req, res, _) => {
|
|||||||
|
|
||||||
// Not every error is worth logging - but this is good for now until it gets annoying.
|
// Not every error is worth logging - but this is good for now until it gets annoying.
|
||||||
if (typeof err.stack !== "undefined" && err.stack) {
|
if (typeof err.stack !== "undefined" && err.stack) {
|
||||||
logger.debug(err.stack);
|
debug(logger, err.stack);
|
||||||
if (typeof err.public === "undefined" || !err.public) {
|
if (typeof err.public === "undefined" || !err.public) {
|
||||||
logger.warn(err.message);
|
logger.warn(err.message);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"$schema": "https://biomejs.dev/schemas/2.3.1/schema.json",
|
"$schema": "https://biomejs.dev/schemas/2.3.2/schema.json",
|
||||||
"vcs": {
|
"vcs": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"clientKind": "git",
|
"clientKind": "git",
|
||||||
|
|||||||
@@ -26,8 +26,8 @@
|
|||||||
"azure": {
|
"azure": {
|
||||||
"name": "Azure",
|
"name": "Azure",
|
||||||
"package_name": "certbot-dns-azure",
|
"package_name": "certbot-dns-azure",
|
||||||
"version": "~=1.2.0",
|
"version": "~=2.6.1",
|
||||||
"dependencies": "",
|
"dependencies": "azure-mgmt-dns==8.2.0",
|
||||||
"credentials": "# This plugin supported API authentication using either Service Principals or utilizing a Managed Identity assigned to the virtual machine.\n# Regardless which authentication method used, the identity will need the “DNS Zone Contributor” role assigned to it.\n# As multiple Azure DNS Zones in multiple resource groups can exist, the config file needs a mapping of zone to resource group ID. Multiple zones -> ID mappings can be listed by using the key dns_azure_zoneX where X is a unique number. At least 1 zone mapping is required.\n\n# Using a service principal (option 1)\ndns_azure_sp_client_id = 912ce44a-0156-4669-ae22-c16a17d34ca5\ndns_azure_sp_client_secret = E-xqXU83Y-jzTI6xe9fs2YC~mck3ZzUih9\ndns_azure_tenant_id = ed1090f3-ab18-4b12-816c-599af8a88cf7\n\n# Using used assigned MSI (option 2)\n# dns_azure_msi_client_id = 912ce44a-0156-4669-ae22-c16a17d34ca5\n\n# Using system assigned MSI (option 3)\n# dns_azure_msi_system_assigned = true\n\n# Zones (at least one always required)\ndns_azure_zone1 = example.com:/subscriptions/c135abce-d87d-48df-936c-15596c6968a5/resourceGroups/dns1\ndns_azure_zone2 = example.org:/subscriptions/99800903-fb14-4992-9aff-12eaf2744622/resourceGroups/dns2",
|
"credentials": "# This plugin supported API authentication using either Service Principals or utilizing a Managed Identity assigned to the virtual machine.\n# Regardless which authentication method used, the identity will need the “DNS Zone Contributor” role assigned to it.\n# As multiple Azure DNS Zones in multiple resource groups can exist, the config file needs a mapping of zone to resource group ID. Multiple zones -> ID mappings can be listed by using the key dns_azure_zoneX where X is a unique number. At least 1 zone mapping is required.\n\n# Using a service principal (option 1)\ndns_azure_sp_client_id = 912ce44a-0156-4669-ae22-c16a17d34ca5\ndns_azure_sp_client_secret = E-xqXU83Y-jzTI6xe9fs2YC~mck3ZzUih9\ndns_azure_tenant_id = ed1090f3-ab18-4b12-816c-599af8a88cf7\n\n# Using used assigned MSI (option 2)\n# dns_azure_msi_client_id = 912ce44a-0156-4669-ae22-c16a17d34ca5\n\n# Using system assigned MSI (option 3)\n# dns_azure_msi_system_assigned = true\n\n# Zones (at least one always required)\ndns_azure_zone1 = example.com:/subscriptions/c135abce-d87d-48df-936c-15596c6968a5/resourceGroups/dns1\ndns_azure_zone2 = example.org:/subscriptions/99800903-fb14-4992-9aff-12eaf2744622/resourceGroups/dns2",
|
||||||
"full_plugin_name": "dns-azure"
|
"full_plugin_name": "dns-azure"
|
||||||
},
|
},
|
||||||
@@ -295,6 +295,14 @@
|
|||||||
"credentials": "dns_hetzner_api_token = 0123456789abcdef0123456789abcdef",
|
"credentials": "dns_hetzner_api_token = 0123456789abcdef0123456789abcdef",
|
||||||
"full_plugin_name": "dns-hetzner"
|
"full_plugin_name": "dns-hetzner"
|
||||||
},
|
},
|
||||||
|
"hetzner-cloud": {
|
||||||
|
"name": "Hetzner Cloud",
|
||||||
|
"package_name": "certbot-dns-hetzner-cloud",
|
||||||
|
"version": "~=1.0.4",
|
||||||
|
"dependencies": "",
|
||||||
|
"credentials": "dns_hetzner_cloud_api_token = your_api_token_here",
|
||||||
|
"full_plugin_name": "dns-hetzner-cloud"
|
||||||
|
},
|
||||||
"hostingnl": {
|
"hostingnl": {
|
||||||
"name": "Hosting.nl",
|
"name": "Hosting.nl",
|
||||||
"package_name": "certbot-dns-hostingnl",
|
"package_name": "certbot-dns-hostingnl",
|
||||||
@@ -362,7 +370,7 @@
|
|||||||
"leaseweb": {
|
"leaseweb": {
|
||||||
"name": "LeaseWeb",
|
"name": "LeaseWeb",
|
||||||
"package_name": "certbot-dns-leaseweb",
|
"package_name": "certbot-dns-leaseweb",
|
||||||
"version": "~=1.0.1",
|
"version": "~=1.0.3",
|
||||||
"dependencies": "",
|
"dependencies": "",
|
||||||
"credentials": "dns_leaseweb_api_token = 01234556789",
|
"credentials": "dns_leaseweb_api_token = 01234556789",
|
||||||
"full_plugin_name": "dns-leaseweb"
|
"full_plugin_name": "dns-leaseweb"
|
||||||
@@ -391,6 +399,14 @@
|
|||||||
"credentials": "dns_luadns_email = user@example.com\ndns_luadns_token = 0123456789abcdef0123456789abcdef",
|
"credentials": "dns_luadns_email = user@example.com\ndns_luadns_token = 0123456789abcdef0123456789abcdef",
|
||||||
"full_plugin_name": "dns-luadns"
|
"full_plugin_name": "dns-luadns"
|
||||||
},
|
},
|
||||||
|
"mchost24": {
|
||||||
|
"name": "MC-HOST24",
|
||||||
|
"package_name": "certbot-dns-mchost24",
|
||||||
|
"version": "",
|
||||||
|
"dependencies": "",
|
||||||
|
"credentials": "# Obtain API token using https://github.com/JoeJoeTV/mchost24-api-python\ndns_mchost24_api_token=<insert obtained API token here>",
|
||||||
|
"full_plugin_name": "dns-mchost24"
|
||||||
|
},
|
||||||
"mijnhost": {
|
"mijnhost": {
|
||||||
"name": "mijn.host",
|
"name": "mijn.host",
|
||||||
"package_name": "certbot-dns-mijn-host",
|
"package_name": "certbot-dns-mijn-host",
|
||||||
@@ -466,7 +482,7 @@
|
|||||||
"porkbun": {
|
"porkbun": {
|
||||||
"name": "Porkbun",
|
"name": "Porkbun",
|
||||||
"package_name": "certbot-dns-porkbun",
|
"package_name": "certbot-dns-porkbun",
|
||||||
"version": "~=0.9",
|
"version": "~=0.11.0",
|
||||||
"dependencies": "",
|
"dependencies": "",
|
||||||
"credentials": "dns_porkbun_key=your-porkbun-api-key\ndns_porkbun_secret=your-porkbun-api-secret",
|
"credentials": "dns_porkbun_key=your-porkbun-api-key\ndns_porkbun_secret=your-porkbun-api-secret",
|
||||||
"full_plugin_name": "dns-porkbun"
|
"full_plugin_name": "dns-porkbun"
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
import knex from "knex";
|
import knex from "knex";
|
||||||
import {configGet, configHas} from "./lib/config.js";
|
import {configGet, configHas} from "./lib/config.js";
|
||||||
|
|
||||||
|
let instance = null;
|
||||||
|
|
||||||
const generateDbConfig = () => {
|
const generateDbConfig = () => {
|
||||||
if (!configHas("database")) {
|
if (!configHas("database")) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
@@ -21,7 +23,8 @@ const generateDbConfig = () => {
|
|||||||
user: cfg.user,
|
user: cfg.user,
|
||||||
password: cfg.password,
|
password: cfg.password,
|
||||||
database: cfg.name,
|
database: cfg.name,
|
||||||
port: cfg.port,
|
port: cfg.port,
|
||||||
|
...(cfg.ssl ? { ssl: cfg.ssl } : {})
|
||||||
},
|
},
|
||||||
migrations: {
|
migrations: {
|
||||||
tableName: "migrations",
|
tableName: "migrations",
|
||||||
@@ -29,4 +32,11 @@ const generateDbConfig = () => {
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export default knex(generateDbConfig());
|
const getInstance = () => {
|
||||||
|
if (!instance) {
|
||||||
|
instance = knex(generateDbConfig());
|
||||||
|
}
|
||||||
|
return instance;
|
||||||
|
}
|
||||||
|
|
||||||
|
export default getInstance;
|
||||||
|
|||||||
@@ -195,11 +195,11 @@ const internalAccessList = {
|
|||||||
);
|
);
|
||||||
|
|
||||||
await internalAccessList.build(freshRow)
|
await internalAccessList.build(freshRow)
|
||||||
if (Number.parseInt(row.proxy_host_count, 10)) {
|
if (Number.parseInt(freshRow.proxy_host_count, 10)) {
|
||||||
await internalNginx.bulkGenerateConfigs("proxy_host", row.proxy_hosts);
|
await internalNginx.bulkGenerateConfigs("proxy_host", freshRow.proxy_hosts);
|
||||||
}
|
}
|
||||||
await internalNginx.reload();
|
await internalNginx.reload();
|
||||||
return internalAccessList.maskItems(row);
|
return internalAccessList.maskItems(freshRow);
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -4,13 +4,14 @@ import path from "path";
|
|||||||
import archiver from "archiver";
|
import archiver from "archiver";
|
||||||
import _ from "lodash";
|
import _ from "lodash";
|
||||||
import moment from "moment";
|
import moment from "moment";
|
||||||
|
import { ProxyAgent } from "proxy-agent";
|
||||||
import tempWrite from "temp-write";
|
import tempWrite from "temp-write";
|
||||||
import dnsPlugins from "../certbot/dns-plugins.json" with { type: "json" };
|
import dnsPlugins from "../certbot/dns-plugins.json" with { type: "json" };
|
||||||
import { installPlugin } from "../lib/certbot.js";
|
import { installPlugin } from "../lib/certbot.js";
|
||||||
import { useLetsencryptServer, useLetsencryptStaging } from "../lib/config.js";
|
import { useLetsencryptServer, useLetsencryptStaging } from "../lib/config.js";
|
||||||
import error from "../lib/error.js";
|
import error from "../lib/error.js";
|
||||||
import utils from "../lib/utils.js";
|
import utils from "../lib/utils.js";
|
||||||
import { ssl as logger } from "../logger.js";
|
import { debug, ssl as logger } from "../logger.js";
|
||||||
import certificateModel from "../models/certificate.js";
|
import certificateModel from "../models/certificate.js";
|
||||||
import tokenModel from "../models/token.js";
|
import tokenModel from "../models/token.js";
|
||||||
import userModel from "../models/user.js";
|
import userModel from "../models/user.js";
|
||||||
@@ -355,7 +356,7 @@ const internalCertificate = {
|
|||||||
const opName = `/tmp/${downloadName}`;
|
const opName = `/tmp/${downloadName}`;
|
||||||
|
|
||||||
await internalCertificate.zipFiles(certFiles, opName);
|
await internalCertificate.zipFiles(certFiles, opName);
|
||||||
logger.debug("zip completed : ", opName);
|
debug(logger, "zip completed : ", opName);
|
||||||
return {
|
return {
|
||||||
fileName: opName,
|
fileName: opName,
|
||||||
};
|
};
|
||||||
@@ -375,7 +376,7 @@ const internalCertificate = {
|
|||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
source.map((fl) => {
|
source.map((fl) => {
|
||||||
const fileName = path.basename(fl);
|
const fileName = path.basename(fl);
|
||||||
logger.debug(fl, "added to certificate zip");
|
debug(logger, fl, "added to certificate zip");
|
||||||
archive.file(fl, { name: fileName });
|
archive.file(fl, { name: fileName });
|
||||||
return true;
|
return true;
|
||||||
});
|
});
|
||||||
@@ -1114,6 +1115,7 @@ const internalCertificate = {
|
|||||||
|
|
||||||
performTestForDomain: async (domain) => {
|
performTestForDomain: async (domain) => {
|
||||||
logger.info(`Testing http challenge for ${domain}`);
|
logger.info(`Testing http challenge for ${domain}`);
|
||||||
|
const agent = new ProxyAgent();
|
||||||
const url = `http://${domain}/.well-known/acme-challenge/test-challenge`;
|
const url = `http://${domain}/.well-known/acme-challenge/test-challenge`;
|
||||||
const formBody = `method=G&url=${encodeURI(url)}&bodytype=T&requestbody=&headername=User-Agent&headervalue=None&locationid=1&ch=false&cc=false`;
|
const formBody = `method=G&url=${encodeURI(url)}&bodytype=T&requestbody=&headername=User-Agent&headervalue=None&locationid=1&ch=false&cc=false`;
|
||||||
const options = {
|
const options = {
|
||||||
@@ -1123,6 +1125,7 @@ const internalCertificate = {
|
|||||||
"Content-Type": "application/x-www-form-urlencoded",
|
"Content-Type": "application/x-www-form-urlencoded",
|
||||||
"Content-Length": Buffer.byteLength(formBody),
|
"Content-Length": Buffer.byteLength(formBody),
|
||||||
},
|
},
|
||||||
|
agent,
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await new Promise((resolve) => {
|
const result = await new Promise((resolve) => {
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import fs from "node:fs";
|
|||||||
import https from "node:https";
|
import https from "node:https";
|
||||||
import { dirname } from "node:path";
|
import { dirname } from "node:path";
|
||||||
import { fileURLToPath } from "node:url";
|
import { fileURLToPath } from "node:url";
|
||||||
|
import { ProxyAgent } from "proxy-agent";
|
||||||
import errs from "../lib/error.js";
|
import errs from "../lib/error.js";
|
||||||
import utils from "../lib/utils.js";
|
import utils from "../lib/utils.js";
|
||||||
import { ipRanges as logger } from "../logger.js";
|
import { ipRanges as logger } from "../logger.js";
|
||||||
@@ -29,10 +30,11 @@ const internalIpRanges = {
|
|||||||
},
|
},
|
||||||
|
|
||||||
fetchUrl: (url) => {
|
fetchUrl: (url) => {
|
||||||
|
const agent = new ProxyAgent();
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
logger.info(`Fetching ${url}`);
|
logger.info(`Fetching ${url}`);
|
||||||
return https
|
return https
|
||||||
.get(url, (res) => {
|
.get(url, { agent }, (res) => {
|
||||||
res.setEncoding("utf8");
|
res.setEncoding("utf8");
|
||||||
let raw_data = "";
|
let raw_data = "";
|
||||||
res.on("data", (chunk) => {
|
res.on("data", (chunk) => {
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
|
|||||||
import _ from "lodash";
|
import _ from "lodash";
|
||||||
import errs from "../lib/error.js";
|
import errs from "../lib/error.js";
|
||||||
import utils from "../lib/utils.js";
|
import utils from "../lib/utils.js";
|
||||||
import { nginx as logger } from "../logger.js";
|
import { debug, nginx as logger } from "../logger.js";
|
||||||
|
|
||||||
const __filename = fileURLToPath(import.meta.url);
|
const __filename = fileURLToPath(import.meta.url);
|
||||||
const __dirname = dirname(__filename);
|
const __dirname = dirname(__filename);
|
||||||
@@ -68,7 +68,7 @@ const internalNginx = {
|
|||||||
return true;
|
return true;
|
||||||
});
|
});
|
||||||
|
|
||||||
logger.debug("Nginx test failed:", valid_lines.join("\n"));
|
debug(logger, "Nginx test failed:", valid_lines.join("\n"));
|
||||||
|
|
||||||
// config is bad, update meta and delete config
|
// config is bad, update meta and delete config
|
||||||
combined_meta = _.assign({}, host.meta, {
|
combined_meta = _.assign({}, host.meta, {
|
||||||
@@ -102,7 +102,7 @@ const internalNginx = {
|
|||||||
* @returns {Promise}
|
* @returns {Promise}
|
||||||
*/
|
*/
|
||||||
test: () => {
|
test: () => {
|
||||||
logger.debug("Testing Nginx configuration");
|
debug(logger, "Testing Nginx configuration");
|
||||||
return utils.execFile("/usr/sbin/nginx", ["-t", "-g", "error_log off;"]);
|
return utils.execFile("/usr/sbin/nginx", ["-t", "-g", "error_log off;"]);
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ const internalNginx = {
|
|||||||
const host = JSON.parse(JSON.stringify(host_row));
|
const host = JSON.parse(JSON.stringify(host_row));
|
||||||
const nice_host_type = internalNginx.getFileFriendlyHostType(host_type);
|
const nice_host_type = internalNginx.getFileFriendlyHostType(host_type);
|
||||||
|
|
||||||
logger.debug(`Generating ${nice_host_type} Config:`, JSON.stringify(host, null, 2));
|
debug(logger, `Generating ${nice_host_type} Config:`, JSON.stringify(host, null, 2));
|
||||||
|
|
||||||
const renderEngine = utils.getRenderEngine();
|
const renderEngine = utils.getRenderEngine();
|
||||||
|
|
||||||
@@ -216,6 +216,11 @@ const internalNginx = {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// For redirection hosts, if the scheme is not http or https, set it to $scheme
|
||||||
|
if (nice_host_type === "redirection_host" && ['http', 'https'].indexOf(host.forward_scheme.toLowerCase()) === -1) {
|
||||||
|
host.forward_scheme = "$scheme";
|
||||||
|
}
|
||||||
|
|
||||||
if (host.locations) {
|
if (host.locations) {
|
||||||
//logger.info ('host.locations = ' + JSON.stringify(host.locations, null, 2));
|
//logger.info ('host.locations = ' + JSON.stringify(host.locations, null, 2));
|
||||||
origLocations = [].concat(host.locations);
|
origLocations = [].concat(host.locations);
|
||||||
@@ -241,7 +246,7 @@ const internalNginx = {
|
|||||||
.parseAndRender(template, host)
|
.parseAndRender(template, host)
|
||||||
.then((config_text) => {
|
.then((config_text) => {
|
||||||
fs.writeFileSync(filename, config_text, { encoding: "utf8" });
|
fs.writeFileSync(filename, config_text, { encoding: "utf8" });
|
||||||
logger.debug("Wrote config:", filename, config_text);
|
debug(logger, "Wrote config:", filename, config_text);
|
||||||
|
|
||||||
// Restore locations array
|
// Restore locations array
|
||||||
host.locations = origLocations;
|
host.locations = origLocations;
|
||||||
@@ -249,7 +254,7 @@ const internalNginx = {
|
|||||||
resolve(true);
|
resolve(true);
|
||||||
})
|
})
|
||||||
.catch((err) => {
|
.catch((err) => {
|
||||||
logger.debug(`Could not write ${filename}:`, err.message);
|
debug(logger, `Could not write ${filename}:`, err.message);
|
||||||
reject(new errs.ConfigurationError(err.message));
|
reject(new errs.ConfigurationError(err.message));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -265,7 +270,7 @@ const internalNginx = {
|
|||||||
* @returns {Promise}
|
* @returns {Promise}
|
||||||
*/
|
*/
|
||||||
generateLetsEncryptRequestConfig: (certificate) => {
|
generateLetsEncryptRequestConfig: (certificate) => {
|
||||||
logger.debug("Generating LetsEncrypt Request Config:", certificate);
|
debug(logger, "Generating LetsEncrypt Request Config:", certificate);
|
||||||
const renderEngine = utils.getRenderEngine();
|
const renderEngine = utils.getRenderEngine();
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
@@ -285,11 +290,11 @@ const internalNginx = {
|
|||||||
.parseAndRender(template, certificate)
|
.parseAndRender(template, certificate)
|
||||||
.then((config_text) => {
|
.then((config_text) => {
|
||||||
fs.writeFileSync(filename, config_text, { encoding: "utf8" });
|
fs.writeFileSync(filename, config_text, { encoding: "utf8" });
|
||||||
logger.debug("Wrote config:", filename, config_text);
|
debug(logger, "Wrote config:", filename, config_text);
|
||||||
resolve(true);
|
resolve(true);
|
||||||
})
|
})
|
||||||
.catch((err) => {
|
.catch((err) => {
|
||||||
logger.debug(`Could not write ${filename}:`, err.message);
|
debug(logger, `Could not write ${filename}:`, err.message);
|
||||||
reject(new errs.ConfigurationError(err.message));
|
reject(new errs.ConfigurationError(err.message));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -305,10 +310,10 @@ const internalNginx = {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
try {
|
try {
|
||||||
logger.debug(`Deleting file: ${filename}`);
|
debug(logger, `Deleting file: ${filename}`);
|
||||||
fs.unlinkSync(filename);
|
fs.unlinkSync(filename);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug("Could not delete file:", JSON.stringify(err, null, 2));
|
debug(logger, "Could not delete file:", JSON.stringify(err, null, 2));
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -381,14 +386,14 @@ const internalNginx = {
|
|||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {String} host_type
|
* @param {String} hostType
|
||||||
* @param {Array} hosts
|
* @param {Array} hosts
|
||||||
* @returns {Promise}
|
* @returns {Promise}
|
||||||
*/
|
*/
|
||||||
bulkGenerateConfigs: (host_type, hosts) => {
|
bulkGenerateConfigs: (hostType, hosts) => {
|
||||||
const promises = [];
|
const promises = [];
|
||||||
hosts.map((host) => {
|
hosts.map((host) => {
|
||||||
promises.push(internalNginx.generateConfig(host_type, host));
|
promises.push(internalNginx.generateConfig(hostType, host));
|
||||||
return true;
|
return true;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
84
backend/internal/remote-version.js
Normal file
84
backend/internal/remote-version.js
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
import https from "node:https";
|
||||||
|
import { ProxyAgent } from "proxy-agent";
|
||||||
|
import { debug, remoteVersion as logger } from "../logger.js";
|
||||||
|
import pjson from "../package.json" with { type: "json" };
|
||||||
|
|
||||||
|
const VERSION_URL = "https://api.github.com/repos/NginxProxyManager/nginx-proxy-manager/releases/latest";
|
||||||
|
|
||||||
|
const internalRemoteVersion = {
|
||||||
|
cache_timeout: 1000 * 60 * 15, // 15 minutes
|
||||||
|
last_result: null,
|
||||||
|
last_fetch_time: null,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch the latest version info, using a cached result if within the cache timeout period.
|
||||||
|
* @return {Promise<{current: string, latest: string, update_available: boolean}>} Version info
|
||||||
|
*/
|
||||||
|
get: async () => {
|
||||||
|
if (
|
||||||
|
!internalRemoteVersion.last_result ||
|
||||||
|
!internalRemoteVersion.last_fetch_time ||
|
||||||
|
Date.now() - internalRemoteVersion.last_fetch_time > internalRemoteVersion.cache_timeout
|
||||||
|
) {
|
||||||
|
const raw = await internalRemoteVersion.fetchUrl(VERSION_URL);
|
||||||
|
const data = JSON.parse(raw);
|
||||||
|
internalRemoteVersion.last_result = data;
|
||||||
|
internalRemoteVersion.last_fetch_time = Date.now();
|
||||||
|
} else {
|
||||||
|
debug(logger, "Using cached remote version result");
|
||||||
|
}
|
||||||
|
|
||||||
|
const latestVersion = internalRemoteVersion.last_result.tag_name;
|
||||||
|
const version = pjson.version.split("-").shift().split(".");
|
||||||
|
const currentVersion = `v${version[0]}.${version[1]}.${version[2]}`;
|
||||||
|
return {
|
||||||
|
current: currentVersion,
|
||||||
|
latest: latestVersion,
|
||||||
|
update_available: internalRemoteVersion.compareVersions(currentVersion, latestVersion),
|
||||||
|
};
|
||||||
|
},
|
||||||
|
|
||||||
|
fetchUrl: (url) => {
|
||||||
|
const agent = new ProxyAgent();
|
||||||
|
const headers = {
|
||||||
|
"User-Agent": `NginxProxyManager v${pjson.version}`,
|
||||||
|
};
|
||||||
|
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
logger.info(`Fetching ${url}`);
|
||||||
|
return https
|
||||||
|
.get(url, { agent, headers }, (res) => {
|
||||||
|
res.setEncoding("utf8");
|
||||||
|
let raw_data = "";
|
||||||
|
res.on("data", (chunk) => {
|
||||||
|
raw_data += chunk;
|
||||||
|
});
|
||||||
|
res.on("end", () => {
|
||||||
|
resolve(raw_data);
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.on("error", (err) => {
|
||||||
|
reject(err);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
},
|
||||||
|
|
||||||
|
compareVersions: (current, latest) => {
|
||||||
|
const cleanCurrent = current.replace(/^v/, "");
|
||||||
|
const cleanLatest = latest.replace(/^v/, "");
|
||||||
|
|
||||||
|
const currentParts = cleanCurrent.split(".").map(Number);
|
||||||
|
const latestParts = cleanLatest.split(".").map(Number);
|
||||||
|
|
||||||
|
for (let i = 0; i < Math.max(currentParts.length, latestParts.length); i++) {
|
||||||
|
const curr = currentParts[i] || 0;
|
||||||
|
const lat = latestParts[i] || 0;
|
||||||
|
|
||||||
|
if (lat > curr) return true;
|
||||||
|
if (lat < curr) return false;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default internalRemoteVersion;
|
||||||
@@ -265,7 +265,7 @@ export default function (tokenString) {
|
|||||||
schemas: [roleSchema, permsSchema, objectSchema, permissionSchema],
|
schemas: [roleSchema, permsSchema, objectSchema, permissionSchema],
|
||||||
});
|
});
|
||||||
|
|
||||||
const valid = ajv.validate("permissions", dataSchema);
|
const valid = await ajv.validate("permissions", dataSchema);
|
||||||
return valid && dataSchema[permission];
|
return valid && dataSchema[permission];
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
err.permission = permission;
|
err.permission = permission;
|
||||||
|
|||||||
@@ -25,15 +25,26 @@ const configure = () => {
|
|||||||
|
|
||||||
if (configData?.database) {
|
if (configData?.database) {
|
||||||
logger.info(`Using configuration from file: ${filename}`);
|
logger.info(`Using configuration from file: ${filename}`);
|
||||||
|
|
||||||
|
// Migrate those who have "mysql" engine to "mysql2"
|
||||||
|
if (configData.database.engine === "mysql") {
|
||||||
|
configData.database.engine = mysqlEngine;
|
||||||
|
}
|
||||||
|
|
||||||
instance = configData;
|
instance = configData;
|
||||||
instance.keys = getKeys();
|
instance.keys = getKeys();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const envMysqlHost = process.env.DB_MYSQL_HOST || null;
|
const toBool = (v) => /^(1|true|yes|on)$/i.test((v || '').trim());
|
||||||
const envMysqlUser = process.env.DB_MYSQL_USER || null;
|
|
||||||
const envMysqlName = process.env.DB_MYSQL_NAME || null;
|
const envMysqlHost = process.env.DB_MYSQL_HOST || null;
|
||||||
|
const envMysqlUser = process.env.DB_MYSQL_USER || null;
|
||||||
|
const envMysqlName = process.env.DB_MYSQL_NAME || null;
|
||||||
|
const envMysqlSSL = toBool(process.env.DB_MYSQL_SSL);
|
||||||
|
const envMysqlSSLRejectUnauthorized = process.env.DB_MYSQL_SSL_REJECT_UNAUTHORIZED === undefined ? true : toBool(process.env.DB_MYSQL_SSL_REJECT_UNAUTHORIZED);
|
||||||
|
const envMysqlSSLVerifyIdentity = process.env.DB_MYSQL_SSL_VERIFY_IDENTITY === undefined ? true : toBool(process.env.DB_MYSQL_SSL_VERIFY_IDENTITY);
|
||||||
if (envMysqlHost && envMysqlUser && envMysqlName) {
|
if (envMysqlHost && envMysqlUser && envMysqlName) {
|
||||||
// we have enough mysql creds to go with mysql
|
// we have enough mysql creds to go with mysql
|
||||||
logger.info("Using MySQL configuration");
|
logger.info("Using MySQL configuration");
|
||||||
@@ -44,7 +55,8 @@ const configure = () => {
|
|||||||
port: process.env.DB_MYSQL_PORT || 3306,
|
port: process.env.DB_MYSQL_PORT || 3306,
|
||||||
user: envMysqlUser,
|
user: envMysqlUser,
|
||||||
password: process.env.DB_MYSQL_PASSWORD,
|
password: process.env.DB_MYSQL_PASSWORD,
|
||||||
name: envMysqlName,
|
name: envMysqlName,
|
||||||
|
ssl: envMysqlSSL ? { rejectUnauthorized: envMysqlSSLRejectUnauthorized, verifyIdentity: envMysqlSSLVerifyIdentity } : false,
|
||||||
},
|
},
|
||||||
keys: getKeys(),
|
keys: getKeys(),
|
||||||
};
|
};
|
||||||
@@ -90,7 +102,9 @@ const configure = () => {
|
|||||||
|
|
||||||
const getKeys = () => {
|
const getKeys = () => {
|
||||||
// Get keys from file
|
// Get keys from file
|
||||||
logger.debug("Cheecking for keys file:", keysFile);
|
if (isDebugMode()) {
|
||||||
|
logger.debug("Checking for keys file:", keysFile);
|
||||||
|
}
|
||||||
if (!fs.existsSync(keysFile)) {
|
if (!fs.existsSync(keysFile)) {
|
||||||
generateKeys();
|
generateKeys();
|
||||||
} else if (process.env.DEBUG) {
|
} else if (process.env.DEBUG) {
|
||||||
|
|||||||
@@ -3,14 +3,14 @@ import { dirname } from "node:path";
|
|||||||
import { fileURLToPath } from "node:url";
|
import { fileURLToPath } from "node:url";
|
||||||
import { Liquid } from "liquidjs";
|
import { Liquid } from "liquidjs";
|
||||||
import _ from "lodash";
|
import _ from "lodash";
|
||||||
import { global as logger } from "../logger.js";
|
import { debug, global as logger } from "../logger.js";
|
||||||
import errs from "./error.js";
|
import errs from "./error.js";
|
||||||
|
|
||||||
const __filename = fileURLToPath(import.meta.url);
|
const __filename = fileURLToPath(import.meta.url);
|
||||||
const __dirname = dirname(__filename);
|
const __dirname = dirname(__filename);
|
||||||
|
|
||||||
const exec = async (cmd, options = {}) => {
|
const exec = async (cmd, options = {}) => {
|
||||||
logger.debug("CMD:", cmd);
|
debug(logger, "CMD:", cmd);
|
||||||
const { stdout, stderr } = await new Promise((resolve, reject) => {
|
const { stdout, stderr } = await new Promise((resolve, reject) => {
|
||||||
const child = nodeExec(cmd, options, (isError, stdout, stderr) => {
|
const child = nodeExec(cmd, options, (isError, stdout, stderr) => {
|
||||||
if (isError) {
|
if (isError) {
|
||||||
@@ -34,7 +34,7 @@ const exec = async (cmd, options = {}) => {
|
|||||||
* @returns {Promise}
|
* @returns {Promise}
|
||||||
*/
|
*/
|
||||||
const execFile = (cmd, args, options) => {
|
const execFile = (cmd, args, options) => {
|
||||||
logger.debug(`CMD: ${cmd} ${args ? args.join(" ") : ""}`);
|
debug(logger, `CMD: ${cmd} ${args ? args.join(" ") : ""}`);
|
||||||
const opts = options || {};
|
const opts = options || {};
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
import signale from "signale";
|
import signale from "signale";
|
||||||
|
import { isDebugMode } from "./lib/config.js";
|
||||||
|
|
||||||
const opts = {
|
const opts = {
|
||||||
logLevel: "info",
|
logLevel: "info",
|
||||||
@@ -14,5 +15,12 @@ const certbot = new signale.Signale({ scope: "Certbot ", ...opts });
|
|||||||
const importer = new signale.Signale({ scope: "Importer ", ...opts });
|
const importer = new signale.Signale({ scope: "Importer ", ...opts });
|
||||||
const setup = new signale.Signale({ scope: "Setup ", ...opts });
|
const setup = new signale.Signale({ scope: "Setup ", ...opts });
|
||||||
const ipRanges = new signale.Signale({ scope: "IP Ranges", ...opts });
|
const ipRanges = new signale.Signale({ scope: "IP Ranges", ...opts });
|
||||||
|
const remoteVersion = new signale.Signale({ scope: "Remote Version", ...opts });
|
||||||
|
|
||||||
export { global, migrate, express, access, nginx, ssl, certbot, importer, setup, ipRanges };
|
const debug = (logger, ...args) => {
|
||||||
|
if (isDebugMode()) {
|
||||||
|
logger.debug(...args);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export { debug, global, migrate, express, access, nginx, ssl, certbot, importer, setup, ipRanges, remoteVersion };
|
||||||
|
|||||||
@@ -2,9 +2,9 @@ import db from "./db.js";
|
|||||||
import { migrate as logger } from "./logger.js";
|
import { migrate as logger } from "./logger.js";
|
||||||
|
|
||||||
const migrateUp = async () => {
|
const migrateUp = async () => {
|
||||||
const version = await db.migrate.currentVersion();
|
const version = await db().migrate.currentVersion();
|
||||||
logger.info("Current database version:", version);
|
logger.info("Current database version:", version);
|
||||||
return await db.migrate.latest({
|
return await db().migrate.latest({
|
||||||
tableName: "migrations",
|
tableName: "migrations",
|
||||||
directory: "migrations",
|
directory: "migrations",
|
||||||
});
|
});
|
||||||
|
|||||||
50
backend/migrations/20251111090000_redirect_auto_scheme.js
Normal file
50
backend/migrations/20251111090000_redirect_auto_scheme.js
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
import { migrate as logger } from "../logger.js";
|
||||||
|
|
||||||
|
const migrateName = "redirect_auto_scheme";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Migrate
|
||||||
|
*
|
||||||
|
* @see http://knexjs.org/#Schema
|
||||||
|
*
|
||||||
|
* @param {Object} knex
|
||||||
|
* @returns {Promise}
|
||||||
|
*/
|
||||||
|
const up = (knex) => {
|
||||||
|
logger.info(`[${migrateName}] Migrating Up...`);
|
||||||
|
|
||||||
|
return knex.schema
|
||||||
|
.table("redirection_host", async (table) => {
|
||||||
|
// change the column default from $scheme to auto
|
||||||
|
await table.string("forward_scheme").notNull().defaultTo("auto").alter();
|
||||||
|
await knex('redirection_host')
|
||||||
|
.where('forward_scheme', '$scheme')
|
||||||
|
.update({ forward_scheme: 'auto' });
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
logger.info(`[${migrateName}] redirection_host Table altered`);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Undo Migrate
|
||||||
|
*
|
||||||
|
* @param {Object} knex
|
||||||
|
* @returns {Promise}
|
||||||
|
*/
|
||||||
|
const down = (knex) => {
|
||||||
|
logger.info(`[${migrateName}] Migrating Down...`);
|
||||||
|
|
||||||
|
return knex.schema
|
||||||
|
.table("redirection_host", async (table) => {
|
||||||
|
await table.string("forward_scheme").notNull().defaultTo("$scheme").alter();
|
||||||
|
await knex('redirection_host')
|
||||||
|
.where('forward_scheme', 'auto')
|
||||||
|
.update({ forward_scheme: '$scheme' });
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
logger.info(`[${migrateName}] redirection_host Table altered`);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
export { up, down };
|
||||||
@@ -10,7 +10,7 @@ import now from "./now_helper.js";
|
|||||||
import ProxyHostModel from "./proxy_host.js";
|
import ProxyHostModel from "./proxy_host.js";
|
||||||
import User from "./user.js";
|
import User from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = ["is_deleted", "satisfy_any", "pass_auth"];
|
const boolFields = ["is_deleted", "satisfy_any", "pass_auth"];
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import db from "../db.js";
|
|||||||
import accessListModel from "./access_list.js";
|
import accessListModel from "./access_list.js";
|
||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
class AccessListAuth extends Model {
|
class AccessListAuth extends Model {
|
||||||
$beforeInsert() {
|
$beforeInsert() {
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import db from "../db.js";
|
|||||||
import accessListModel from "./access_list.js";
|
import accessListModel from "./access_list.js";
|
||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
class AccessListClient extends Model {
|
class AccessListClient extends Model {
|
||||||
$beforeInsert() {
|
$beforeInsert() {
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import db from "../db.js";
|
|||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
import User from "./user.js";
|
import User from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
class AuditLog extends Model {
|
class AuditLog extends Model {
|
||||||
$beforeInsert() {
|
$beforeInsert() {
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import { convertBoolFieldsToInt, convertIntFieldsToBool } from "../lib/helpers.j
|
|||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
import User from "./user.js";
|
import User from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = ["is_deleted"];
|
const boolFields = ["is_deleted"];
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import redirectionHostModel from "./redirection_host.js";
|
|||||||
import streamModel from "./stream.js";
|
import streamModel from "./stream.js";
|
||||||
import userModel from "./user.js";
|
import userModel from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = ["is_deleted"];
|
const boolFields = ["is_deleted"];
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import Certificate from "./certificate.js";
|
|||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
import User from "./user.js";
|
import User from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = ["is_deleted", "ssl_forced", "http2_support", "enabled", "hsts_enabled", "hsts_subdomains"];
|
const boolFields = ["is_deleted", "ssl_forced", "http2_support", "enabled", "hsts_enabled", "hsts_subdomains"];
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import { Model } from "objection";
|
|||||||
import db from "../db.js";
|
import db from "../db.js";
|
||||||
import { isSqlite } from "../lib/config.js";
|
import { isSqlite } from "../lib/config.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
export default () => {
|
export default () => {
|
||||||
if (isSqlite()) {
|
if (isSqlite()) {
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import Certificate from "./certificate.js";
|
|||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
import User from "./user.js";
|
import User from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = [
|
const boolFields = [
|
||||||
"is_deleted",
|
"is_deleted",
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import Certificate from "./certificate.js";
|
|||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
import User from "./user.js";
|
import User from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = [
|
const boolFields = [
|
||||||
"is_deleted",
|
"is_deleted",
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
import { Model } from "objection";
|
import { Model } from "objection";
|
||||||
import db from "../db.js";
|
import db from "../db.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
class Setting extends Model {
|
class Setting extends Model {
|
||||||
$beforeInsert () {
|
$beforeInsert () {
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import Certificate from "./certificate.js";
|
|||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
import User from "./user.js";
|
import User from "./user.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = ["is_deleted", "enabled", "tcp_forwarding", "udp_forwarding"];
|
const boolFields = ["is_deleted", "enabled", "tcp_forwarding", "udp_forwarding"];
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { convertBoolFieldsToInt, convertIntFieldsToBool } from "../lib/helpers.j
|
|||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
import UserPermission from "./user_permission.js";
|
import UserPermission from "./user_permission.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
const boolFields = ["is_deleted", "is_disabled"];
|
const boolFields = ["is_deleted", "is_disabled"];
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import { Model } from "objection";
|
|||||||
import db from "../db.js";
|
import db from "../db.js";
|
||||||
import now from "./now_helper.js";
|
import now from "./now_helper.js";
|
||||||
|
|
||||||
Model.knex(db);
|
Model.knex(db());
|
||||||
|
|
||||||
class UserPermission extends Model {
|
class UserPermission extends Model {
|
||||||
$beforeInsert () {
|
$beforeInsert () {
|
||||||
|
|||||||
@@ -20,9 +20,9 @@
|
|||||||
"body-parser": "^1.20.3",
|
"body-parser": "^1.20.3",
|
||||||
"compression": "^1.7.4",
|
"compression": "^1.7.4",
|
||||||
"express": "^4.20.0",
|
"express": "^4.20.0",
|
||||||
"express-fileupload": "^1.1.9",
|
"express-fileupload": "^1.5.2",
|
||||||
"gravatar": "^1.8.0",
|
"gravatar": "^1.8.2",
|
||||||
"jsonwebtoken": "^9.0.0",
|
"jsonwebtoken": "^9.0.2",
|
||||||
"knex": "2.4.2",
|
"knex": "2.4.2",
|
||||||
"liquidjs": "10.6.1",
|
"liquidjs": "10.6.1",
|
||||||
"lodash": "^4.17.21",
|
"lodash": "^4.17.21",
|
||||||
@@ -32,13 +32,14 @@
|
|||||||
"objection": "3.0.1",
|
"objection": "3.0.1",
|
||||||
"path": "^0.12.7",
|
"path": "^0.12.7",
|
||||||
"pg": "^8.16.3",
|
"pg": "^8.16.3",
|
||||||
|
"proxy-agent": "^6.5.0",
|
||||||
"signale": "1.4.0",
|
"signale": "1.4.0",
|
||||||
"sqlite3": "^5.1.7",
|
"sqlite3": "^5.1.7",
|
||||||
"temp-write": "^4.0.0"
|
"temp-write": "^4.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@apidevtools/swagger-parser": "^10.1.0",
|
"@apidevtools/swagger-parser": "^10.1.0",
|
||||||
"@biomejs/biome": "^2.3.1",
|
"@biomejs/biome": "^2.3.2",
|
||||||
"chalk": "4.1.2",
|
"chalk": "4.1.2",
|
||||||
"nodemon": "^2.0.2"
|
"nodemon": "^2.0.2"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import express from "express";
|
|||||||
import internalAuditLog from "../internal/audit-log.js";
|
import internalAuditLog from "../internal/audit-log.js";
|
||||||
import jwtdecode from "../lib/express/jwt-decode.js";
|
import jwtdecode from "../lib/express/jwt-decode.js";
|
||||||
import validator from "../lib/validator/index.js";
|
import validator from "../lib/validator/index.js";
|
||||||
import { express as logger } from "../logger.js";
|
import { debug, express as logger } from "../logger.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
caseSensitive: true,
|
caseSensitive: true,
|
||||||
@@ -47,7 +47,7 @@ router
|
|||||||
const rows = await internalAuditLog.getAll(res.locals.access, data.expand, data.query);
|
const rows = await internalAuditLog.getAll(res.locals.access, data.expand, data.query);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -99,7 +99,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(item);
|
res.status(200).send(item);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ import schemaRoutes from "./schema.js";
|
|||||||
import settingsRoutes from "./settings.js";
|
import settingsRoutes from "./settings.js";
|
||||||
import tokensRoutes from "./tokens.js";
|
import tokensRoutes from "./tokens.js";
|
||||||
import usersRoutes from "./users.js";
|
import usersRoutes from "./users.js";
|
||||||
|
import versionRoutes from "./version.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
caseSensitive: true,
|
caseSensitive: true,
|
||||||
@@ -46,6 +47,7 @@ router.use("/users", usersRoutes);
|
|||||||
router.use("/audit-log", auditLogRoutes);
|
router.use("/audit-log", auditLogRoutes);
|
||||||
router.use("/reports", reportsRoutes);
|
router.use("/reports", reportsRoutes);
|
||||||
router.use("/settings", settingsRoutes);
|
router.use("/settings", settingsRoutes);
|
||||||
|
router.use("/version", versionRoutes);
|
||||||
router.use("/nginx/proxy-hosts", proxyHostsRoutes);
|
router.use("/nginx/proxy-hosts", proxyHostsRoutes);
|
||||||
router.use("/nginx/redirection-hosts", redirectionHostsRoutes);
|
router.use("/nginx/redirection-hosts", redirectionHostsRoutes);
|
||||||
router.use("/nginx/dead-hosts", deadHostsRoutes);
|
router.use("/nginx/dead-hosts", deadHostsRoutes);
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import internalAccessList from "../../internal/access-list.js";
|
|||||||
import jwtdecode from "../../lib/express/jwt-decode.js";
|
import jwtdecode from "../../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../../lib/validator/api.js";
|
import apiValidator from "../../lib/validator/api.js";
|
||||||
import validator from "../../lib/validator/index.js";
|
import validator from "../../lib/validator/index.js";
|
||||||
import { express as logger } from "../../logger.js";
|
import { debug, express as logger } from "../../logger.js";
|
||||||
import { getValidationSchema } from "../../schema/index.js";
|
import { getValidationSchema } from "../../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -49,7 +49,7 @@ router
|
|||||||
const rows = await internalAccessList.getAll(res.locals.access, data.expand, data.query);
|
const rows = await internalAccessList.getAll(res.locals.access, data.expand, data.query);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -65,7 +65,7 @@ router
|
|||||||
const result = await internalAccessList.create(res.locals.access, payload);
|
const result = await internalAccessList.create(res.locals.access, payload);
|
||||||
res.status(201).send(result);
|
res.status(201).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -113,7 +113,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(row);
|
res.status(200).send(row);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -130,7 +130,7 @@ router
|
|||||||
const result = await internalAccessList.update(res.locals.access, payload);
|
const result = await internalAccessList.update(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -147,7 +147,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import errs from "../../lib/error.js";
|
|||||||
import jwtdecode from "../../lib/express/jwt-decode.js";
|
import jwtdecode from "../../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../../lib/validator/api.js";
|
import apiValidator from "../../lib/validator/api.js";
|
||||||
import validator from "../../lib/validator/index.js";
|
import validator from "../../lib/validator/index.js";
|
||||||
import { express as logger } from "../../logger.js";
|
import { debug, express as logger } from "../../logger.js";
|
||||||
import { getValidationSchema } from "../../schema/index.js";
|
import { getValidationSchema } from "../../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -58,7 +58,7 @@ router
|
|||||||
);
|
);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -81,7 +81,7 @@ router
|
|||||||
);
|
);
|
||||||
res.status(201).send(result);
|
res.status(201).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -115,7 +115,7 @@ router
|
|||||||
clean.sort((a, b) => a.name.localeCompare(b.name));
|
clean.sort((a, b) => a.name.localeCompare(b.name));
|
||||||
res.status(200).send(clean);
|
res.status(200).send(clean);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -151,7 +151,7 @@ router
|
|||||||
);
|
);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -185,7 +185,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -236,7 +236,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(row);
|
res.status(200).send(row);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -253,7 +253,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -288,7 +288,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -318,7 +318,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -347,7 +347,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).download(result.fileName);
|
res.status(200).download(result.fileName);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import internalDeadHost from "../../internal/dead-host.js";
|
|||||||
import jwtdecode from "../../lib/express/jwt-decode.js";
|
import jwtdecode from "../../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../../lib/validator/api.js";
|
import apiValidator from "../../lib/validator/api.js";
|
||||||
import validator from "../../lib/validator/index.js";
|
import validator from "../../lib/validator/index.js";
|
||||||
import { express as logger } from "../../logger.js";
|
import { debug, express as logger } from "../../logger.js";
|
||||||
import { getValidationSchema } from "../../schema/index.js";
|
import { getValidationSchema } from "../../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -49,7 +49,7 @@ router
|
|||||||
const rows = await internalDeadHost.getAll(res.locals.access, data.expand, data.query);
|
const rows = await internalDeadHost.getAll(res.locals.access, data.expand, data.query);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -65,7 +65,7 @@ router
|
|||||||
const result = await internalDeadHost.create(res.locals.access, payload);
|
const result = await internalDeadHost.create(res.locals.access, payload);
|
||||||
res.status(201).send(result);
|
res.status(201).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -113,7 +113,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(row);
|
res.status(200).send(row);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -130,7 +130,7 @@ router
|
|||||||
const result = await internalDeadHost.update(res.locals.access, payload);
|
const result = await internalDeadHost.update(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -147,7 +147,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -174,7 +174,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -199,7 +199,7 @@ router
|
|||||||
const result = internalDeadHost.disable(res.locals.access, { id: Number.parseInt(req.params.host_id, 10) });
|
const result = internalDeadHost.disable(res.locals.access, { id: Number.parseInt(req.params.host_id, 10) });
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import internalProxyHost from "../../internal/proxy-host.js";
|
|||||||
import jwtdecode from "../../lib/express/jwt-decode.js";
|
import jwtdecode from "../../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../../lib/validator/api.js";
|
import apiValidator from "../../lib/validator/api.js";
|
||||||
import validator from "../../lib/validator/index.js";
|
import validator from "../../lib/validator/index.js";
|
||||||
import { express as logger } from "../../logger.js";
|
import { debug, express as logger } from "../../logger.js";
|
||||||
import { getValidationSchema } from "../../schema/index.js";
|
import { getValidationSchema } from "../../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -49,7 +49,7 @@ router
|
|||||||
const rows = await internalProxyHost.getAll(res.locals.access, data.expand, data.query);
|
const rows = await internalProxyHost.getAll(res.locals.access, data.expand, data.query);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -65,7 +65,7 @@ router
|
|||||||
const result = await internalProxyHost.create(res.locals.access, payload);
|
const result = await internalProxyHost.create(res.locals.access, payload);
|
||||||
res.status(201).send(result);
|
res.status(201).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err} ${JSON.stringify(err.debug, null, 2)}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err} ${JSON.stringify(err.debug, null, 2)}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -113,7 +113,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(row);
|
res.status(200).send(row);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -130,7 +130,7 @@ router
|
|||||||
const result = await internalProxyHost.update(res.locals.access, payload);
|
const result = await internalProxyHost.update(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -147,7 +147,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -174,7 +174,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -201,7 +201,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import internalRedirectionHost from "../../internal/redirection-host.js";
|
|||||||
import jwtdecode from "../../lib/express/jwt-decode.js";
|
import jwtdecode from "../../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../../lib/validator/api.js";
|
import apiValidator from "../../lib/validator/api.js";
|
||||||
import validator from "../../lib/validator/index.js";
|
import validator from "../../lib/validator/index.js";
|
||||||
import { express as logger } from "../../logger.js";
|
import { debug, express as logger } from "../../logger.js";
|
||||||
import { getValidationSchema } from "../../schema/index.js";
|
import { getValidationSchema } from "../../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -49,7 +49,7 @@ router
|
|||||||
const rows = await internalRedirectionHost.getAll(res.locals.access, data.expand, data.query);
|
const rows = await internalRedirectionHost.getAll(res.locals.access, data.expand, data.query);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -65,7 +65,7 @@ router
|
|||||||
const result = await internalRedirectionHost.create(res.locals.access, payload);
|
const result = await internalRedirectionHost.create(res.locals.access, payload);
|
||||||
res.status(201).send(result);
|
res.status(201).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -113,7 +113,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(row);
|
res.status(200).send(row);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -133,7 +133,7 @@ router
|
|||||||
const result = await internalRedirectionHost.update(res.locals.access, payload);
|
const result = await internalRedirectionHost.update(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -150,7 +150,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -177,7 +177,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -204,7 +204,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import internalStream from "../../internal/stream.js";
|
|||||||
import jwtdecode from "../../lib/express/jwt-decode.js";
|
import jwtdecode from "../../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../../lib/validator/api.js";
|
import apiValidator from "../../lib/validator/api.js";
|
||||||
import validator from "../../lib/validator/index.js";
|
import validator from "../../lib/validator/index.js";
|
||||||
import { express as logger } from "../../logger.js";
|
import { debug, express as logger } from "../../logger.js";
|
||||||
import { getValidationSchema } from "../../schema/index.js";
|
import { getValidationSchema } from "../../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -49,7 +49,7 @@ router
|
|||||||
const rows = await internalStream.getAll(res.locals.access, data.expand, data.query);
|
const rows = await internalStream.getAll(res.locals.access, data.expand, data.query);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -65,7 +65,7 @@ router
|
|||||||
const result = await internalStream.create(res.locals.access, payload);
|
const result = await internalStream.create(res.locals.access, payload);
|
||||||
res.status(201).send(result);
|
res.status(201).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -113,7 +113,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(row);
|
res.status(200).send(row);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -130,7 +130,7 @@ router
|
|||||||
const result = await internalStream.update(res.locals.access, payload);
|
const result = await internalStream.update(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -147,7 +147,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -174,7 +174,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -201,7 +201,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import express from "express";
|
import express from "express";
|
||||||
import internalReport from "../internal/report.js";
|
import internalReport from "../internal/report.js";
|
||||||
import jwtdecode from "../lib/express/jwt-decode.js";
|
import jwtdecode from "../lib/express/jwt-decode.js";
|
||||||
import { express as logger } from "../logger.js";
|
import { debug, express as logger } from "../logger.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
caseSensitive: true,
|
caseSensitive: true,
|
||||||
@@ -24,7 +24,7 @@ router
|
|||||||
const data = await internalReport.getHostsReport(res.locals.access);
|
const data = await internalReport.getHostsReport(res.locals.access);
|
||||||
res.status(200).send(data);
|
res.status(200).send(data);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import express from "express";
|
import express from "express";
|
||||||
import { express as logger } from "../logger.js";
|
import { debug, express as logger } from "../logger.js";
|
||||||
import PACKAGE from "../package.json" with { type: "json" };
|
import PACKAGE from "../package.json" with { type: "json" };
|
||||||
import { getCompiledSchema } from "../schema/index.js";
|
import { getCompiledSchema } from "../schema/index.js";
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ router
|
|||||||
swaggerJSON.servers[0].url = `${origin}/api`;
|
swaggerJSON.servers[0].url = `${origin}/api`;
|
||||||
res.status(200).send(swaggerJSON);
|
res.status(200).send(swaggerJSON);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import internalSetting from "../internal/setting.js";
|
|||||||
import jwtdecode from "../lib/express/jwt-decode.js";
|
import jwtdecode from "../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../lib/validator/api.js";
|
import apiValidator from "../lib/validator/api.js";
|
||||||
import validator from "../lib/validator/index.js";
|
import validator from "../lib/validator/index.js";
|
||||||
import { express as logger } from "../logger.js";
|
import { debug, express as logger } from "../logger.js";
|
||||||
import { getValidationSchema } from "../schema/index.js";
|
import { getValidationSchema } from "../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -32,7 +32,7 @@ router
|
|||||||
const rows = await internalSetting.getAll(res.locals.access);
|
const rows = await internalSetting.getAll(res.locals.access);
|
||||||
res.status(200).send(rows);
|
res.status(200).send(rows);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -76,7 +76,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(row);
|
res.status(200).send(row);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -93,7 +93,7 @@ router
|
|||||||
const result = await internalSetting.update(res.locals.access, payload);
|
const result = await internalSetting.update(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import express from "express";
|
|||||||
import internalToken from "../internal/token.js";
|
import internalToken from "../internal/token.js";
|
||||||
import jwtdecode from "../lib/express/jwt-decode.js";
|
import jwtdecode from "../lib/express/jwt-decode.js";
|
||||||
import apiValidator from "../lib/validator/api.js";
|
import apiValidator from "../lib/validator/api.js";
|
||||||
import { express as logger } from "../logger.js";
|
import { debug, express as logger } from "../logger.js";
|
||||||
import { getValidationSchema } from "../schema/index.js";
|
import { getValidationSchema } from "../schema/index.js";
|
||||||
|
|
||||||
const router = express.Router({
|
const router = express.Router({
|
||||||
@@ -32,7 +32,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(data);
|
res.status(200).send(data);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -48,7 +48,7 @@ router
|
|||||||
const result = await internalToken.getTokenFromEmail(data);
|
const result = await internalToken.getTokenFromEmail(data);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import jwtdecode from "../lib/express/jwt-decode.js";
|
|||||||
import userIdFromMe from "../lib/express/user-id-from-me.js";
|
import userIdFromMe from "../lib/express/user-id-from-me.js";
|
||||||
import apiValidator from "../lib/validator/api.js";
|
import apiValidator from "../lib/validator/api.js";
|
||||||
import validator from "../lib/validator/index.js";
|
import validator from "../lib/validator/index.js";
|
||||||
import { express as logger } from "../logger.js";
|
import { debug, express as logger } from "../logger.js";
|
||||||
import { getValidationSchema } from "../schema/index.js";
|
import { getValidationSchema } from "../schema/index.js";
|
||||||
import { isSetup } from "../setup.js";
|
import { isSetup } from "../setup.js";
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ router
|
|||||||
);
|
);
|
||||||
res.status(200).send(users);
|
res.status(200).send(users);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -101,7 +101,7 @@ router
|
|||||||
const user = await internalUser.create(res.locals.access, payload);
|
const user = await internalUser.create(res.locals.access, payload);
|
||||||
res.status(201).send(user);
|
res.status(201).send(user);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -124,7 +124,7 @@ router
|
|||||||
await internalUser.deleteAll();
|
await internalUser.deleteAll();
|
||||||
res.status(200).send(true);
|
res.status(200).send(true);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
@@ -185,7 +185,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(user);
|
res.status(200).send(user);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -205,7 +205,7 @@ router
|
|||||||
const result = await internalUser.update(res.locals.access, payload);
|
const result = await internalUser.update(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -222,7 +222,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -255,7 +255,7 @@ router
|
|||||||
const result = await internalUser.setPassword(res.locals.access, payload);
|
const result = await internalUser.setPassword(res.locals.access, payload);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -291,7 +291,7 @@ router
|
|||||||
);
|
);
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -320,7 +320,7 @@ router
|
|||||||
});
|
});
|
||||||
res.status(200).send(result);
|
res.status(200).send(result);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
logger.debug(`${req.method.toUpperCase()} ${req.path}: ${err}`);
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${err}`);
|
||||||
next(err);
|
next(err);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
40
backend/routes/version.js
Normal file
40
backend/routes/version.js
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
import express from "express";
|
||||||
|
import internalRemoteVersion from "../internal/remote-version.js";
|
||||||
|
import { debug, express as logger } from "../logger.js";
|
||||||
|
|
||||||
|
const router = express.Router({
|
||||||
|
caseSensitive: true,
|
||||||
|
strict: true,
|
||||||
|
mergeParams: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* /api/version/check
|
||||||
|
*/
|
||||||
|
router
|
||||||
|
.route("/check")
|
||||||
|
.options((_, res) => {
|
||||||
|
res.sendStatus(204);
|
||||||
|
})
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GET /api/version/check
|
||||||
|
*
|
||||||
|
* Check for available updates
|
||||||
|
*/
|
||||||
|
.get(async (req, res, _next) => {
|
||||||
|
try {
|
||||||
|
const data = await internalRemoteVersion.get();
|
||||||
|
res.status(200).send(data);
|
||||||
|
} catch (error) {
|
||||||
|
debug(logger, `${req.method.toUpperCase()} ${req.path}: ${error}`);
|
||||||
|
// Send 200 even though there's an error to avoid triggering update checks repeatedly
|
||||||
|
res.status(200).send({
|
||||||
|
current: null,
|
||||||
|
latest: null,
|
||||||
|
update_available: false,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
export default router;
|
||||||
@@ -7,7 +7,8 @@
|
|||||||
"description": "Unique identifier",
|
"description": "Unique identifier",
|
||||||
"readOnly": true,
|
"readOnly": true,
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1,
|
||||||
|
"example": 11
|
||||||
},
|
},
|
||||||
"expand": {
|
"expand": {
|
||||||
"anyOf": [
|
"anyOf": [
|
||||||
@@ -38,35 +39,42 @@
|
|||||||
"created_on": {
|
"created_on": {
|
||||||
"description": "Date and time of creation",
|
"description": "Date and time of creation",
|
||||||
"readOnly": true,
|
"readOnly": true,
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "2025-10-28T04:17:54.000Z"
|
||||||
},
|
},
|
||||||
"modified_on": {
|
"modified_on": {
|
||||||
"description": "Date and time of last update",
|
"description": "Date and time of last update",
|
||||||
"readOnly": true,
|
"readOnly": true,
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "2025-10-28T04:17:54.000Z"
|
||||||
},
|
},
|
||||||
"user_id": {
|
"user_id": {
|
||||||
"description": "User ID",
|
"description": "User ID",
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1,
|
||||||
|
"example": 2
|
||||||
},
|
},
|
||||||
"certificate_id": {
|
"certificate_id": {
|
||||||
"description": "Certificate ID",
|
"description": "Certificate ID",
|
||||||
"anyOf": [
|
"anyOf": [
|
||||||
{
|
{
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 0
|
"minimum": 0,
|
||||||
|
"example": 5
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^new$"
|
"pattern": "^new$",
|
||||||
|
"example": "new"
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"example": 5
|
||||||
},
|
},
|
||||||
"access_list_id": {
|
"access_list_id": {
|
||||||
"description": "Access List ID",
|
"description": "Access List ID",
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 0
|
"minimum": 0,
|
||||||
|
"example": 3
|
||||||
},
|
},
|
||||||
"domain_names": {
|
"domain_names": {
|
||||||
"description": "Domain Names separated by a comma",
|
"description": "Domain Names separated by a comma",
|
||||||
@@ -77,44 +85,157 @@
|
|||||||
"items": {
|
"items": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^[^&| @!#%^();:/\\\\}{=+?<>,~`'\"]+$"
|
"pattern": "^[^&| @!#%^();:/\\\\}{=+?<>,~`'\"]+$"
|
||||||
}
|
},
|
||||||
|
"example": ["example.com", "www.example.com"]
|
||||||
},
|
},
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"description": "Is Enabled",
|
"description": "Is Enabled",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
},
|
},
|
||||||
"ssl_forced": {
|
"ssl_forced": {
|
||||||
"description": "Is SSL Forced",
|
"description": "Is SSL Forced",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
},
|
},
|
||||||
"hsts_enabled": {
|
"hsts_enabled": {
|
||||||
"description": "Is HSTS Enabled",
|
"description": "Is HSTS Enabled",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
},
|
},
|
||||||
"hsts_subdomains": {
|
"hsts_subdomains": {
|
||||||
"description": "Is HSTS applicable to all subdomains",
|
"description": "Is HSTS applicable to all subdomains",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
},
|
},
|
||||||
"ssl_provider": {
|
"ssl_provider": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^(letsencrypt|other)$"
|
"pattern": "^(letsencrypt|other)$",
|
||||||
|
"example": "letsencrypt"
|
||||||
},
|
},
|
||||||
"http2_support": {
|
"http2_support": {
|
||||||
"description": "HTTP2 Protocol Support",
|
"description": "HTTP2 Protocol Support",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
},
|
},
|
||||||
"block_exploits": {
|
"block_exploits": {
|
||||||
"description": "Should we block common exploits",
|
"description": "Should we block common exploits",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
},
|
},
|
||||||
"caching_enabled": {
|
"caching_enabled": {
|
||||||
"description": "Should we cache assets",
|
"description": "Should we cache assets",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
},
|
},
|
||||||
"email": {
|
"email": {
|
||||||
"description": "Email address",
|
"description": "Email address",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$"
|
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$",
|
||||||
|
"example": "me@example.com"
|
||||||
|
},
|
||||||
|
"directive": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["allow", "deny"],
|
||||||
|
"example": "allow"
|
||||||
|
},
|
||||||
|
"address": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))?$"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"pattern": "^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string",
|
||||||
|
"pattern": "^all$"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"example": "192.168.0.11"
|
||||||
|
},
|
||||||
|
"access_items": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"properties": {
|
||||||
|
"username": {
|
||||||
|
"type": "string",
|
||||||
|
"minLength": 1
|
||||||
|
},
|
||||||
|
"password": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"username": "admin",
|
||||||
|
"password": "pass"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"username": "admin",
|
||||||
|
"password": "pass"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"access_clients": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"properties": {
|
||||||
|
"address": {
|
||||||
|
"$ref": "#/properties/address"
|
||||||
|
},
|
||||||
|
"directive": {
|
||||||
|
"$ref": "#/properties/directive"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"directive": "allow",
|
||||||
|
"address": "192.168.0.0/24"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"directive": "allow",
|
||||||
|
"address": "192.168.0.0/24"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"certificate_files": {
|
||||||
|
"description": "Certificate Files",
|
||||||
|
"content": {
|
||||||
|
"multipart/form-data": {
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": ["certificate", "certificate_key"],
|
||||||
|
"properties": {
|
||||||
|
"certificate": {
|
||||||
|
"type": "string",
|
||||||
|
"example": "-----BEGIN CERTIFICATE-----\nMIID...-----END CERTIFICATE-----"
|
||||||
|
},
|
||||||
|
"certificate_key": {
|
||||||
|
"type": "string",
|
||||||
|
"example": "-----BEGIN CERTIFICATE-----\nMIID...-----END CERTIFICATE-----"
|
||||||
|
},
|
||||||
|
"intermediate_certificate": {
|
||||||
|
"type": "string",
|
||||||
|
"example": "-----BEGIN CERTIFICATE-----\nMIID...-----END CERTIFICATE-----"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"certificate": "-----BEGIN CERTIFICATE-----\nMIID...-----END CERTIFICATE-----",
|
||||||
|
"certificate_key": "-----BEGIN PRIVATE\nMIID...-----END CERTIFICATE-----"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "Access List object",
|
"description": "Access List object",
|
||||||
"required": ["id", "created_on", "modified_on", "owner_user_id", "name", "directive", "address", "satisfy_any", "pass_auth", "meta"],
|
"required": ["id", "created_on", "modified_on", "owner_user_id", "name", "meta", "satisfy_any", "pass_auth", "proxy_host_count"],
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"id": {
|
"id": {
|
||||||
"$ref": "../common.json#/properties/id"
|
"$ref": "../common.json#/properties/id"
|
||||||
@@ -18,36 +17,25 @@
|
|||||||
},
|
},
|
||||||
"name": {
|
"name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"minLength": 1
|
"minLength": 1,
|
||||||
},
|
"example": "My Access List"
|
||||||
"directive": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["allow", "deny"]
|
|
||||||
},
|
|
||||||
"address": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))?$"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^all$"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"satisfy_any": {
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
"pass_auth": {
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
},
|
||||||
"meta": {
|
"meta": {
|
||||||
"type": "object"
|
"type": "object",
|
||||||
|
"example": {}
|
||||||
|
},
|
||||||
|
"satisfy_any": {
|
||||||
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
|
},
|
||||||
|
"pass_auth": {
|
||||||
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
|
},
|
||||||
|
"proxy_host_count": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0,
|
||||||
|
"example": 3
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,16 +26,19 @@
|
|||||||
"$ref": "../common.json#/properties/user_id"
|
"$ref": "../common.json#/properties/user_id"
|
||||||
},
|
},
|
||||||
"object_type": {
|
"object_type": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "certificate"
|
||||||
},
|
},
|
||||||
"object_id": {
|
"object_id": {
|
||||||
"$ref": "../common.json#/properties/id"
|
"$ref": "../common.json#/properties/id"
|
||||||
},
|
},
|
||||||
"action": {
|
"action": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "created"
|
||||||
},
|
},
|
||||||
"meta": {
|
"meta": {
|
||||||
"type": "object"
|
"type": "object",
|
||||||
|
"example": {}
|
||||||
},
|
},
|
||||||
"user": {
|
"user": {
|
||||||
"$ref": "./user-object.json"
|
"$ref": "./user-object.json"
|
||||||
|
|||||||
@@ -21,7 +21,8 @@
|
|||||||
},
|
},
|
||||||
"nice_name": {
|
"nice_name": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Nice Name for the custom certificate"
|
"description": "Nice Name for the custom certificate",
|
||||||
|
"example": "My Custom Cert"
|
||||||
},
|
},
|
||||||
"domain_names": {
|
"domain_names": {
|
||||||
"description": "Domain Names separated by a comma",
|
"description": "Domain Names separated by a comma",
|
||||||
@@ -31,12 +32,14 @@
|
|||||||
"items": {
|
"items": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^[^&| @!#%^();:/\\\\}{=+?<>,~`'\"]+$"
|
"pattern": "^[^&| @!#%^();:/\\\\}{=+?<>,~`'\"]+$"
|
||||||
}
|
},
|
||||||
|
"example": ["example.com", "www.example.com"]
|
||||||
},
|
},
|
||||||
"expires_on": {
|
"expires_on": {
|
||||||
"description": "Date and time of expiration",
|
"description": "Date and time of expiration",
|
||||||
"readOnly": true,
|
"readOnly": true,
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "2025-10-28T04:17:54.000Z"
|
||||||
},
|
},
|
||||||
"owner": {
|
"owner": {
|
||||||
"$ref": "./user-object.json"
|
"$ref": "./user-object.json"
|
||||||
@@ -56,10 +59,10 @@
|
|||||||
"dns_challenge": {
|
"dns_challenge": {
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
"dns_provider": {
|
"dns_provider_credentials": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"dns_provider_credentials": {
|
"dns_provider": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"letsencrypt_certificate": {
|
"letsencrypt_certificate": {
|
||||||
@@ -69,6 +72,9 @@
|
|||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 0
|
"minimum": 0
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"dns_challenge": false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
23
backend/schema/components/check-version-object.json
Normal file
23
backend/schema/components/check-version-object.json
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"description": "Check Version object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": ["current", "latest", "update_available"],
|
||||||
|
"properties": {
|
||||||
|
"current": {
|
||||||
|
"type": ["string", "null"],
|
||||||
|
"description": "Current version string",
|
||||||
|
"example": "v2.10.1"
|
||||||
|
},
|
||||||
|
"latest": {
|
||||||
|
"type": ["string", "null"],
|
||||||
|
"description": "Latest version string",
|
||||||
|
"example": "v2.13.4"
|
||||||
|
},
|
||||||
|
"update_available": {
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Whether there's an update available",
|
||||||
|
"example": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -35,13 +35,30 @@
|
|||||||
"$ref": "../common.json#/properties/http2_support"
|
"$ref": "../common.json#/properties/http2_support"
|
||||||
},
|
},
|
||||||
"advanced_config": {
|
"advanced_config": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": ""
|
||||||
},
|
},
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"$ref": "../common.json#/properties/enabled"
|
"$ref": "../common.json#/properties/enabled"
|
||||||
},
|
},
|
||||||
"meta": {
|
"meta": {
|
||||||
"type": "object"
|
"type": "object",
|
||||||
|
"example": {}
|
||||||
|
},
|
||||||
|
"certificate": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null",
|
||||||
|
"example": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "./certificate-object.json"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"example": null
|
||||||
|
},
|
||||||
|
"owner": {
|
||||||
|
"$ref": "./user-object.json"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,10 +5,12 @@
|
|||||||
"required": ["code", "message"],
|
"required": ["code", "message"],
|
||||||
"properties": {
|
"properties": {
|
||||||
"code": {
|
"code": {
|
||||||
"type": "integer"
|
"type": "integer",
|
||||||
|
"example": 400
|
||||||
},
|
},
|
||||||
"message": {
|
"message": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "Bad Request"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,15 +27,18 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"major": {
|
"major": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 0
|
"minimum": 0,
|
||||||
|
"example": 2
|
||||||
},
|
},
|
||||||
"minor": {
|
"minor": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 0
|
"minimum": 0,
|
||||||
|
"example": 10
|
||||||
},
|
},
|
||||||
"revision": {
|
"revision": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 0
|
"minimum": 0,
|
||||||
|
"example": 1
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,37 +5,44 @@
|
|||||||
"visibility": {
|
"visibility": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Visibility Type",
|
"description": "Visibility Type",
|
||||||
"enum": ["all", "user"]
|
"enum": ["all", "user"],
|
||||||
|
"example": "all"
|
||||||
},
|
},
|
||||||
"access_lists": {
|
"access_lists": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Access Lists Permissions",
|
"description": "Access Lists Permissions",
|
||||||
"enum": ["hidden", "view", "manage"]
|
"enum": ["hidden", "view", "manage"],
|
||||||
|
"example": "view"
|
||||||
},
|
},
|
||||||
"dead_hosts": {
|
"dead_hosts": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "404 Hosts Permissions",
|
"description": "404 Hosts Permissions",
|
||||||
"enum": ["hidden", "view", "manage"]
|
"enum": ["hidden", "view", "manage"],
|
||||||
|
"example": "manage"
|
||||||
},
|
},
|
||||||
"proxy_hosts": {
|
"proxy_hosts": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Proxy Hosts Permissions",
|
"description": "Proxy Hosts Permissions",
|
||||||
"enum": ["hidden", "view", "manage"]
|
"enum": ["hidden", "view", "manage"],
|
||||||
|
"example": "hidden"
|
||||||
},
|
},
|
||||||
"redirection_hosts": {
|
"redirection_hosts": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Redirection Permissions",
|
"description": "Redirection Permissions",
|
||||||
"enum": ["hidden", "view", "manage"]
|
"enum": ["hidden", "view", "manage"],
|
||||||
|
"example": "view"
|
||||||
},
|
},
|
||||||
"streams": {
|
"streams": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Streams Permissions",
|
"description": "Streams Permissions",
|
||||||
"enum": ["hidden", "view", "manage"]
|
"enum": ["hidden", "view", "manage"],
|
||||||
|
"example": "manage"
|
||||||
},
|
},
|
||||||
"certificates": {
|
"certificates": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Certificates Permissions",
|
"description": "Certificates Permissions",
|
||||||
"enum": ["hidden", "view", "manage"]
|
"enum": ["hidden", "view", "manage"],
|
||||||
|
"example": "hidden"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,7 +24,6 @@
|
|||||||
"hsts_enabled",
|
"hsts_enabled",
|
||||||
"hsts_subdomains"
|
"hsts_subdomains"
|
||||||
],
|
],
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
"properties": {
|
||||||
"id": {
|
"id": {
|
||||||
"$ref": "../common.json#/properties/id"
|
"$ref": "../common.json#/properties/id"
|
||||||
@@ -44,12 +43,14 @@
|
|||||||
"forward_host": {
|
"forward_host": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"minLength": 1,
|
"minLength": 1,
|
||||||
"maxLength": 255
|
"maxLength": 255,
|
||||||
|
"example": "127.0.0.1"
|
||||||
},
|
},
|
||||||
"forward_port": {
|
"forward_port": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1,
|
"minimum": 1,
|
||||||
"maximum": 65535
|
"maximum": 65535,
|
||||||
|
"example": 8080
|
||||||
},
|
},
|
||||||
"access_list_id": {
|
"access_list_id": {
|
||||||
"$ref": "../common.json#/properties/access_list_id"
|
"$ref": "../common.json#/properties/access_list_id"
|
||||||
@@ -67,22 +68,28 @@
|
|||||||
"$ref": "../common.json#/properties/block_exploits"
|
"$ref": "../common.json#/properties/block_exploits"
|
||||||
},
|
},
|
||||||
"advanced_config": {
|
"advanced_config": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": ""
|
||||||
},
|
},
|
||||||
"meta": {
|
"meta": {
|
||||||
"type": "object"
|
"type": "object",
|
||||||
|
"example": {
|
||||||
|
"nginx_online": true,
|
||||||
|
"nginx_err": null
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"allow_websocket_upgrade": {
|
"allow_websocket_upgrade": {
|
||||||
"description": "Allow Websocket Upgrade for all paths",
|
"description": "Allow Websocket Upgrade for all paths",
|
||||||
"example": true,
|
"type": "boolean",
|
||||||
"type": "boolean"
|
"example": true
|
||||||
},
|
},
|
||||||
"http2_support": {
|
"http2_support": {
|
||||||
"$ref": "../common.json#/properties/http2_support"
|
"$ref": "../common.json#/properties/http2_support"
|
||||||
},
|
},
|
||||||
"forward_scheme": {
|
"forward_scheme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["http", "https"]
|
"enum": ["http", "https"],
|
||||||
|
"example": "http"
|
||||||
},
|
},
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"$ref": "../common.json#/properties/enabled"
|
"$ref": "../common.json#/properties/enabled"
|
||||||
@@ -118,7 +125,15 @@
|
|||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
|
"example": [
|
||||||
|
{
|
||||||
|
"path": "/app",
|
||||||
|
"forward_scheme": "http",
|
||||||
|
"forward_host": "example.com",
|
||||||
|
"forward_port": 80
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"hsts_enabled": {
|
"hsts_enabled": {
|
||||||
"$ref": "../common.json#/properties/hsts_enabled"
|
"$ref": "../common.json#/properties/hsts_enabled"
|
||||||
@@ -129,12 +144,14 @@
|
|||||||
"certificate": {
|
"certificate": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"type": "null"
|
"type": "null",
|
||||||
|
"example": null
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"$ref": "./certificate-object.json"
|
"$ref": "./certificate-object.json"
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"example": null
|
||||||
},
|
},
|
||||||
"owner": {
|
"owner": {
|
||||||
"$ref": "./user-object.json"
|
"$ref": "./user-object.json"
|
||||||
@@ -142,12 +159,14 @@
|
|||||||
"access_list": {
|
"access_list": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"type": "null"
|
"type": "null",
|
||||||
|
"example": null
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"$ref": "./access-list-object.json"
|
"$ref": "./access-list-object.json"
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"example": null
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,26 @@
|
|||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "Redirection Host object",
|
"description": "Redirection Host object",
|
||||||
"required": ["id", "created_on", "modified_on", "owner_user_id", "domain_names", "forward_http_code", "forward_scheme", "forward_domain_name", "preserve_path", "certificate_id", "ssl_forced", "hsts_enabled", "hsts_subdomains", "http2_support", "block_exploits", "advanced_config", "enabled", "meta"],
|
"required": [
|
||||||
|
"id",
|
||||||
|
"created_on",
|
||||||
|
"modified_on",
|
||||||
|
"owner_user_id",
|
||||||
|
"domain_names",
|
||||||
|
"forward_http_code",
|
||||||
|
"forward_scheme",
|
||||||
|
"forward_domain_name",
|
||||||
|
"preserve_path",
|
||||||
|
"certificate_id",
|
||||||
|
"ssl_forced",
|
||||||
|
"hsts_enabled",
|
||||||
|
"hsts_subdomains",
|
||||||
|
"http2_support",
|
||||||
|
"block_exploits",
|
||||||
|
"advanced_config",
|
||||||
|
"enabled",
|
||||||
|
"meta"
|
||||||
|
],
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"id": {
|
"id": {
|
||||||
@@ -21,25 +40,30 @@
|
|||||||
},
|
},
|
||||||
"forward_http_code": {
|
"forward_http_code": {
|
||||||
"description": "Redirect HTTP Status Code",
|
"description": "Redirect HTTP Status Code",
|
||||||
"example": 302,
|
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 300,
|
"minimum": 300,
|
||||||
"maximum": 308
|
"maximum": 308,
|
||||||
|
"example": 302
|
||||||
},
|
},
|
||||||
"forward_scheme": {
|
"forward_scheme": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["auto", "http", "https"]
|
"enum": [
|
||||||
|
"auto",
|
||||||
|
"http",
|
||||||
|
"https"
|
||||||
|
],
|
||||||
|
"example": "http"
|
||||||
},
|
},
|
||||||
"forward_domain_name": {
|
"forward_domain_name": {
|
||||||
"description": "Domain Name",
|
"description": "Domain Name",
|
||||||
"example": "jc21.com",
|
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^(?:[^.*]+\\.?)+[^.]$"
|
"pattern": "^(?:[^.*]+\\.?)+[^.]$",
|
||||||
|
"example": "jc21.com"
|
||||||
},
|
},
|
||||||
"preserve_path": {
|
"preserve_path": {
|
||||||
"description": "Should the path be preserved",
|
"description": "Should the path be preserved",
|
||||||
"example": true,
|
"type": "boolean",
|
||||||
"type": "boolean"
|
"example": true
|
||||||
},
|
},
|
||||||
"certificate_id": {
|
"certificate_id": {
|
||||||
"$ref": "../common.json#/properties/certificate_id"
|
"$ref": "../common.json#/properties/certificate_id"
|
||||||
@@ -60,13 +84,33 @@
|
|||||||
"$ref": "../common.json#/properties/block_exploits"
|
"$ref": "../common.json#/properties/block_exploits"
|
||||||
},
|
},
|
||||||
"advanced_config": {
|
"advanced_config": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": ""
|
||||||
},
|
},
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"$ref": "../common.json#/properties/enabled"
|
"$ref": "../common.json#/properties/enabled"
|
||||||
},
|
},
|
||||||
"meta": {
|
"meta": {
|
||||||
"type": "object"
|
"type": "object",
|
||||||
|
"example": {
|
||||||
|
"nginx_online": true,
|
||||||
|
"nginx_err": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"certificate": {
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"type": "null",
|
||||||
|
"example": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "./certificate-object.json"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"example": null
|
||||||
|
},
|
||||||
|
"owner": {
|
||||||
|
"$ref": "./user-object.json"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
{
|
{
|
||||||
"BearerAuth": {
|
"bearerAuth": {
|
||||||
"type": "http",
|
"type": "http",
|
||||||
"scheme": "bearer"
|
"scheme": "bearer",
|
||||||
|
"bearerFormat": "JWT",
|
||||||
|
"description": "JWT Bearer Token authentication"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,19 @@
|
|||||||
{
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "Stream object",
|
"description": "Stream object",
|
||||||
"required": ["id", "created_on", "modified_on", "owner_user_id", "incoming_port", "forwarding_host", "forwarding_port", "tcp_forwarding", "udp_forwarding", "enabled", "meta"],
|
"required": [
|
||||||
|
"id",
|
||||||
|
"created_on",
|
||||||
|
"modified_on",
|
||||||
|
"owner_user_id",
|
||||||
|
"incoming_port",
|
||||||
|
"forwarding_host",
|
||||||
|
"forwarding_port",
|
||||||
|
"tcp_forwarding",
|
||||||
|
"udp_forwarding",
|
||||||
|
"enabled",
|
||||||
|
"meta"
|
||||||
|
],
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"properties": {
|
"properties": {
|
||||||
"id": {
|
"id": {
|
||||||
@@ -19,15 +31,16 @@
|
|||||||
"incoming_port": {
|
"incoming_port": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1,
|
"minimum": 1,
|
||||||
"maximum": 65535
|
"maximum": 65535,
|
||||||
|
"example": 9090
|
||||||
},
|
},
|
||||||
"forwarding_host": {
|
"forwarding_host": {
|
||||||
"anyOf": [
|
"anyOf": [
|
||||||
{
|
{
|
||||||
"description": "Domain Name",
|
"description": "Domain Name",
|
||||||
"example": "jc21.com",
|
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"pattern": "^(?:[^.*]+\\.?)+[^.]$"
|
"pattern": "^(?:[^.*]+\\.?)+[^.]$",
|
||||||
|
"example": "example.com"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "string",
|
"type": "string",
|
||||||
@@ -37,18 +50,22 @@
|
|||||||
"type": "string",
|
"type": "string",
|
||||||
"format": "ipv6"
|
"format": "ipv6"
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"example": "example.com"
|
||||||
},
|
},
|
||||||
"forwarding_port": {
|
"forwarding_port": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1,
|
"minimum": 1,
|
||||||
"maximum": 65535
|
"maximum": 65535,
|
||||||
|
"example": 80
|
||||||
},
|
},
|
||||||
"tcp_forwarding": {
|
"tcp_forwarding": {
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
},
|
},
|
||||||
"udp_forwarding": {
|
"udp_forwarding": {
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
},
|
},
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"$ref": "../common.json#/properties/enabled"
|
"$ref": "../common.json#/properties/enabled"
|
||||||
@@ -57,10 +74,8 @@
|
|||||||
"$ref": "../common.json#/properties/certificate_id"
|
"$ref": "../common.json#/properties/certificate_id"
|
||||||
},
|
},
|
||||||
"meta": {
|
"meta": {
|
||||||
"type": "object"
|
"type": "object",
|
||||||
},
|
"example": {}
|
||||||
"owner": {
|
|
||||||
"$ref": "./user-object.json"
|
|
||||||
},
|
},
|
||||||
"certificate": {
|
"certificate": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
@@ -70,7 +85,11 @@
|
|||||||
{
|
{
|
||||||
"$ref": "./certificate-object.json"
|
"$ref": "./certificate-object.json"
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"example": null
|
||||||
|
},
|
||||||
|
"owner": {
|
||||||
|
"$ref": "./user-object.json"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -77,37 +77,37 @@
|
|||||||
"proxy_hosts": {
|
"proxy_hosts": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Proxy Hosts access level",
|
"description": "Proxy Hosts access level",
|
||||||
"example": "all",
|
"example": "manage",
|
||||||
"pattern": "^(manage|view|hidden)$"
|
"pattern": "^(manage|view|hidden)$"
|
||||||
},
|
},
|
||||||
"redirection_hosts": {
|
"redirection_hosts": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Redirection Hosts access level",
|
"description": "Redirection Hosts access level",
|
||||||
"example": "all",
|
"example": "manage",
|
||||||
"pattern": "^(manage|view|hidden)$"
|
"pattern": "^(manage|view|hidden)$"
|
||||||
},
|
},
|
||||||
"dead_hosts": {
|
"dead_hosts": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Dead Hosts access level",
|
"description": "Dead Hosts access level",
|
||||||
"example": "all",
|
"example": "manage",
|
||||||
"pattern": "^(manage|view|hidden)$"
|
"pattern": "^(manage|view|hidden)$"
|
||||||
},
|
},
|
||||||
"streams": {
|
"streams": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Streams access level",
|
"description": "Streams access level",
|
||||||
"example": "all",
|
"example": "manage",
|
||||||
"pattern": "^(manage|view|hidden)$"
|
"pattern": "^(manage|view|hidden)$"
|
||||||
},
|
},
|
||||||
"access_lists": {
|
"access_lists": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Access Lists access level",
|
"description": "Access Lists access level",
|
||||||
"example": "all",
|
"example": "hidden",
|
||||||
"pattern": "^(manage|view|hidden)$"
|
"pattern": "^(manage|view|hidden)$"
|
||||||
},
|
},
|
||||||
"certificates": {
|
"certificates": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "Certificates access level",
|
"description": "Certificates access level",
|
||||||
"example": "all",
|
"example": "view",
|
||||||
"pattern": "^(manage|view|hidden)$"
|
"pattern": "^(manage|view|hidden)$"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getAuditLogs",
|
"operationId": "getAuditLogs",
|
||||||
"summary": "Get Audit Logs",
|
"summary": "Get Audit Logs",
|
||||||
"tags": ["Audit Log"],
|
"tags": ["audit-log"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["audit-log"]
|
"bearerAuth": ["admin"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
|
|||||||
@@ -1,13 +1,11 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getAuditLog",
|
"operationId": "getAuditLog",
|
||||||
"summary": "Get Audit Log Event",
|
"summary": "Get Audit Log Event",
|
||||||
"tags": [
|
"tags": ["audit-log"],
|
||||||
"Audit Log"
|
|
||||||
],
|
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": [
|
"bearerAuth": [
|
||||||
"audit-log"
|
"admin"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@@ -15,6 +13,7 @@
|
|||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "id",
|
"name": "id",
|
||||||
|
"description": "Audit Log Event ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"operationId": "health",
|
"operationId": "health",
|
||||||
"summary": "Returns the API health status",
|
"summary": "Returns the API health status",
|
||||||
"tags": ["Public"],
|
"tags": ["public"],
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": "200 response",
|
"description": "200 response",
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getAccessLists",
|
"operationId": "getAccessLists",
|
||||||
"summary": "Get all access lists",
|
"summary": "Get all access lists",
|
||||||
"tags": ["Access Lists"],
|
"tags": ["access-lists"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["access_lists"]
|
"bearerAuth": [
|
||||||
|
"access_lists.view"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -14,7 +16,12 @@
|
|||||||
"description": "Expansions",
|
"description": "Expansions",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["owner", "items", "clients", "proxy_hosts"]
|
"enum": [
|
||||||
|
"owner",
|
||||||
|
"items",
|
||||||
|
"clients",
|
||||||
|
"proxy_hosts"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@@ -23,22 +30,16 @@
|
|||||||
"description": "200 response",
|
"description": "200 response",
|
||||||
"content": {
|
"content": {
|
||||||
"application/json": {
|
"application/json": {
|
||||||
"examples": {
|
"example": {
|
||||||
"default": {
|
"id": 1,
|
||||||
"value": [
|
"created_on": "2024-10-08T22:15:40.000Z",
|
||||||
{
|
"modified_on": "2024-10-08T22:15:40.000Z",
|
||||||
"id": 1,
|
"owner_user_id": 1,
|
||||||
"created_on": "2024-10-08T22:15:40.000Z",
|
"name": "test1234",
|
||||||
"modified_on": "2024-10-08T22:15:40.000Z",
|
"meta": {},
|
||||||
"owner_user_id": 1,
|
"satisfy_any": true,
|
||||||
"name": "test1234",
|
"pass_auth": false,
|
||||||
"meta": {},
|
"proxy_host_count": 0
|
||||||
"satisfy_any": true,
|
|
||||||
"pass_auth": false,
|
|
||||||
"proxy_host_count": 0
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../../../components/access-list-object.json"
|
"$ref": "../../../components/access-list-object.json"
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "deleteAccessList",
|
"operationId": "deleteAccessList",
|
||||||
"summary": "Delete a Access List",
|
"summary": "Delete a Access List",
|
||||||
"tags": ["Access Lists"],
|
"tags": ["access-lists"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["access_lists"]
|
"bearerAuth": ["access_lists.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "listID",
|
"name": "listID",
|
||||||
|
"description": "Access List ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,49 +1,54 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getAccessList",
|
"operationId": "getAccessList",
|
||||||
"summary": "Get a access List",
|
"summary": "Get a access List",
|
||||||
"tags": ["Access Lists"],
|
"tags": [
|
||||||
"security": [
|
"access-lists"
|
||||||
{
|
],
|
||||||
"BearerAuth": ["access_lists"]
|
"security": [
|
||||||
}
|
{
|
||||||
],
|
"bearerAuth": [
|
||||||
"parameters": [
|
"access_lists.view"
|
||||||
{
|
]
|
||||||
"in": "path",
|
}
|
||||||
"name": "listID",
|
],
|
||||||
"schema": {
|
"parameters": [
|
||||||
"type": "integer",
|
{
|
||||||
"minimum": 1
|
"in": "path",
|
||||||
},
|
"name": "listID",
|
||||||
"required": true,
|
"description": "Access List ID",
|
||||||
"example": 1
|
"schema": {
|
||||||
}
|
"type": "integer",
|
||||||
],
|
"minimum": 1
|
||||||
"responses": {
|
},
|
||||||
"200": {
|
"required": true,
|
||||||
"description": "200 response",
|
"example": 1
|
||||||
"content": {
|
}
|
||||||
"application/json": {
|
],
|
||||||
"examples": {
|
"responses": {
|
||||||
"default": {
|
"200": {
|
||||||
"value": {
|
"description": "200 response",
|
||||||
"id": 1,
|
"content": {
|
||||||
"created_on": "2020-01-30T09:36:08.000Z",
|
"application/json": {
|
||||||
"modified_on": "2020-01-30T09:41:04.000Z",
|
"examples": {
|
||||||
"is_disabled": false,
|
"default": {
|
||||||
"email": "jc@jc21.com",
|
"value": {
|
||||||
"name": "Jamie Curnow",
|
"id": 1,
|
||||||
"nickname": "James",
|
"created_on": "2025-10-28T04:06:55.000Z",
|
||||||
"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
|
"modified_on": "2025-10-29T22:48:20.000Z",
|
||||||
"roles": ["admin"]
|
"owner_user_id": 1,
|
||||||
}
|
"name": "My Access List",
|
||||||
}
|
"meta": {},
|
||||||
},
|
"satisfy_any": false,
|
||||||
"schema": {
|
"pass_auth": false,
|
||||||
"$ref": "../../../../components/access-list-object.json"
|
"proxy_host_count": 1
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"schema": {
|
||||||
}
|
"$ref": "../../../../components/access-list-object.json"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "updateAccessList",
|
"operationId": "updateAccessList",
|
||||||
"summary": "Update a Access List",
|
"summary": "Update a Access List",
|
||||||
"tags": ["Access Lists"],
|
"tags": ["access-lists"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["access_lists"]
|
"bearerAuth": ["access_lists.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "listID",
|
"name": "listID",
|
||||||
|
"description": "Access List ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
@@ -39,50 +40,29 @@
|
|||||||
"$ref": "../../../../components/access-list-object.json#/properties/pass_auth"
|
"$ref": "../../../../components/access-list-object.json#/properties/pass_auth"
|
||||||
},
|
},
|
||||||
"items": {
|
"items": {
|
||||||
"type": "array",
|
"$ref": "../../../../common.json#/properties/access_items"
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"username": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 1
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"clients": {
|
"clients": {
|
||||||
"type": "array",
|
"$ref": "../../../../common.json#/properties/access_clients"
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"address": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))?$"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^all$"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"directive": {
|
|
||||||
"$ref": "../../../../components/access-list-object.json#/properties/directive"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"name": "My Access List",
|
||||||
|
"satisfy_any": true,
|
||||||
|
"pass_auth": false,
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"username": "admin2",
|
||||||
|
"password": "pass2"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"clients": [
|
||||||
|
{
|
||||||
|
"directive": "allow",
|
||||||
|
"address": "192.168.0.0/24"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -108,7 +88,6 @@
|
|||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-07T22:43:55.000Z",
|
"created_on": "2024-10-07T22:43:55.000Z",
|
||||||
"modified_on": "2024-10-08T12:52:54.000Z",
|
"modified_on": "2024-10-08T12:52:54.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "admin@example.com",
|
||||||
"name": "Administrator",
|
"name": "Administrator",
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
{
|
{
|
||||||
"operationId": "createAccessList",
|
"operationId": "createAccessList",
|
||||||
"summary": "Create a Access List",
|
"summary": "Create a Access List",
|
||||||
"tags": ["Access Lists"],
|
"tags": ["access-lists"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["access_lists"]
|
"bearerAuth": [
|
||||||
|
"access_lists.manage"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
@@ -15,7 +17,9 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["name"],
|
"required": [
|
||||||
|
"name"
|
||||||
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
"name": {
|
"name": {
|
||||||
"$ref": "../../../components/access-list-object.json#/properties/name"
|
"$ref": "../../../components/access-list-object.json#/properties/name"
|
||||||
@@ -27,54 +31,29 @@
|
|||||||
"$ref": "../../../components/access-list-object.json#/properties/pass_auth"
|
"$ref": "../../../components/access-list-object.json#/properties/pass_auth"
|
||||||
},
|
},
|
||||||
"items": {
|
"items": {
|
||||||
"type": "array",
|
"$ref": "../../../common.json#/properties/access_items"
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"username": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 1
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 1
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"clients": {
|
"clients": {
|
||||||
"type": "array",
|
"$ref": "../../../common.json#/properties/access_clients"
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
"address": {
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(/([0-9]|[1-2][0-9]|3[0-2]))?$"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "string",
|
|
||||||
"pattern": "^all$"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"directive": {
|
|
||||||
"$ref": "../../../components/access-list-object.json#/properties/directive"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"meta": {
|
|
||||||
"$ref": "../../../components/access-list-object.json#/properties/meta"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"name": "My Access List",
|
||||||
|
"satisfy_any": true,
|
||||||
|
"pass_auth": false,
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"username": "admin",
|
||||||
|
"password": "pass"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"clients": [
|
||||||
|
{
|
||||||
|
"directive": "allow",
|
||||||
|
"address": "192.168.0.0/24"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -100,13 +79,14 @@
|
|||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-07T22:43:55.000Z",
|
"created_on": "2024-10-07T22:43:55.000Z",
|
||||||
"modified_on": "2024-10-08T12:52:54.000Z",
|
"modified_on": "2024-10-08T12:52:54.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "admin@example.com",
|
||||||
"name": "Administrator",
|
"name": "Administrator",
|
||||||
"nickname": "some guy",
|
"nickname": "some guy",
|
||||||
"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
|
"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
|
||||||
"roles": ["admin"]
|
"roles": [
|
||||||
|
"admin"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"items": [
|
"items": [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "deleteCertificate",
|
"operationId": "deleteCertificate",
|
||||||
"summary": "Delete a Certificate",
|
"summary": "Delete a Certificate",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "certID",
|
"name": "certID",
|
||||||
|
"description": "Certificate ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "downloadCertificate",
|
"operationId": "downloadCertificate",
|
||||||
"summary": "Downloads a Certificate",
|
"summary": "Downloads a Certificate",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "certID",
|
"name": "certID",
|
||||||
|
"description": "Certificate ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getCertificate",
|
"operationId": "getCertificate",
|
||||||
"summary": "Get a Certificate",
|
"summary": "Get a Certificate",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.view"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "certID",
|
"name": "certID",
|
||||||
|
"description": "Certificate ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "renewCertificate",
|
"operationId": "renewCertificate",
|
||||||
"summary": "Renews a Certificate",
|
"summary": "Renews a Certificate",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "certID",
|
"name": "certID",
|
||||||
|
"description": "Certificate ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
@@ -32,7 +33,6 @@
|
|||||||
"id": 4,
|
"id": 4,
|
||||||
"created_on": "2024-10-09T05:31:58.000Z",
|
"created_on": "2024-10-09T05:31:58.000Z",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"is_deleted": false,
|
|
||||||
"provider": "letsencrypt",
|
"provider": "letsencrypt",
|
||||||
"nice_name": "My Test Cert",
|
"nice_name": "My Test Cert",
|
||||||
"domain_names": ["test.jc21.supernerd.pro"],
|
"domain_names": ["test.jc21.supernerd.pro"],
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "uploadCertificate",
|
"operationId": "uploadCertificate",
|
||||||
"summary": "Uploads a custom Certificate",
|
"summary": "Uploads a custom Certificate",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "certID",
|
"name": "certID",
|
||||||
|
"description": "Certificate ID",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
@@ -20,28 +21,7 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"description": "Certificate Files",
|
"$ref": "../../../../../common.json#/properties/certificate_files"
|
||||||
"required": true,
|
|
||||||
"content": {
|
|
||||||
"multipart/form-data": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": ["certificate", "certificate_key"],
|
|
||||||
"properties": {
|
|
||||||
"certificate": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"certificate_key": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"intermediate_certificate": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
@@ -63,15 +43,18 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"certificate": {
|
"certificate": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"minLength": 1
|
"minLength": 1,
|
||||||
|
"example": "-----BEGIN CERTIFICATE-----\nMIID...-----END CERTIFICATE-----"
|
||||||
},
|
},
|
||||||
"certificate_key": {
|
"certificate_key": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"minLength": 1
|
"minLength": 1,
|
||||||
|
"example": "-----BEGIN CERTIFICATE-----\nMIID...-----END CERTIFICATE-----"
|
||||||
},
|
},
|
||||||
"intermediate_certificate": {
|
"intermediate_certificate": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"minLength": 1
|
"minLength": 1,
|
||||||
|
"example": "-----BEGIN CERTIFICATE-----\nMIID...-----END CERTIFICATE-----"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,10 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getDNSProviders",
|
"operationId": "getDNSProviders",
|
||||||
"summary": "Get DNS Providers for Certificates",
|
"summary": "Get DNS Providers for Certificates",
|
||||||
"tags": [
|
"tags": ["certificates"],
|
||||||
"Certificates"
|
|
||||||
],
|
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": [
|
"bearerAuth": ["certificates.view"]
|
||||||
"certificates"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getCertificates",
|
"operationId": "getCertificates",
|
||||||
"summary": "Get all certificates",
|
"summary": "Get all certificates",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.view"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"operationId": "createCertificate",
|
"operationId": "createCertificate",
|
||||||
"summary": "Create a Certificate",
|
"summary": "Create a Certificate",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
@@ -30,6 +30,13 @@
|
|||||||
"$ref": "../../../components/certificate-object.json#/properties/meta"
|
"$ref": "../../../components/certificate-object.json#/properties/meta"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"provider": "letsencrypt",
|
||||||
|
"domain_names": ["test.example.com"],
|
||||||
|
"meta": {
|
||||||
|
"dns_challenge": false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -47,7 +54,6 @@
|
|||||||
"id": 5,
|
"id": 5,
|
||||||
"created_on": "2024-10-09 05:28:35",
|
"created_on": "2024-10-09 05:28:35",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"is_deleted": false,
|
|
||||||
"provider": "letsencrypt",
|
"provider": "letsencrypt",
|
||||||
"nice_name": "test.example.com",
|
"nice_name": "test.example.com",
|
||||||
"domain_names": ["test.example.com"],
|
"domain_names": ["test.example.com"],
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"operationId": "testHttpReach",
|
"operationId": "testHttpReach",
|
||||||
"summary": "Test HTTP Reachability",
|
"summary": "Test HTTP Reachability",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.view"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
|
|||||||
@@ -1,35 +1,14 @@
|
|||||||
{
|
{
|
||||||
"operationId": "validateCertificates",
|
"operationId": "validateCertificates",
|
||||||
"summary": "Validates given Custom Certificates",
|
"summary": "Validates given Custom Certificates",
|
||||||
"tags": ["Certificates"],
|
"tags": ["certificates"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["certificates"]
|
"bearerAuth": ["certificates.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"description": "Certificate Files",
|
"$ref": "../../../../common.json#/properties/certificate_files"
|
||||||
"required": true,
|
|
||||||
"content": {
|
|
||||||
"multipart/form-data": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"required": ["certificate", "certificate_key"],
|
|
||||||
"properties": {
|
|
||||||
"certificate": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"certificate_key": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"intermediate_certificate": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
@@ -62,10 +41,12 @@
|
|||||||
"required": ["cn", "issuer", "dates"],
|
"required": ["cn", "issuer", "dates"],
|
||||||
"properties": {
|
"properties": {
|
||||||
"cn": {
|
"cn": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "example.com"
|
||||||
},
|
},
|
||||||
"issuer": {
|
"issuer": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
|
"example": "C = US, O = Let's Encrypt, CN = E5"
|
||||||
},
|
},
|
||||||
"dates": {
|
"dates": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@@ -78,12 +59,17 @@
|
|||||||
"to": {
|
"to": {
|
||||||
"type": "integer"
|
"type": "integer"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"from": 1728448218,
|
||||||
|
"to": 1736224217
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"certificate_key": {
|
"certificate_key": {
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"example": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getDeadHosts",
|
"operationId": "getDeadHosts",
|
||||||
"summary": "Get all 404 hosts",
|
"summary": "Get all 404 hosts",
|
||||||
"tags": ["404 Hosts"],
|
"tags": ["404-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["dead_hosts"]
|
"bearerAuth": ["dead_hosts.view"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "deleteDeadHost",
|
"operationId": "deleteDeadHost",
|
||||||
"summary": "Delete a 404 Host",
|
"summary": "Delete a 404 Host",
|
||||||
"tags": ["404 Hosts"],
|
"tags": ["404-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["dead_hosts"]
|
"bearerAuth": ["dead_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the 404 Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "disableDeadHost",
|
"operationId": "disableDeadHost",
|
||||||
"summary": "Disable a 404 Host",
|
"summary": "Disable a 404 Host",
|
||||||
"tags": ["404 Hosts"],
|
"tags": ["404-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["dead_hosts"]
|
"bearerAuth": ["dead_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the 404 Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "enableDeadHost",
|
"operationId": "enableDeadHost",
|
||||||
"summary": "Enable a 404 Host",
|
"summary": "Enable a 404 Host",
|
||||||
"tags": ["404 Hosts"],
|
"tags": ["404-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["dead_hosts"]
|
"bearerAuth": ["dead_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the 404 Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getDeadHost",
|
"operationId": "getDeadHost",
|
||||||
"summary": "Get a 404 Host",
|
"summary": "Get a 404 Host",
|
||||||
"tags": ["404 Hosts"],
|
"tags": ["404-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["dead_hosts"]
|
"bearerAuth": ["dead_hosts.view"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the 404 Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "updateDeadHost",
|
"operationId": "updateDeadHost",
|
||||||
"summary": "Update a 404 Host",
|
"summary": "Update a 404 Host",
|
||||||
"tags": ["404 Hosts"],
|
"tags": ["404-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["dead_hosts"]
|
"bearerAuth": ["dead_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the 404 Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
@@ -86,7 +87,6 @@
|
|||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-09T00:59:56.000Z",
|
"created_on": "2024-10-09T00:59:56.000Z",
|
||||||
"modified_on": "2024-10-09T00:59:56.000Z",
|
"modified_on": "2024-10-09T00:59:56.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "admin@example.com",
|
||||||
"name": "Administrator",
|
"name": "Administrator",
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
{
|
{
|
||||||
"operationId": "create404Host",
|
"operationId": "create404Host",
|
||||||
"summary": "Create a 404 Host",
|
"summary": "Create a 404 Host",
|
||||||
"tags": ["404 Hosts"],
|
"tags": ["404-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["dead_hosts"]
|
"bearerAuth": [
|
||||||
|
"dead_hosts.manage"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
@@ -15,7 +17,9 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["domain_names"],
|
"required": [
|
||||||
|
"domain_names"
|
||||||
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
"domain_names": {
|
"domain_names": {
|
||||||
"$ref": "../../../components/dead-host-object.json#/properties/domain_names"
|
"$ref": "../../../components/dead-host-object.json#/properties/domain_names"
|
||||||
@@ -42,6 +46,18 @@
|
|||||||
"$ref": "../../../components/dead-host-object.json#/properties/meta"
|
"$ref": "../../../components/dead-host-object.json#/properties/meta"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"domain_names": [
|
||||||
|
"test.example.com"
|
||||||
|
],
|
||||||
|
"certificate_id": 0,
|
||||||
|
"ssl_forced": false,
|
||||||
|
"advanced_config": "",
|
||||||
|
"http2_support": false,
|
||||||
|
"hsts_enabled": false,
|
||||||
|
"hsts_subdomains": false,
|
||||||
|
"meta": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -58,7 +74,9 @@
|
|||||||
"created_on": "2024-10-09T01:38:52.000Z",
|
"created_on": "2024-10-09T01:38:52.000Z",
|
||||||
"modified_on": "2024-10-09T01:38:52.000Z",
|
"modified_on": "2024-10-09T01:38:52.000Z",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"domain_names": ["test.example.com"],
|
"domain_names": [
|
||||||
|
"test.example.com"
|
||||||
|
],
|
||||||
"certificate_id": 0,
|
"certificate_id": 0,
|
||||||
"ssl_forced": false,
|
"ssl_forced": false,
|
||||||
"advanced_config": "",
|
"advanced_config": "",
|
||||||
@@ -72,13 +90,14 @@
|
|||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-09T00:59:56.000Z",
|
"created_on": "2024-10-09T00:59:56.000Z",
|
||||||
"modified_on": "2024-10-09T00:59:56.000Z",
|
"modified_on": "2024-10-09T00:59:56.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "admin@example.com",
|
||||||
"name": "Administrator",
|
"name": "Administrator",
|
||||||
"nickname": "Admin",
|
"nickname": "Admin",
|
||||||
"avatar": "",
|
"avatar": "",
|
||||||
"roles": ["admin"]
|
"roles": [
|
||||||
|
"admin"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getProxyHosts",
|
"operationId": "getProxyHosts",
|
||||||
"summary": "Get all proxy hosts",
|
"summary": "Get all proxy hosts",
|
||||||
"tags": ["Proxy Hosts"],
|
"tags": ["proxy-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["proxy_hosts"]
|
"bearerAuth": [
|
||||||
|
"proxy_hosts.view"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
@@ -14,7 +16,11 @@
|
|||||||
"description": "Expansions",
|
"description": "Expansions",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["access_list", "owner", "certificate"]
|
"enum": [
|
||||||
|
"access_list",
|
||||||
|
"owner",
|
||||||
|
"certificate"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@@ -28,14 +34,16 @@
|
|||||||
"value": [
|
"value": [
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-08T23:23:03.000Z",
|
"created_on": "2025-10-28T01:10:26.000Z",
|
||||||
"modified_on": "2024-10-08T23:23:04.000Z",
|
"modified_on": "2025-10-28T04:07:16.000Z",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"domain_names": ["test.example.com"],
|
"domain_names": [
|
||||||
|
"test.jc21com"
|
||||||
|
],
|
||||||
"forward_host": "127.0.0.1",
|
"forward_host": "127.0.0.1",
|
||||||
"forward_port": 8989,
|
"forward_port": 8081,
|
||||||
"access_list_id": 0,
|
"access_list_id": 1,
|
||||||
"certificate_id": 0,
|
"certificate_id": 1,
|
||||||
"ssl_forced": false,
|
"ssl_forced": false,
|
||||||
"caching_enabled": false,
|
"caching_enabled": false,
|
||||||
"block_exploits": false,
|
"block_exploits": false,
|
||||||
@@ -48,7 +56,7 @@
|
|||||||
"http2_support": false,
|
"http2_support": false,
|
||||||
"forward_scheme": "http",
|
"forward_scheme": "http",
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"locations": null,
|
"locations": [],
|
||||||
"hsts_enabled": false,
|
"hsts_enabled": false,
|
||||||
"hsts_subdomains": false
|
"hsts_subdomains": false
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "deleteProxyHost",
|
"operationId": "deleteProxyHost",
|
||||||
"summary": "Delete a Proxy Host",
|
"summary": "Delete a Proxy Host",
|
||||||
"tags": ["Proxy Hosts"],
|
"tags": ["proxy-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["proxy_hosts"]
|
"bearerAuth": ["proxy_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Proxy Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "disableProxyHost",
|
"operationId": "disableProxyHost",
|
||||||
"summary": "Disable a Proxy Host",
|
"summary": "Disable a Proxy Host",
|
||||||
"tags": ["Proxy Hosts"],
|
"tags": ["proxy-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["proxy_hosts"]
|
"bearerAuth": ["proxy_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Proxy Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "enableProxyHost",
|
"operationId": "enableProxyHost",
|
||||||
"summary": "Enable a Proxy Host",
|
"summary": "Enable a Proxy Host",
|
||||||
"tags": ["Proxy Hosts"],
|
"tags": ["proxy-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["proxy_hosts"]
|
"bearerAuth": ["proxy_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Proxy Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,19 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getProxyHost",
|
"operationId": "getProxyHost",
|
||||||
"summary": "Get a Proxy Host",
|
"summary": "Get a Proxy Host",
|
||||||
"tags": ["Proxy Hosts"],
|
"tags": ["proxy-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["proxy_hosts"]
|
"bearerAuth": [
|
||||||
|
"proxy_hosts.view"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Proxy Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
@@ -27,13 +30,15 @@
|
|||||||
"examples": {
|
"examples": {
|
||||||
"default": {
|
"default": {
|
||||||
"value": {
|
"value": {
|
||||||
"id": 1,
|
"id": 3,
|
||||||
"created_on": "2024-10-08T23:23:03.000Z",
|
"created_on": "2025-10-30T01:12:05.000Z",
|
||||||
"modified_on": "2024-10-08T23:26:38.000Z",
|
"modified_on": "2025-10-30T01:12:05.000Z",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"domain_names": ["test.example.com"],
|
"domain_names": [
|
||||||
"forward_host": "192.168.0.10",
|
"test.example.com"
|
||||||
"forward_port": 8989,
|
],
|
||||||
|
"forward_host": "127.0.0.1",
|
||||||
|
"forward_port": 8080,
|
||||||
"access_list_id": 0,
|
"access_list_id": 0,
|
||||||
"certificate_id": 0,
|
"certificate_id": 0,
|
||||||
"ssl_forced": false,
|
"ssl_forced": false,
|
||||||
@@ -48,9 +53,22 @@
|
|||||||
"http2_support": false,
|
"http2_support": false,
|
||||||
"forward_scheme": "http",
|
"forward_scheme": "http",
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"locations": null,
|
"locations": [],
|
||||||
"hsts_enabled": false,
|
"hsts_enabled": false,
|
||||||
"hsts_subdomains": false
|
"hsts_subdomains": false,
|
||||||
|
"owner": {
|
||||||
|
"id": 1,
|
||||||
|
"created_on": "2025-10-28T00:50:24.000Z",
|
||||||
|
"modified_on": "2025-10-28T00:50:24.000Z",
|
||||||
|
"is_disabled": false,
|
||||||
|
"email": "jc@jc21.com",
|
||||||
|
"name": "jamiec",
|
||||||
|
"nickname": "jamiec",
|
||||||
|
"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
|
||||||
|
"roles": [
|
||||||
|
"admin"
|
||||||
|
]
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,16 +1,19 @@
|
|||||||
{
|
{
|
||||||
"operationId": "updateProxyHost",
|
"operationId": "updateProxyHost",
|
||||||
"summary": "Update a Proxy Host",
|
"summary": "Update a Proxy Host",
|
||||||
"tags": ["Proxy Hosts"],
|
"tags": ["proxy-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["proxy_hosts"]
|
"bearerAuth": [
|
||||||
|
"proxy_hosts.manage"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Proxy Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
@@ -93,13 +96,15 @@
|
|||||||
"examples": {
|
"examples": {
|
||||||
"default": {
|
"default": {
|
||||||
"value": {
|
"value": {
|
||||||
"id": 1,
|
"id": 3,
|
||||||
"created_on": "2024-10-08T23:23:03.000Z",
|
"created_on": "2025-10-30T01:12:05.000Z",
|
||||||
"modified_on": "2024-10-08T23:26:37.000Z",
|
"modified_on": "2025-10-30T01:17:06.000Z",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"domain_names": ["test.example.com"],
|
"domain_names": [
|
||||||
"forward_host": "192.168.0.10",
|
"test.example.com"
|
||||||
"forward_port": 8989,
|
],
|
||||||
|
"forward_host": "127.0.0.1",
|
||||||
|
"forward_port": 8080,
|
||||||
"access_list_id": 0,
|
"access_list_id": 0,
|
||||||
"certificate_id": 0,
|
"certificate_id": 0,
|
||||||
"ssl_forced": false,
|
"ssl_forced": false,
|
||||||
@@ -114,19 +119,21 @@
|
|||||||
"http2_support": false,
|
"http2_support": false,
|
||||||
"forward_scheme": "http",
|
"forward_scheme": "http",
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
|
"locations": [],
|
||||||
"hsts_enabled": false,
|
"hsts_enabled": false,
|
||||||
"hsts_subdomains": false,
|
"hsts_subdomains": false,
|
||||||
"owner": {
|
"owner": {
|
||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-07T22:43:55.000Z",
|
"created_on": "2025-10-28T00:50:24.000Z",
|
||||||
"modified_on": "2024-10-08T12:52:54.000Z",
|
"modified_on": "2025-10-28T00:50:24.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "jc@jc21.com",
|
||||||
"name": "Administrator",
|
"name": "jamiec",
|
||||||
"nickname": "some guy",
|
"nickname": "jamiec",
|
||||||
"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
|
"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
|
||||||
"roles": ["admin"]
|
"roles": [
|
||||||
|
"admin"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"certificate": null,
|
"certificate": null,
|
||||||
"access_list": null
|
"access_list": null
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
{
|
{
|
||||||
"operationId": "createProxyHost",
|
"operationId": "createProxyHost",
|
||||||
"summary": "Create a Proxy Host",
|
"summary": "Create a Proxy Host",
|
||||||
"tags": ["Proxy Hosts"],
|
"tags": ["proxy-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["proxy_hosts"]
|
"bearerAuth": [
|
||||||
|
"proxy_hosts.manage"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
@@ -15,7 +17,12 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["domain_names", "forward_scheme", "forward_host", "forward_port"],
|
"required": [
|
||||||
|
"domain_names",
|
||||||
|
"forward_scheme",
|
||||||
|
"forward_host",
|
||||||
|
"forward_port"
|
||||||
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
"domain_names": {
|
"domain_names": {
|
||||||
"$ref": "../../../components/proxy-host-object.json#/properties/domain_names"
|
"$ref": "../../../components/proxy-host-object.json#/properties/domain_names"
|
||||||
@@ -69,6 +76,14 @@
|
|||||||
"$ref": "../../../components/proxy-host-object.json#/properties/locations"
|
"$ref": "../../../components/proxy-host-object.json#/properties/locations"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"domain_names": [
|
||||||
|
"test.example.com"
|
||||||
|
],
|
||||||
|
"forward_scheme": "http",
|
||||||
|
"forward_host": "127.0.0.1",
|
||||||
|
"forward_port": 8080
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -81,13 +96,15 @@
|
|||||||
"examples": {
|
"examples": {
|
||||||
"default": {
|
"default": {
|
||||||
"value": {
|
"value": {
|
||||||
"id": 1,
|
"id": 3,
|
||||||
"created_on": "2024-10-08T23:23:03.000Z",
|
"created_on": "2025-10-30T01:12:05.000Z",
|
||||||
"modified_on": "2024-10-08T23:23:03.000Z",
|
"modified_on": "2025-10-30T01:12:05.000Z",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"domain_names": ["test.example.com"],
|
"domain_names": [
|
||||||
|
"test.example.com"
|
||||||
|
],
|
||||||
"forward_host": "127.0.0.1",
|
"forward_host": "127.0.0.1",
|
||||||
"forward_port": 8989,
|
"forward_port": 8080,
|
||||||
"access_list_id": 0,
|
"access_list_id": 0,
|
||||||
"certificate_id": 0,
|
"certificate_id": 0,
|
||||||
"ssl_forced": false,
|
"ssl_forced": false,
|
||||||
@@ -99,20 +116,22 @@
|
|||||||
"http2_support": false,
|
"http2_support": false,
|
||||||
"forward_scheme": "http",
|
"forward_scheme": "http",
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
|
"locations": [],
|
||||||
"hsts_enabled": false,
|
"hsts_enabled": false,
|
||||||
"hsts_subdomains": false,
|
"hsts_subdomains": false,
|
||||||
"certificate": null,
|
"certificate": null,
|
||||||
"owner": {
|
"owner": {
|
||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-07T22:43:55.000Z",
|
"created_on": "2025-10-28T00:50:24.000Z",
|
||||||
"modified_on": "2024-10-08T12:52:54.000Z",
|
"modified_on": "2025-10-28T00:50:24.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "jc@jc21.com",
|
||||||
"name": "Administrator",
|
"name": "jamiec",
|
||||||
"nickname": "some guy",
|
"nickname": "jamiec",
|
||||||
"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
|
"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
|
||||||
"roles": ["admin"]
|
"roles": [
|
||||||
|
"admin"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"access_list": null
|
"access_list": null
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getRedirectionHosts",
|
"operationId": "getRedirectionHosts",
|
||||||
"summary": "Get all Redirection hosts",
|
"summary": "Get all Redirection hosts",
|
||||||
"tags": ["Redirection Hosts"],
|
"tags": ["redirection-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["redirection_hosts"]
|
"bearerAuth": ["redirection_hosts.view"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "deleteRedirectionHost",
|
"operationId": "deleteRedirectionHost",
|
||||||
"summary": "Delete a Redirection Host",
|
"summary": "Delete a Redirection Host",
|
||||||
"tags": ["Redirection Hosts"],
|
"tags": ["redirection-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["redirection_hosts"]
|
"bearerAuth": ["redirection_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Redirection Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "disableRedirectionHost",
|
"operationId": "disableRedirectionHost",
|
||||||
"summary": "Disable a Redirection Host",
|
"summary": "Disable a Redirection Host",
|
||||||
"tags": ["Redirection Hosts"],
|
"tags": ["redirection-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["redirection_hosts"]
|
"bearerAuth": ["redirection_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Redirection Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "enableRedirectionHost",
|
"operationId": "enableRedirectionHost",
|
||||||
"summary": "Enable a Redirection Host",
|
"summary": "Enable a Redirection Host",
|
||||||
"tags": ["Redirection Hosts"],
|
"tags": ["redirection-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["redirection_hosts"]
|
"bearerAuth": ["redirection_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Redirection Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "getRedirectionHost",
|
"operationId": "getRedirectionHost",
|
||||||
"summary": "Get a Redirection Host",
|
"summary": "Get a Redirection Host",
|
||||||
"tags": ["Redirection Hosts"],
|
"tags": ["redirection-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["redirection_hosts"]
|
"bearerAuth": ["redirection_hosts.view"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Redirection Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
|
|||||||
@@ -1,16 +1,17 @@
|
|||||||
{
|
{
|
||||||
"operationId": "updateRedirectionHost",
|
"operationId": "updateRedirectionHost",
|
||||||
"summary": "Update a Redirection Host",
|
"summary": "Update a Redirection Host",
|
||||||
"tags": ["Redirection Hosts"],
|
"tags": ["redirection-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["redirection_hosts"]
|
"bearerAuth": ["redirection_hosts.manage"]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"in": "path",
|
"in": "path",
|
||||||
"name": "hostID",
|
"name": "hostID",
|
||||||
|
"description": "The ID of the Redirection Host",
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
"minimum": 1
|
"minimum": 1
|
||||||
@@ -106,7 +107,6 @@
|
|||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-09T00:59:56.000Z",
|
"created_on": "2024-10-09T00:59:56.000Z",
|
||||||
"modified_on": "2024-10-09T00:59:56.000Z",
|
"modified_on": "2024-10-09T00:59:56.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "admin@example.com",
|
||||||
"name": "Administrator",
|
"name": "Administrator",
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
{
|
{
|
||||||
"operationId": "createRedirectionHost",
|
"operationId": "createRedirectionHost",
|
||||||
"summary": "Create a Redirection Host",
|
"summary": "Create a Redirection Host",
|
||||||
"tags": ["Redirection Hosts"],
|
"tags": ["redirection-hosts"],
|
||||||
"security": [
|
"security": [
|
||||||
{
|
{
|
||||||
"BearerAuth": ["redirection_hosts"]
|
"bearerAuth": [
|
||||||
|
"redirection_hosts.manage"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
@@ -15,7 +17,12 @@
|
|||||||
"schema": {
|
"schema": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"required": ["domain_names", "forward_scheme", "forward_http_code", "forward_domain_name"],
|
"required": [
|
||||||
|
"domain_names",
|
||||||
|
"forward_scheme",
|
||||||
|
"forward_http_code",
|
||||||
|
"forward_domain_name"
|
||||||
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
"domain_names": {
|
"domain_names": {
|
||||||
"$ref": "../../../components/redirection-host-object.json#/properties/domain_names"
|
"$ref": "../../../components/redirection-host-object.json#/properties/domain_names"
|
||||||
@@ -57,6 +64,23 @@
|
|||||||
"$ref": "../../../components/redirection-host-object.json#/properties/meta"
|
"$ref": "../../../components/redirection-host-object.json#/properties/meta"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"domain_names": [
|
||||||
|
"test.example.com"
|
||||||
|
],
|
||||||
|
"forward_domain_name": "example.com",
|
||||||
|
"forward_scheme": "auto",
|
||||||
|
"forward_http_code": 301,
|
||||||
|
"preserve_path": false,
|
||||||
|
"block_exploits": false,
|
||||||
|
"certificate_id": 0,
|
||||||
|
"ssl_forced": false,
|
||||||
|
"http2_support": false,
|
||||||
|
"hsts_enabled": false,
|
||||||
|
"hsts_subdomains": false,
|
||||||
|
"advanced_config": "",
|
||||||
|
"meta": {}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -69,12 +93,14 @@
|
|||||||
"examples": {
|
"examples": {
|
||||||
"default": {
|
"default": {
|
||||||
"value": {
|
"value": {
|
||||||
"id": 1,
|
"id": 2,
|
||||||
"created_on": "2024-10-09T01:13:12.000Z",
|
"created_on": "2025-10-30T01:27:04.000Z",
|
||||||
"modified_on": "2024-10-09T01:13:12.000Z",
|
"modified_on": "2025-10-30T01:27:04.000Z",
|
||||||
"owner_user_id": 1,
|
"owner_user_id": 1,
|
||||||
"domain_names": ["test.example.com"],
|
"domain_names": [
|
||||||
"forward_domain_name": "something-else.com",
|
"test.example.com"
|
||||||
|
],
|
||||||
|
"forward_domain_name": "example.com",
|
||||||
"preserve_path": false,
|
"preserve_path": false,
|
||||||
"certificate_id": 0,
|
"certificate_id": 0,
|
||||||
"ssl_forced": false,
|
"ssl_forced": false,
|
||||||
@@ -85,20 +111,21 @@
|
|||||||
"enabled": true,
|
"enabled": true,
|
||||||
"hsts_enabled": false,
|
"hsts_enabled": false,
|
||||||
"hsts_subdomains": false,
|
"hsts_subdomains": false,
|
||||||
"forward_scheme": "http",
|
"forward_scheme": "auto",
|
||||||
"forward_http_code": 301,
|
"forward_http_code": 301,
|
||||||
"certificate": null,
|
"certificate": null,
|
||||||
"owner": {
|
"owner": {
|
||||||
"id": 1,
|
"id": 1,
|
||||||
"created_on": "2024-10-09T00:59:56.000Z",
|
"created_on": "2025-10-28T00:50:24.000Z",
|
||||||
"modified_on": "2024-10-09T00:59:56.000Z",
|
"modified_on": "2025-10-28T00:50:24.000Z",
|
||||||
"is_deleted": false,
|
|
||||||
"is_disabled": false,
|
"is_disabled": false,
|
||||||
"email": "admin@example.com",
|
"email": "jc@jc21.com",
|
||||||
"name": "Administrator",
|
"name": "jamiec",
|
||||||
"nickname": "Admin",
|
"nickname": "jamiec",
|
||||||
"avatar": "",
|
"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
|
||||||
"roles": ["admin"]
|
"roles": [
|
||||||
|
"admin"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user