Compare commits

...
6 Commits
Author SHA1 Message Date
thomasandClaude Opus 4.8 e28d3bf53d admin: Remove default Chinese welcome message
Build & Push Docker Image / docker (push) Failing after 13s
Empty conf/admin/hello.html so the admin dashboard no longer shows the
"你好 ... 欢迎使用 RustDesk API" welcome card by default.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 13:00:07 +02:00
thomasandClaude Opus 4.8 6dfd40a10f docs: Add self-contained docker-compose.yml.example
Build & Push Docker Image / docker (push) Failing after 13s
Full stack example (hbbs + hbbr + rustdesk-api) with everything inline:
public endpoints, a fixed Ed25519 key pair (secret on the servers, public
on the API) and the JWT key. No .env required.

The included key is an example and should be regenerated for production.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 12:46:40 +02:00
thomasandClaude Opus 4.8 05f919777f config: Default language to English (en)
Build & Push Docker Image / docker (push) Failing after 13s
Change the default app language from zh-CN to en so that the i18n-seeded
default group names ("Default Group"/"Share Group" instead of 默认组/共享组)
and all backend i18n responses default to English.

Note: existing databases already seeded under zh-CN keep their Chinese
group names and must be renamed manually.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 12:33:05 +02:00
thomasandClaude Opus 4.8 0735892b46 ci: Publish Docker image to Gitea registry only
Build & Push Docker Image / docker (push) Failing after 2m34s
Add .gitea/workflows/docker.yml that builds the image via Dockerfile.dev
and pushes it to the Gitea container registry at
git.hackner.dev/thomas/rustdesk-api on pushes to master and on v*.*.* tags.

Remove the GitHub Actions workflows (build.yml, build_test.yml): they push
to Docker Hub and GHCR (not wanted) and rely on GitHub-only features
(GITHUB_TOKEN, GitHub Releases, changelogithub) that do not work on Gitea.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 12:23:06 +02:00
thomasandClaude Opus 4.8 16e97c8efa i18n: Translate all Chinese to English across the codebase
Translate Chinese comments, log/error messages, validator labels and
Swagger annotations to English throughout the source code, generated
Swagger docs, config files and CI workflows.

Make the English README primary: README.md now holds the English docs
and README_EN.md holds the Chinese version, with cross-language links
updated accordingly.

Note: the generated docs/ swagger files were translated in place; run
`go generate ./...` (swag init) to regenerate them from the now-English
annotations when a Go toolchain is available.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 12:17:04 +02:00
lejianwen c5687e1506 docs: Removed webclient2 because of DMCA 2025-09-29 09:41:07 +08:00
106 changed files with 3211 additions and 3867 deletions
+61
View File
@@ -0,0 +1,61 @@
name: Build & Push Docker Image
# Builds the Docker image and publishes it to the Gitea container registry
# at git.hackner.dev/thomas/rustdesk-api.
#
# Requires a running Gitea Actions runner (act_runner) and two repo secrets
# (Settings -> Actions -> Secrets):
# REGISTRY_USER - Gitea username (e.g. thomas)
# REGISTRY_PASSWORD - a Gitea access token with "write:package" scope
#
# (Alternatively the built-in ${{ secrets.GITHUB_TOKEN }} can be used with
# username ${{ gitea.actor }} if your Gitea grants it package write access.)
on:
push:
branches:
- master
tags:
- 'v*.*.*'
workflow_dispatch:
env:
REGISTRY: git.hackner.dev
IMAGE_NAME: ${{ github.repository }} # -> thomas/rustdesk-api
jobs:
docker:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to the Gitea container registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ secrets.REGISTRY_USER }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- name: Extract metadata (tags, labels)
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=semver,pattern={{version}}
type=raw,value=latest,enable={{is_default_branch}}
- name: Build and push image
uses: docker/build-push-action@v6
with:
context: .
file: ./Dockerfile.dev
push: true
build-args: |
GO_VERSION=1.23
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
-444
View File
@@ -1,444 +0,0 @@
name: Build
on:
workflow_dispatch:
inputs:
BASE_IMAGE_NAMESPACE:
description: 'Base image namespace (Default: Your Github username)'
required: false
default: ''
DOCKERHUB_IMAGE_NAMESPACE:
description: 'Docker Hub image namespace (Default: Your Github username)'
required: false
default: ''
GHCR_IMAGE_NAMESPACE:
description: 'GitHub Container Registry image namespace (Default: Your Github username)'
required: false
default: ''
SKIP_DOCKER_HUB:
description: 'Set to true to skip pushing to Docker Hub (default: false)'
required: false
default: 'false'
SKIP_GHCR:
description: 'Set to true to skip pushing to GHCR (default: false)'
required: false
default: 'false'
WEBCLIENT_SOURCE_LOCATION:
description: 'Web Client API Repository'
required: true
default: 'https://github.com/lejianwen/rustdesk-api-web'
push:
tags:
- 'v*.*.*' # 当推送带有版本号的 tag(例如 v1.0.0)时触发工作流
- 'test*'
env:
LATEST_TAG: latest
WEBCLIENT_SOURCE_LOCATION: ${{ github.event.inputs.WEBCLIENT_SOURCE_LOCATION || 'https://github.com/lejianwen/rustdesk-api-web' }}
BASE_IMAGE_NAMESPACE: ${{ github.event.inputs.BASE_IMAGE_NAMESPACE || github.actor }}
DOCKERHUB_IMAGE_NAMESPACE: ${{ github.event.inputs.DOCKERHUB_IMAGE_NAMESPACE || github.actor }}
GHCR_IMAGE_NAMESPACE: ${{ github.event.inputs.GHCR_IMAGE_NAMESPACE || github.actor }}
SKIP_DOCKER_HUB: ${{ github.event.inputs.SKIP_DOCKER_HUB || 'false' }}
SKIP_GHCR: ${{ github.event.inputs.SKIP_GHCR || 'false' }}
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
job:
- { platform: "amd64", goos: "linux", file_ext: "tar.gz" }
- { platform: "arm64", goos: "linux", file_ext: "tar.gz" }
- { platform: "armv7l", goos: "linux", file_ext: "tar.gz" }
- { platform: "amd64", goos: "windows", file_ext: "zip" }
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/checkout@v4
with:
repository: lejianwen/rustdesk-api-web
path: rustdesk-api-web
ref: master
- name: Set up Go environment
uses: actions/setup-go@v4
with:
go-version: '1.23' # 选择 Go 版本
- name: Set up npm
uses: actions/setup-node@v2
with:
node-version: '20'
- name: build rustdesk-api-web
working-directory: rustdesk-api-web
run: |
npm install
npm run build
mkdir -p ../resources/admin/
cp -ar dist/* ../resources/admin/
- name: tidy
run: go mod tidy
- name: Get tag version
run: |
TAG_VERSION="${GITHUB_REF##*/}"
VERSION="${TAG_VERSION#v}"
echo "VERSION=$VERSION" >> $GITHUB_ENV
- name: Write version to resources/version
run: echo $VERSION > resources/version
- name: swag
run: |
go install github.com/swaggo/swag/cmd/swag@latest
swag init -g cmd/apimain.go --output docs/api --instanceName api --exclude http/controller/admin
swag init -g cmd/apimain.go --output docs/admin --instanceName admin --exclude http/controller/api
- name: Build for ${{ matrix.job.goos }}-${{ matrix.job.platform }}
run: |
mkdir release -p
cp -ar resources release/
cp -ar docs release/
cp -ar conf release/
mkdir -p release/data
mkdir -p release/runtime
if [ "${{ matrix.job.goos }}" = "windows" ]; then
sudo apt-get install gcc-mingw-w64-x86-64 zip -y
GOOS=${{ matrix.job.goos }} GOARCH=${{ matrix.job.platform }} CC=x86_64-w64-mingw32-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain.exe ./cmd/apimain.go
echo @echo off > release/start.bat
echo cmd /c \"%~dp0apimain.exe\" >> release/start.bat
zip -r ${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}} ./release
else
if [ "${{ matrix.job.platform }}" = "arm64" ]; then
wget https://musl.ljw.red/aarch64-linux-musl-cross.tgz
tar -xf aarch64-linux-musl-cross.tgz
export PATH=$PATH:$PWD/aarch64-linux-musl-cross/bin
GOOS=${{ matrix.job.goos }} GOARCH=${{ matrix.job.platform }} CC=aarch64-linux-musl-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain ./cmd/apimain.go
elif [ "${{ matrix.job.platform }}" = "armv7l" ]; then
wget https://musl.ljw.red/armv7l-linux-musleabihf-cross.tgz
tar -xf armv7l-linux-musleabihf-cross.tgz
export PATH=$PATH:$PWD/armv7l-linux-musleabihf-cross/bin
GOOS=${{ matrix.job.goos }} GOARCH=arm GOARM=7 CC=armv7l-linux-musleabihf-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain ./cmd/apimain.go
else
sudo apt-get install musl musl-dev musl-tools -y
GOOS=${{ matrix.job.goos }} GOARCH=${{ matrix.job.platform }} CC=musl-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain ./cmd/apimain.go
fi
tar -czf ${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}} ./release
fi
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.goos }}-${{ matrix.job.platform }}
path: |
${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}}
- name: Upload to GitHub Release
uses: softprops/action-gh-release@v2
with:
files: |
${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Generate Changelog
if: startsWith(github.ref, 'refs/tags/') && github.event_name == 'push'
run: npx changelogithub # or changelogithub@0.12 if ensure the stable result
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
deb-package:
name: debian package - ${{ matrix.job.platform }}
needs: build
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
job:
- { platform: "amd64", goos: "linux", debian_platform: "amd64", crossbuild_package: ""}
- { platform: "arm64", goos: "linux", debian_platform: "arm64", crossbuild_package: "crossbuild-essential-arm64" }
- { platform: "armv7l", goos: "linux", debian_platform: "armhf", crossbuild_package: "crossbuild-essential-armhf" }
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up QEMU
uses: docker/setup-qemu-action@v2
- name: Create packaging env
run: |
sudo apt update
DEBIAN_FRONTEND=noninteractive sudo apt install -y devscripts build-essential debhelper pkg-config ${{ matrix.job.crossbuild_package }}
mkdir -p debian-build/${{ matrix.job.platform }}/bin
- name: Get tag version
id: get_tag
run: |
TAG_VERSION="${GITHUB_REF##*/}"
VERSION="${TAG_VERSION#v}"
echo "TAG_VERSION=$TAG_VERSION" >> $GITHUB_ENV
echo "VERSION=$VERSION" >> $GITHUB_ENV
- name: Update changelog
run: |
DATE=$(date -R)
sed -i "1i rustdesk-api-server (${VERSION}) stable; urgency=medium\n\n * Automatically generated release for version ${VERSION}.\n\n -- GitHub Actions <actions@github.com> ${DATE}\n" debian/changelog
- name: Download binaries
uses: actions/download-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.goos }}-${{ matrix.job.platform }}
path: .
- name: Unzip binaries
run: |
mkdir -p ${{ matrix.job.platform }}
tar -xzf ${{ matrix.job.goos }}-${{ matrix.job.platform }}.tar.gz -C ${{ matrix.job.platform }}
- name: Build package for ${{ matrix.job.platform }} arch
run: |
mv ${{ matrix.job.platform }}/release/apimain debian-build/${{ matrix.job.platform }}/bin/rustdesk-api
mv ${{ matrix.job.platform }}/release/resources/admin resources
chmod -v a+x debian-build/${{ matrix.job.platform }}/bin/*
mkdir -p data
cp -vr debian systemd conf data resources runtime debian-build/${{ matrix.job.platform }}/
cat debian/control.tpl | sed 's/{{ ARCH }}/${{ matrix.job.debian_platform }}/' > debian-build/${{ matrix.job.platform }}/debian/control
cd debian-build/${{ matrix.job.platform }}/
debuild -i -us -uc -b -a${{ matrix.job.debian_platform}}
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.debian_platform }}
path: |
debian-build/*.deb
- name: Create Release
uses: softprops/action-gh-release@v2
with:
files: |
debian-build/rustdesk-api-server_*_${{ matrix.job.debian_platform }}.deb
docker:
name: Push Docker Image
needs: build
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
job:
- { platform: "amd64", goos: "linux", docker_platform: "linux/amd64" }
- { platform: "arm64", goos: "linux", docker_platform: "linux/arm64" }
- { platform: "armv7l", goos: "linux", docker_platform: "linux/arm/v7" }
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up QEMU
uses: docker/setup-qemu-action@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
- name: Log in to Docker Hub
if: ${{ env.SKIP_DOCKER_HUB == 'false' }} # Only log in if SKIP_DOCKER_HUB is false
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
- name: Log in to GitHub Container Registry
if: ${{ env.SKIP_GHCR == 'false' }} # Only log in if GHCR push is enabled
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract version from tag
id: vars
run: |
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
else
echo "TAG=latest" >> $GITHUB_ENV # Default to 'latest' if not a tag
fi
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v4
with:
images: ${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api
- name: Download binaries
uses: actions/download-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.goos }}-${{ matrix.job.platform }}
path: ./
- name: Unzip binaries
run: |
mkdir -p ${{ matrix.job.platform }}
tar -xzf ${{ matrix.job.goos }}-${{ matrix.job.platform }}.tar.gz -C ${{ matrix.job.platform }}
- name: Build and push Docker image to Docker Hub ${{ matrix.job.platform }}
if: ${{ env.SKIP_DOCKER_HUB == 'false' }} # Only run this step if SKIP_DOCKER_HUB is false
uses: docker/build-push-action@v5
with:
context: "."
file: ./Dockerfile
platforms: ${{ matrix.job.docker_platform }}
push: true
provenance: false
build-args: |
BUILDARCH=${{ matrix.job.platform }}
tags: |
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.LATEST_TAG }}-${{ matrix.job.platform }},
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-${{ matrix.job.platform }}
labels: ${{ steps.meta.outputs.labels }}
- name: Build and push Docker Full S6 image to Docker Hub ${{ matrix.job.platform }}
if: ${{ env.SKIP_DOCKER_HUB == 'false' }} # Only run this step if SKIP_DOCKER_HUB is false
uses: docker/build-push-action@v5
with:
context: "."
file: ./Dockerfile_full_s6
platforms: ${{ matrix.job.docker_platform }}
push: true
provenance: false
build-args: |
BUILDARCH=${{ matrix.job.platform }}
tags: |
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-${{ matrix.job.platform }}
labels: ${{ steps.meta.outputs.labels }}
- name: Build and push Docker image to GHCR ${{ matrix.job.platform }}
if: ${{ env.SKIP_GHCR == 'false' }} # Only run this step if SKIP_GHCR is false
uses: docker/build-push-action@v5
with:
context: "."
file: ./Dockerfile
platforms: ${{ matrix.job.docker_platform }}
push: true
provenance: false
build-args: |
BUILDARCH=${{ matrix.job.platform }}
tags: |
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.LATEST_TAG }}-${{ matrix.job.platform }},
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-${{ matrix.job.platform }}
labels: ${{ steps.meta.outputs.labels }}
- name: Build and push Docker Full S6 image to GHCR ${{ matrix.job.platform }}
if: ${{ env.SKIP_GHCR == 'false' }} # Only run this step if SKIP_GHCR is false
uses: docker/build-push-action@v5
with:
context: "."
file: ./Dockerfile
platforms: ${{ matrix.job.docker_platform }}
push: true
provenance: false
build-args: |
BUILDARCH=${{ matrix.job.platform }}
tags: |
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-${{ matrix.job.platform }}
labels: ${{ steps.meta.outputs.labels }}
#
docker-manifest:
name: Push Docker Manifest
needs: docker
runs-on: ubuntu-latest
steps:
- name: Extract version from tag
id: vars
run: |
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
else
echo "TAG=latest" >> $GITHUB_ENV # Default to 'latest' if not a tag
fi
- name: Log in to Docker Hub
if: ${{ env.SKIP_DOCKER_HUB == 'false' }} # Only log in if Docker Hub push is enabled
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
- name: Log in to GitHub Container Registry
if: ${{ env.SKIP_GHCR == 'false' }} # Only log in if GHCR push is enabled
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Create and push manifest Docker Hub (:version)
if: ${{ env.SKIP_DOCKER_HUB == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}
extra-images: ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-amd64,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-armv7l,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-arm64
push: true
- name: Create and push manifest GHCR (:version)
if: ${{ env.SKIP_GHCR == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ghcr.io/${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}
extra-images: ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-amd64,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-armv7l,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-arm64
push: true
amend: true
- name: Create and push manifest Docker Hub (:latest)
if: ${{ env.SKIP_DOCKER_HUB == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:latest
extra-images: ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:latest-amd64,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:latest-armv7l,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:latest-arm64
push: true
- name: Create and push manifest GHCR (:latest)
if: ${{ env.SKIP_GHCR == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ghcr.io/${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:latest
extra-images: ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:latest-amd64,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:latest-armv7l,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:latest-arm64
push: true
amend: true
- name: Create and push Full S6 manifest Docker Hub (:version)
if: ${{ env.SKIP_DOCKER_HUB == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:full-s6
extra-images: ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-amd64,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-armv7l,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-arm64
push: true
amend: true
- name: Create and push Full S6 manifest GHCR (:latest)
if: ${{ env.SKIP_GHCR == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ghcr.io/${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:full-s6
extra-images: ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-amd64,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-armv7l,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-arm64
push: true
amend: true
-337
View File
@@ -1,337 +0,0 @@
name: Build Test
on:
workflow_dispatch:
inputs:
BASE_IMAGE_NAMESPACE:
description: 'Base image namespace (Default: Your Github username)'
required: false
default: ''
DOCKERHUB_IMAGE_NAMESPACE:
description: 'Docker Hub image namespace (Default: Your Github username)'
required: false
default: ''
GHCR_IMAGE_NAMESPACE:
description: 'GitHub Container Registry image namespace (Default: Your Github username)'
required: false
default: ''
SKIP_DOCKER_HUB:
description: 'Set to true to skip pushing to Docker Hub (default: false)'
required: false
default: 'false'
SKIP_GHCR:
description: 'Set to true to skip pushing to GHCR (default: false)'
required: false
default: 'false'
WEBCLIENT_SOURCE_LOCATION:
description: 'Web Client API Repository'
required: true
default: 'https://github.com/lejianwen/rustdesk-api-web'
env:
LATEST_TAG: latest
WEBCLIENT_SOURCE_LOCATION: ${{ github.event.inputs.WEBCLIENT_SOURCE_LOCATION || 'https://github.com/lejianwen/rustdesk-api-web' }}
BASE_IMAGE_NAMESPACE: ${{ github.event.inputs.BASE_IMAGE_NAMESPACE || github.actor }}
DOCKERHUB_IMAGE_NAMESPACE: ${{ github.event.inputs.DOCKERHUB_IMAGE_NAMESPACE || github.actor }}
GHCR_IMAGE_NAMESPACE: ${{ github.event.inputs.GHCR_IMAGE_NAMESPACE || github.actor }}
SKIP_DOCKER_HUB: ${{ github.event.inputs.SKIP_DOCKER_HUB || 'false' }}
SKIP_GHCR: ${{ github.event.inputs.SKIP_GHCR || 'false' }}
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
job:
- { platform: "amd64", goos: "linux", file_ext: "tar.gz" }
- { platform: "arm64", goos: "linux", file_ext: "tar.gz" }
- { platform: "armv7l", goos: "linux", file_ext: "tar.gz" }
- { platform: "amd64", goos: "windows", file_ext: "zip" }
steps:
- name: Checkout code
uses: actions/checkout@v4
- uses: actions/checkout@v4
with:
repository: lejianwen/rustdesk-api-web
path: rustdesk-api-web
ref: master
- name: Set up Go environment
uses: actions/setup-go@v4
with:
go-version: '1.23' # 选择 Go 版本
- name: Set up npm
uses: actions/setup-node@v2
with:
node-version: '20'
- name: build rustdesk-api-web
working-directory: rustdesk-api-web
run: |
npm install
npm run build
mkdir -p ../resources/admin/
cp -ar dist/* ../resources/admin/
- name: tidy
run: go mod tidy
- name: swag
run: |
go install github.com/swaggo/swag/cmd/swag@latest
swag init -g cmd/apimain.go --output docs/api --instanceName api --exclude http/controller/admin
swag init -g cmd/apimain.go --output docs/admin --instanceName admin --exclude http/controller/api
- name: Build for ${{ matrix.job.goos }}-${{ matrix.job.platform }}
run: |
mkdir release -p
cp -ar resources release/
cp -ar docs release/
cp -ar conf release/
mkdir -p release/data
mkdir -p release/runtime
if [ "${{ matrix.job.goos }}" = "windows" ]; then
sudo apt-get install gcc-mingw-w64-x86-64 zip -y
GOOS=${{ matrix.job.goos }} GOARCH=${{ matrix.job.platform }} CC=x86_64-w64-mingw32-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain.exe ./cmd/apimain.go
echo @echo off > release/start.bat
echo cmd /c \"%~dp0apimain.exe\" >> release/start.bat
zip -r ${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}} ./release
else
if [ "${{ matrix.job.platform }}" = "arm64" ]; then
wget https://musl.ljw.red/aarch64-linux-musl-cross.tgz
tar -xf aarch64-linux-musl-cross.tgz
export PATH=$PATH:$PWD/aarch64-linux-musl-cross/bin
GOOS=${{ matrix.job.goos }} GOARCH=${{ matrix.job.platform }} CC=aarch64-linux-musl-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain ./cmd/apimain.go
elif [ "${{ matrix.job.platform }}" = "armv7l" ]; then
wget https://musl.ljw.red/armv7l-linux-musleabihf-cross.tgz
tar -xf armv7l-linux-musleabihf-cross.tgz
export PATH=$PATH:$PWD/armv7l-linux-musleabihf-cross/bin
GOOS=${{ matrix.job.goos }} GOARCH=arm GOARM=7 CC=armv7l-linux-musleabihf-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain ./cmd/apimain.go
else
sudo apt-get install musl musl-dev musl-tools -y
GOOS=${{ matrix.job.goos }} GOARCH=${{ matrix.job.platform }} CC=musl-gcc CGO_LDFLAGS="-static" CGO_ENABLED=1 go build -ldflags "-s -w" -o ./release/apimain ./cmd/apimain.go
fi
tar -czf ${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}} ./release
fi
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.goos }}-${{ matrix.job.platform }}
path: |
${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}}
- name: Upload to GitHub Release
uses: softprops/action-gh-release@v2
with:
files: |
${{ matrix.job.goos}}-${{ matrix.job.platform }}.${{matrix.job.file_ext}}
tag_name: test
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
deb-package:
name: debian package - ${{ matrix.job.platform }}
needs: build
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
job:
- { platform: "amd64", goos: "linux", debian_platform: "amd64", crossbuild_package: ""}
- { platform: "arm64", goos: "linux", debian_platform: "arm64", crossbuild_package: "crossbuild-essential-arm64" }
- { platform: "armv7l", goos: "linux", debian_platform: "armhf", crossbuild_package: "crossbuild-essential-armhf" }
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up QEMU
uses: docker/setup-qemu-action@v2
- name: Create packaging env
run: |
sudo apt update
DEBIAN_FRONTEND=noninteractive sudo apt install -y devscripts build-essential debhelper pkg-config ${{ matrix.job.crossbuild_package }}
mkdir -p debian-build/${{ matrix.job.platform }}/bin
- name: Download binaries
uses: actions/download-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.goos }}-${{ matrix.job.platform }}
path: .
- name: Unzip binaries
run: |
mkdir -p ${{ matrix.job.platform }}
tar -xzf ${{ matrix.job.goos }}-${{ matrix.job.platform }}.tar.gz -C ${{ matrix.job.platform }}
- name: Build package for ${{ matrix.job.platform }} arch
run: |
mv ${{ matrix.job.platform }}/release/apimain debian-build/${{ matrix.job.platform }}/bin/rustdesk-api
chmod -v a+x debian-build/${{ matrix.job.platform }}/bin/*
mkdir -p data
cp -vr debian systemd conf data resources runtime debian-build/${{ matrix.job.platform }}/
cat debian/control.tpl | sed 's/{{ ARCH }}/${{ matrix.job.debian_platform }}/' > debian-build/${{ matrix.job.platform }}/debian/control
cd debian-build/${{ matrix.job.platform }}/
debuild -i -us -uc -b -a${{ matrix.job.debian_platform}}
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.debian_platform }}
path: |
debian-build/*.deb
- name: Upload to GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: test
files: |
debian-build/rustdesk-api-server_*_${{ matrix.job.debian_platform }}.deb
docker:
name: Push Docker Image
needs: build
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
job:
- { platform: "amd64", goos: "linux", docker_platform: "linux/amd64" }
- { platform: "arm64", goos: "linux", docker_platform: "linux/arm64" }
- { platform: "armv7l", goos: "linux", docker_platform: "linux/arm/v7" }
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up QEMU
uses: docker/setup-qemu-action@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
- name: Log in to Docker Hub
if: ${{ env.SKIP_DOCKER_HUB == 'false' }} # Only log in if SKIP_DOCKER_HUB is false
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
- name: Log in to GitHub Container Registry
if: ${{ env.SKIP_GHCR == 'false' }} # Only log in if GHCR push is enabled
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract version from tag
id: vars
run: |
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
else
echo "TAG=test" >> $GITHUB_ENV # Default to 'test' if not a tag
fi
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v4
with:
images: ${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api
- name: Download binaries
uses: actions/download-artifact@v4
with:
name: rustdesk-api-${{ matrix.job.goos }}-${{ matrix.job.platform }}
path: ./
- name: Unzip binaries
run: |
mkdir -p ${{ matrix.job.platform }}
tar -xzf ${{ matrix.job.goos }}-${{ matrix.job.platform }}.tar.gz -C ${{ matrix.job.platform }}
- name: Build and push Docker image to Docker Hub ${{ matrix.job.platform }}
if: ${{ env.SKIP_DOCKER_HUB == 'false' }} # Only run this step if SKIP_DOCKER_HUB is false
uses: docker/build-push-action@v5
with:
context: "."
file: ./Dockerfile
platforms: ${{ matrix.job.docker_platform }}
push: true
provenance: false
build-args: |
BUILDARCH=${{ matrix.job.platform }}
tags: |
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-${{ matrix.job.platform }}
labels: ${{ steps.meta.outputs.labels }}
- name: Build and push Docker image to GHCR ${{ matrix.job.platform }}
if: ${{ env.SKIP_GHCR == 'false' }} # Only run this step if SKIP_GHCR is false
uses: docker/build-push-action@v5
with:
context: "."
file: ./Dockerfile
platforms: ${{ matrix.job.docker_platform }}
push: true
provenance: false
build-args: |
BUILDARCH=${{ matrix.job.platform }}
tags: |
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-${{ matrix.job.platform }}
labels: ${{ steps.meta.outputs.labels }}
#
docker-manifest:
name: Push Docker Manifest
needs: docker
runs-on: ubuntu-latest
steps:
- name: Extract version from tag
id: vars
run: |
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
else
echo "TAG=test" >> $GITHUB_ENV # Default to 'test' if not a tag
fi
- name: Log in to Docker Hub
if: ${{ env.SKIP_DOCKER_HUB == 'false' }} # Only log in if Docker Hub push is enabled
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
- name: Log in to GitHub Container Registry
if: ${{ env.SKIP_GHCR == 'false' }} # Only log in if GHCR push is enabled
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Create and push manifest Docker Hub (:version)
if: ${{ env.SKIP_DOCKER_HUB == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}
extra-images: ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-amd64,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-armv7l,
${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-arm64
push: true
- name: Create and push manifest GHCR (:version)
if: ${{ env.SKIP_GHCR == 'false' }}
uses: Noelware/docker-manifest-action@v0.2.3
with:
base-image: ghcr.io/${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}
extra-images: ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-amd64,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-armv7l,
ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-arm64
push: true
amend: true
+183 -182
View File
@@ -1,9 +1,9 @@
# RustDesk API # RustDesk API
[English Doc](README_EN.md) [中文文档](README_EN.md)
本项目使用 Go 实现了 RustDesk 的 API,并包含了 Web Admin 和 Web 客户端。
This project implements the RustDesk API using Go, and includes both a web UI and web client. RustDesk is a remote
desktop software that provides self-hosted solutions.
<div align=center> <div align=center>
<img src="https://img.shields.io/badge/golang-1.22-blue"/> <img src="https://img.shields.io/badge/golang-1.22-blue"/>
@@ -14,238 +14,237 @@
<img src="https://github.com/lejianwen/rustdesk-api/actions/workflows/build.yml/badge.svg"/> <img src="https://github.com/lejianwen/rustdesk-api/actions/workflows/build.yml/badge.svg"/>
</div> </div>
## 搭配[lejianwen/rustdesk-server]使用更佳。 ## Better used with [lejianwen/rustdesk-server].
> [lejianwen/rustdesk-server]fork自RustDesk Server官方仓库 > [lejianwen/rustdesk-server] is a fork of the official RustDesk Server repository.
> 1. 解决了使用API链接超时问题 > 1. Solves the API connection timeout issue.
> 2. 可以强制登录后才能发起链接 > 2. Can enforce login before initiating a connection.
> 3. 支持客户端websocket > 3. Supports client websocket.
# Features
# 特性 - PC API
- Personal API
- PC端API - Login
- 个人版API - Address Book
- 登录 - Groups
- 地址簿 - Authorized login,
- 群组 - supports `GitHub`, `Google` and `OIDC` login,
- 授权登录 - supports `web admin` authorized login,
- 支持`github`, `google``OIDC` 登录, - supports LDAP(test AD and openladp) if API Server config
- 支持`web后台`授权登录
- 支持`LDAP`(AD和OpenLDAP已测试), 如果API Server配置了LDAP
- i18n - i18n
- Web Admin - Web Admin
- 用户管理 - User Management
- 设备管理 - Device Management
- 地址簿管理 - Address Book Management
- 标签管理 - Tag Management
- 群组管理 - Group Management
- Oauth 管理 - OAuth Management
- 配置LDAP, 配置文件或者环境变量 - LDAP Config by config file or ENV
- 登录日志 - Login Logs
- 链接日志 - Connection Logs
- 文件传输日志 - File Transfer Logs
- 快速使用web client - Quick access to web client
- i18n - i18n
- 通过 web client 分享给游客 - Share to guest by web client
- server控制(一些官方的简单的指令 [WIKI](https://github.com/lejianwen/rustdesk-api/wiki/Rustdesk-Command)) - Server control (some simple official commands [WIKI](https://github.com/lejianwen/rustdesk-api/wiki/Rustdesk-Command))
- Web Client - Web Client
- 自动获取API server - Automatically obtain API server
- 自动获取ID服务器和KEY - Automatically obtain ID server and KEY
- 自动获取地址簿 - Automatically obtain address book
- 游客通过临时分享链接直接远程到设备 - Visitors are remotely to the device via a temporary sharing link
- v2 Preview
- CLI - CLI
- 重置管理员密码 - Reset admin password
## 功能 ## Overview
### API Service
### API 服务 Basic implementation of the PC client's primary interfaces.Supports the Personal version api, which can be enabled by configuring the `rustdesk.personal` file or the `RUSTDESK_API_RUSTDESK_PERSONAL` environment variable.
基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用
<table> <table>
<tr> <tr>
<td width="50%" align="center" colspan="2"><b>登录</b></td> <td width="50%" align="center" colspan="2"><b>Login</b></td>
</tr> </tr>
<tr> <tr>
<td width="50%" align="center" colspan="2"><img src="docs/pc_login.png"></td> <td width="50%" align="center" colspan="2"><img src="docs/en_img/pc_login.png"></td>
</tr> </tr>
<tr> <tr>
<td width="50%" align="center"><b>地址簿</b></td> <td width="50%" align="center"><b>Address Book</b></td>
<td width="50%" align="center"><b>群组</b></td> <td width="50%" align="center"><b>Groups</b></td>
</tr> </tr>
<tr> <tr>
<td width="50%" align="center"><img src="docs/pc_ab.png"></td> <td width="50%" align="center"><img src="docs/en_img/pc_ab.png"></td>
<td width="50%" align="center"><img src="docs/pc_gr.png"></td> <td width="50%" align="center"><img src="docs/en_img/pc_gr.png"></td>
</tr> </tr>
</table> </table>
### Web Admin: ### Web Admin
* 使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web) * The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and
displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)
* 后台访问地址是`http://<your server>[:port]/_admin/` * Admin panel URL: `http://<your server[:port]>/_admin/`
* 初次安装管理员为用户名为`admin`,密码将在控制台打印,可以通过[命令行](#CLI)更改密码 * For the initial installation, the admin username is `admin`, and the password will be printed in the console. You can change the password via the [command line](#CLI).
![img.png](./docs/init_admin_pwd.png) ![img.png](./docs/init_admin_pwd.png)
1. 管理员界面
![web_admin](docs/web_admin.png)
2. 普通用户界面
![web_user](docs/web_admin_user.png)
3. 每个用户可以多个地址簿,也可以将地址簿共享给其他用户 1. Admin interface:
4. 分组可以自定义,方便管理,暂时支持两种类型: `共享组``普通组` ![web_admin](docs/en_img/web_admin.png)
5. 可以直接打开webclient,方便使用;也可以分享给游客,游客可以直接通过webclient远程到设备 2. Regular user interface:
6. Oauth,支持了`Github`, `Google` 以及 `OIDC`, 需要创建一个`OAuth App`,然后配置到后台 ![web_user](docs/en_img/web_admin_user.png)
- 对于`Google``Github`, `Issuer``Scopes`不需要填写.
- 对于`OIDC`, `Issuer`是必须的。`Scopes`是可选的,默认为 `openid,profile,email`. 确保可以获取 `sub`,`email``preferred_username`
- `github oauth app``Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
中创建,地址 [https://github.com/settings/developers](https://github.com/settings/developers)
- `Authorization callback URL`填写`http://<your server[:port]>/api/oidc/callback`
,比如`http://127.0.0.1:21114/api/oidc/callback`
7. 登录日志
8. 链接日志
9. 文件传输日志
10. server控制
- `简易模式`,已经界面化了一些简单的指令,可以直接在后台执行 3. Each user can have multiple address books, which can also be shared with other users.
![rustdesk_command_simple](./docs/rustdesk_command_simple.png) 4. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`.
5. You can directly launch the client or open the web client for convenience; you can also share it with guests, who can remotely access the device via the web client.
6. OAuth support: Currently, `GitHub`, `Google` and `OIDC` are supported. You need to create an `OAuth App` and configure it in
the admin panel.
- For `Google` and `Github`, you don't need to fill the `Issuer` and `Scpoes`
- For `OIDC`, you must set the `Issuer`. And `Scopes` is optional which default is `openid,email,profile`, please make sure this `Oauth App` can access `sub`, `email` and `preferred_username`
- Create a `GitHub OAuth App`
at `Settings` -> `Developer settings` -> `OAuth Apps` -> `New OAuth App` [here](https://github.com/settings/developers).
- Set the `Authorization callback URL` to `http://<your server[:port]>/api/oidc/callback`,
e.g., `http://127.0.0.1:21114/api/oidc/callback`.
- `高级模式`,直接在后台执行指令 7. Login logs
* 可以官方指令 8. Connection logs
* 可以添加自定义指令 9. File transfer logs
* 可以执行自定义指令 10. Server control
- `Simple mode`, some simple commands have been GUI-ized and can be executed directly in the backend
![rustdesk_command_simple](./docs/en_img/rustdesk_command_simple.png)
- `Advanced mode`, commands can be executed directly in the backend
* Official commands can be used
* Custom commands can be added
* Custom commands can be executed
11. **LDAP 支持**, 当在API Server上设置了LDAP(已测试AD和LDAP),可以通过LDAP中的用户信息进行登录 https://github.com/lejianwen/rustdesk-api/issues/114 ,如果LDAP验证失败,返回本地用户 11. **LDAP Support**, When you setup the LDAP(test for OpenLDAP and AD), you can login with the LDAP's user. https://github.com/lejianwen/rustdesk-api/issues/114 , if LDAP fail fallback local user
### Web Client: ### Web Client:
1. 如果已经登录了后台,web client将自动直接登录 1. If you're already logged into the admin panel, the web client will log in automatically.
2. 如果没登录后台,点击右上角登录即可,api server已经自动配置好了 2. If you're not logged in, simply click the login button in the top right corner, and the API server will be
3. 登录后,会自动同步ID服务器和KEY pre-configured.
4. 登录后,会将地址簿自动保存到web client中,方便使用 3. After logging in, the ID server and key will be automatically synced.
4. The address book will also be automatically saved to the web client for convenient use.
### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.
### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。 1. Admin panel docs: `<your server[:port]>/admin/swagger/index.html`
2. PC client docs: `<your server[:port]>/swagger/index.html`
1. 后台文档 `<youer server[:port]>/admin/swagger/index.html`
2. PC端文档 `<youer server[:port]>/swagger/index.html`
![api_swag](docs/api_swag.png) ![api_swag](docs/api_swag.png)
### CLI ### CLI
```bash ```bash
# 查看帮助 # help
./apimain -h ./apimain -h
``` ```
#### 重置管理员密码 #### Reset admin password
```bash ```bash
./apimain reset-admin-pwd <pwd> ./apimain reset-admin-pwd <pwd>
``` ```
## 安装与运行 ## Installation and Setup
### 相关配置 ### Configuration
* [配置文件](./conf/config.yaml) * [Config File](./conf/config.yaml)
* 参考`conf/config.yaml`配置文件,修改相关配置。 * Modify the configuration in `conf/config.yaml`.
* 如果`gorm.type``sqlite`,则不需要配置mysql相关配置。 * If `gorm.type` is set to `sqlite`, MySQL-related configurations are not required.
* 语言如果不设置默认为`zh-CN` * Language support: `en` and `zh-CN` are supported. The default is `zh-CN`.
### 环境变量
环境变量和配置文件`conf/config.yaml`中的配置一一对应,变量名前缀是`RUSTDESK_API`
下面表格并未全部列出,可以参考`conf/config.yaml`中的配置。
| 变量名 | 说明 | 示例 |
|--------------------------------------------------------|--------------------------------------------------------------------------------|------------------------------|
| TZ | 时区 | Asia/Shanghai |
| RUSTDESK_API_LANG | 语言 | `en`,`zh-CN` |
| RUSTDESK_API_APP_WEB_CLIENT | 是否启用web-client; 1:启用,0:不启用; 默认启用 | 1 |
| RUSTDESK_API_APP_REGISTER | 是否开启注册; `true`, `false` 默认`false` | `false` |
| RUSTDESK_API_APP_SHOW_SWAGGER | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示 | `1` |
| RUSTDESK_API_APP_TOKEN_EXPIRE | token有效时长 | `168h` |
| RUSTDESK_API_APP_DISABLE_PWD_LOGIN | 是否禁用密码登录; `true`, `false` 默认`false` | `false` |
| RUSTDESK_API_APP_REGISTER_STATUS | 注册用户默认状态; 1 启用,2 禁用, 默认 1 | `1` |
| RUSTDESK_API_APP_CAPTCHA_THRESHOLD | 验证码触发次数; -1 不启用, 0 一直启用, >0 登录错误次数后启用 ;默认 `3` | `3` |
| RUSTDESK_API_APP_BAN_THRESHOLD | 封禁IP触发次数; 0 不启用, >0 登录错误次数后封禁IP; 默认 `0` | `0` |
| -----ADMIN配置----- | ---------- | ---------- |
| RUSTDESK_API_ADMIN_TITLE | 后台标题 | `RustDesk Api Admin` |
| RUSTDESK_API_ADMIN_HELLO | 后台欢迎语,可以使用`html` | |
| RUSTDESK_API_ADMIN_HELLO_FILE | 后台欢迎语文件,如果内容多,使用文件更方便。<br>会覆盖`RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` |
| -----GIN配置----- | ---------- | ---------- |
| RUSTDESK_API_GIN_TRUST_PROXY | 信任的代理IP列表,以`,`分割,默认信任所有 | 192.168.1.2,192.168.1.3 |
| -----GORM配置----- | ---------- | --------------------------- |
| RUSTDESK_API_GORM_TYPE | 数据库类型sqlite或者mysql,默认sqlite | sqlite |
| RUSTDESK_API_GORM_MAX_IDLE_CONNS | 数据库最大空闲连接数 | 10 |
| RUSTDESK_API_GORM_MAX_OPEN_CONNS | 数据库最大打开连接数 | 100 |
| RUSTDESK_API_RUSTDESK_PERSONAL | 是否启用个人版API, 1:启用,0:不启用; 默认启用 | 1 |
| -----MYSQL配置----- | ---------- | ---------- |
| RUSTDESK_API_MYSQL_USERNAME | mysql用户名 | root |
| RUSTDESK_API_MYSQL_PASSWORD | mysql密码 | 111111 |
| RUSTDESK_API_MYSQL_ADDR | mysql地址 | 192.168.1.66:3306 |
| RUSTDESK_API_MYSQL_DBNAME | mysql数据库名 | rustdesk |
| RUSTDESK_API_MYSQL_TLS | 是否启用TLS, 可选值: `true`, `false`, `skip-verify`, `custom` | `false` |
| -----RUSTDESK配置----- | ---------- | ---------- |
| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk的id服务器地址 | 192.168.1.66:21116 |
| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk的relay服务器地址 | 192.168.1.66:21117 |
| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk的api服务器地址 | http://192.168.1.66:21114 |
| RUSTDESK_API_RUSTDESK_KEY | Rustdesk的key | 123456789 |
| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk存放key的文件 | `./conf/data/id_ed25519.pub` |
| RUSTDESK_API_RUSTDESK_WEBCLIENT<br/>_MAGIC_QUERYONLINE | Web client v2 中是否启用新的在线状态查询方法; `1`:启用,`0`:不启用,默认不启用 | `0` |
| RUSTDESK_API_RUSTDESK_WS_HOST | 自定义Websocket Host | `wss://192.168.1.123:1234` |
| ----PROXY配置----- | ---------- | ---------- |
| RUSTDESK_API_PROXY_ENABLE | 是否启用代理:`false`, `true` | `false` |
| RUSTDESK_API_PROXY_HOST | 代理地址 | `http://127.0.0.1:1080` |
| ----JWT配置---- | -------- | -------- |
| RUSTDESK_API_JWT_KEY | 自定义JWT KEY,为空则不启用JWT<br/>如果没使用`lejianwen/rustdesk-server`中的`MUST_LOGIN`,建议设置为空 | |
| RUSTDESK_API_JWT_EXPIRE_DURATION | JWT有效时间 | `168h` |
### 运行 ### Environment Variables
The environment variables correspond one-to-one with the configurations in the `conf/config.yaml` file. The prefix for variable names is `RUSTDESK_API`.
The table below does not list all configurations. Please refer to the configurations in `conf/config.yaml`.
#### docker运行 | Variable Name | Description | Example |
|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| TZ | timezone | Asia/Shanghai |
| RUSTDESK_API_LANG | Language | `en`,`zh-CN` |
| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, default: 1 | 1 |
| RUSTDESK_API_APP_REGISTER | register enable; `true`, `false`; default:`false` | `false` |
| RUSTDESK_API_APP_SHOW_SWAGGER | swagger visible; 1: yes, 0: no; default: 0 | `0` |
| RUSTDESK_API_APP_TOKEN_EXPIRE | token expire duration | `168h` |
| RUSTDESK_API_APP_DISABLE_PWD_LOGIN | disable password login | `false` |
| RUSTDESK_API_APP_REGISTER_STATUS | register user default status ; 1 enabled , 2 disabled ; default 1 | `1` |
| RUSTDESK_API_APP_CAPTCHA_THRESHOLD | captcha threshold; -1 disabled, 0 always enable, >0 threshold ;default `3` | `3` |
| RUSTDESK_API_APP_BAN_THRESHOLD | ban ip threshold; 0 disabled, >0 threshold ; default `0` | `0` |
| ----- ADMIN Configuration----- | ---------- | ---------- |
| RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` |
| RUSTDESK_API_ADMIN_HELLO | Admin welcome message, you can use `html` | |
| RUSTDESK_API_ADMIN_HELLO_FILE | Admin welcome message file,<br>will override `RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` |
| ----- GIN Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_GIN_TRUST_PROXY | Trusted proxy IPs, separated by commas. | 192.168.1.2,192.168.1.3 |
| ----- GORM Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_GORM_TYPE | Database type (`sqlite` or `mysql`). Default is `sqlite`. | sqlite |
| RUSTDESK_API_GORM_MAX_IDLE_CONNS | Maximum idle connections | 10 |
| RUSTDESK_API_GORM_MAX_OPEN_CONNS | Maximum open connections | 100 |
| RUSTDESK_API_RUSTDESK_PERSONAL | Open Personal Api 1:Enable,0:Disable | 1 |
| ----- MYSQL Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_MYSQL_USERNAME | MySQL username | root |
| RUSTDESK_API_MYSQL_PASSWORD | MySQL password | 111111 |
| RUSTDESK_API_MYSQL_ADDR | MySQL address | 192.168.1.66:3306 |
| RUSTDESK_API_MYSQL_DBNAME | MySQL database name | rustdesk |
| RUSTDESK_API_MYSQL_TLS | Whether to enable TLS, optional values: `true`, `false`, `skip-verify`, `custom` | `false` |
| ----- RUSTDESK Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk ID server address | 192.168.1.66:21116 |
| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk relay server address | 192.168.1.66:21117 |
| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk API server address | http://192.168.1.66:21114 |
| RUSTDESK_API_RUSTDESK_KEY | Rustdesk key | 123456789 |
| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk key file | `./conf/data/id_ed25519.pub` |
| RUSTDESK_API_RUSTDESK<br/>_WEBCLIENT_MAGIC_QUERYONLINE | New online query method is enabled in the web client v2; '1': Enabled, '0': Disabled, not enabled by default | `0` |
| RUSTDESK_API_RUSTDESK_WS_HOST | Custom Websocket Host | `wss://192.168.1.123:1234` |
| ---- PROXY ----- | --------------- | ---------- |
| RUSTDESK_API_PROXY_ENABLE | proxy_enable :`false`, `true` | `false` |
| RUSTDESK_API_PROXY_HOST | proxy_host | `http://127.0.0.1:1080` |
| ----JWT---- | -------- | -------- |
| RUSTDESK_API_JWT_KEY | Custom JWT KEY, if empty JWT is not enabled.<br/>If `MUST_LOGIN` from `lejianwen/rustdesk-server` is not used, it is recommended to leave it empty. | |
| RUSTDESK_API_JWT_EXPIRE_DURATION | JWT expire duration | `168h` |
1. 直接docker运行,配置可以通过挂载配置文件`/app/conf/config.yaml`来修改,或者通过环境变量覆盖配置文件中的配置 ### Installation Steps
#### Running via Docker
1. Run directly with Docker. Configuration can be modified by mounting the config file `/app/conf/config.yaml`, or by
using environment variables to override settings.
```bash ```bash
docker run -d --name rustdesk-api -p 21114:21114 \ docker run -d --name rustdesk-api -p 21114:21114 \
-v /data/rustdesk/api:/app/data \ -v /data/rustdesk/api:/app/data \
-e TZ=Asia/Shanghai \ -e RUSTDESK_API_LANG=en \
-e RUSTDESK_API_LANG=zh-CN \
-e RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 \ -e RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 \
-e RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 \ -e RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 \
-e RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 \ -e RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 \
-e RUSTDESK_API_RUSTDESK_KEY=<key> \ -e RUSTDESK_API_RUSTDESK_KEY=abc123456 \
lejianwen/rustdesk-api lejianwen/rustdesk-api
``` ```
2. 使用`docker compose`,参考[WIKI](https://github.com/lejianwen/rustdesk-api/wiki) 2. Using `docker-compose`,look [WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
#### 下载release直接运行 #### Running from Release
[下载地址](https://github.com/lejianwen/rustdesk-api/releases) Download the release from [release](https://github.com/lejianwen/rustdesk-api/releases).
#### 源码安装 #### Source Installation
1. 克隆仓库 1. Clone the repository:
```bash ```bash
git clone https://github.com/lejianwen/rustdesk-api.git git clone https://github.com/lejianwen/rustdesk-api.git
cd rustdesk-api cd rustdesk-api
``` ```
2. 安装依赖 2. Install dependencies:
```bash ```bash
go mod tidy go mod tidy
#安装swag,如果不需要生成文档,可以不安装 # Install Swag if you need to generate documentation; otherwise, you can skip this step
go install github.com/swaggo/swag/cmd/swag@latest go install github.com/swaggo/swag/cmd/swag@latest
``` ```
3. 编译后台前端,前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)中 3. Build the admin front-end (the front-end code is
in [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)):
```bash ```bash
cd resources cd resources
mkdir -p admin mkdir -p admin
@@ -255,29 +254,33 @@
npm run build npm run build
cp -ar dist/* ../admin/ cp -ar dist/* ../admin/
``` ```
4. 运行
4. Run:
```bash ```bash
#直接运行 # Run directly
go run cmd/apimain.go go run cmd/apimain.go
#或者使用generate_api.go生成api并运行 # Or generate and run the API using generate_api.go
go generate generate_api.go go generate generate_api.go
``` ```
> 注意:使用 `go run` 或编译后的二进制时,当前目录下必须存在 `conf` `resources` > **Note:** When using `go run` or the compiled binary, the `conf` and `resources`
> 目录。如果在其他目录运行,可通过 `-c` 和环境变量 > directories must exist relative to the current working directory. If you run
> `RUSTDESK_API_GIN_RESOURCES_PATH` 指定绝对路径,例如: > the program from another location, specify absolute paths with `-c` and the
> `RUSTDESK_API_GIN_RESOURCES_PATH` environment variable. Example:
> ```bash > ```bash
> RUSTDESK_API_GIN_RESOURCES_PATH=/opt/rustdesk-api/resources ./apimain -c /opt/rustdesk-api/conf/config.yaml > RUSTDESK_API_GIN_RESOURCES_PATH=/opt/rustdesk-api/resources ./apimain -c /opt/rustdesk-api/conf/config.yaml
> ``` > ```
5. 编译,如果想自己编译,先cd到项目根目录,然后windows下直接运行`build.bat`,linux下运行`build.sh`,编译后会在`release`
目录下生成对应的可执行文件。直接运行编译后的可执行文件即可。
6. 打开浏览器访问`http://<your server[:port]>/_admin/`,默认用户名密码为`admin`,请及时更改密码。 5. To compile, change to the project root directory. For Windows, run `build.bat`, and for Linux, run `build.sh`. After
compiling, the corresponding executables will be generated in the `release` directory. Run the compiled executables
directly.
6. Open your browser and visit `http://<your server[:port]>/_admin/`, with default credentials `admin admin`. Please
change the password promptly.
#### 使用`lejianwen/server-s6`镜像运行 #### Running with my forked server-s6 image
- 已解决链接超时问题 - Connection timeout issue resolved
- 可以强制登录后才能发起链接 - Can enforce login before initiating a connection
- github https://github.com/lejianwen/rustdesk-server - github https://github.com/lejianwen/rustdesk-server
```yaml ```yaml
@@ -307,30 +310,28 @@
- RUSTDESK_API_JWT_KEY=xxxxxx # jwt key - RUSTDESK_API_JWT_KEY=xxxxxx # jwt key
volumes: volumes:
- /data/rustdesk/server:/data - /data/rustdesk/server:/data
- /data/rustdesk/api:/app/data #将数据库挂载 - /data/rustdesk/api:/app/data # mount the database
networks: networks:
- rustdesk-net - rustdesk-net
restart: unless-stopped restart: unless-stopped
``` ```
## Others
## 其他
- [WIKI](https://github.com/lejianwen/rustdesk-api/wiki) - [WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
- [链接超时问题](https://github.com/lejianwen/rustdesk-api/issues/92) - [Connection Timeout](https://github.com/lejianwen/rustdesk-api/issues/92)
- [修改客户端ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer) - [Change client ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
- [webclient来源](https://hub.docker.com/r/keyurbhole/flutter_web_desk) - [Web client source](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
## Acknowledgements
## 鸣谢 Thanks to everyone who contributed!
感谢所有做过贡献的人!
<a href="https://github.com/lejianwen/rustdesk-api/graphs/contributors"> <a href="https://github.com/lejianwen/rustdesk-api/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lejianwen/rustdesk-api" /> <img src="https://contrib.rocks/image?repo=lejianwen/rustdesk-api" />
</a> </a>
## 感谢你的支持!如果这个项目对你有帮助,请点个⭐️鼓励一下,谢谢! ## Thanks for your support! If you find this project useful, please give it a ⭐️. Thank you!
[lejianwen/rustdesk-server]: https://github.com/lejianwen/rustdesk-server [lejianwen/rustdesk-server]: https://github.com/lejianwen/rustdesk-server
+181 -181
View File
@@ -1,7 +1,9 @@
# RustDesk API # RustDesk API
This project implements the RustDesk API using Go, and includes both a web UI and web client. RustDesk is a remote [English Doc](README.md)
desktop software that provides self-hosted solutions.
本项目使用 Go 实现了 RustDesk 的 API,并包含了 Web Admin 和 Web 客户端。
<div align=center> <div align=center>
<img src="https://img.shields.io/badge/golang-1.22-blue"/> <img src="https://img.shields.io/badge/golang-1.22-blue"/>
@@ -12,237 +14,237 @@ desktop software that provides self-hosted solutions.
<img src="https://github.com/lejianwen/rustdesk-api/actions/workflows/build.yml/badge.svg"/> <img src="https://github.com/lejianwen/rustdesk-api/actions/workflows/build.yml/badge.svg"/>
</div> </div>
## Better used with [lejianwen/rustdesk-server]. ## 搭配[lejianwen/rustdesk-server]使用更佳。
> [lejianwen/rustdesk-server] is a fork of the official RustDesk Server repository. > [lejianwen/rustdesk-server]fork自RustDesk Server官方仓库
> 1. Solves the API connection timeout issue. > 1. 解决了使用API链接超时问题
> 2. Can enforce login before initiating a connection. > 2. 可以强制登录后才能发起链接
> 3. Supports client websocket. > 3. 支持客户端websocket
# Features
- PC API # 特性
- Personal API
- Login - PC端API
- Address Book - 个人版API
- Groups - 登录
- Authorized login, - 地址簿
- supports `GitHub`, `Google` and `OIDC` login, - 群组
- supports `web admin` authorized login, - 授权登录
- supports LDAP(test AD and openladp) if API Server config - 支持`github`, `google``OIDC` 登录,
- 支持`web后台`授权登录
- 支持`LDAP`(AD和OpenLDAP已测试), 如果API Server配置了LDAP
- i18n - i18n
- Web Admin - Web Admin
- User Management - 用户管理
- Device Management - 设备管理
- Address Book Management - 地址簿管理
- Tag Management - 标签管理
- Group Management - 群组管理
- OAuth Management - Oauth 管理
- LDAP Config by config file or ENV - 配置LDAP, 配置文件或者环境变量
- Login Logs - 登录日志
- Connection Logs - 链接日志
- File Transfer Logs - 文件传输日志
- Quick access to web client - 快速使用web client
- i18n - i18n
- Share to guest by web client - 通过 web client 分享给游客
- Server control (some simple official commands [WIKI](https://github.com/lejianwen/rustdesk-api/wiki/Rustdesk-Command)) - server控制(一些官方的简单的指令 [WIKI](https://github.com/lejianwen/rustdesk-api/wiki/Rustdesk-Command))
- Web Client - Web Client
- Automatically obtain API server - 自动获取API server
- Automatically obtain ID server and KEY - 自动获取ID服务器和KEY
- Automatically obtain address book - 自动获取地址簿
- Visitors are remotely to the device via a temporary sharing link - 游客通过临时分享链接直接远程到设备
- CLI - CLI
- Reset admin password - 重置管理员密码
## Overview ## 功能
### API Service
Basic implementation of the PC client's primary interfaces.Supports the Personal version api, which can be enabled by configuring the `rustdesk.personal` file or the `RUSTDESK_API_RUSTDESK_PERSONAL` environment variable. ### API 服务
基本实现了PC端基础的接口。支持Personal版本接口,可以通过配置文件`rustdesk.personal`或环境变量`RUSTDESK_API_RUSTDESK_PERSONAL`来控制是否启用
<table> <table>
<tr> <tr>
<td width="50%" align="center" colspan="2"><b>Login</b></td> <td width="50%" align="center" colspan="2"><b>登录</b></td>
</tr> </tr>
<tr> <tr>
<td width="50%" align="center" colspan="2"><img src="docs/en_img/pc_login.png"></td> <td width="50%" align="center" colspan="2"><img src="docs/pc_login.png"></td>
</tr> </tr>
<tr> <tr>
<td width="50%" align="center"><b>Address Book</b></td> <td width="50%" align="center"><b>地址簿</b></td>
<td width="50%" align="center"><b>Groups</b></td> <td width="50%" align="center"><b>群组</b></td>
</tr> </tr>
<tr> <tr>
<td width="50%" align="center"><img src="docs/en_img/pc_ab.png"></td> <td width="50%" align="center"><img src="docs/pc_ab.png"></td>
<td width="50%" align="center"><img src="docs/en_img/pc_gr.png"></td> <td width="50%" align="center"><img src="docs/pc_gr.png"></td>
</tr> </tr>
</table> </table>
### Web Admin ### Web Admin:
* The frontend and backend are separated to provide a user-friendly management interface, primarily for managing and * 使用前后端分离,提供用户友好的管理界面,主要用来管理和展示。前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)
displaying data.Frontend code is available at [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)
* Admin panel URL: `http://<your server[:port]>/_admin/` * 后台访问地址是`http://<your server>[:port]/_admin/`
* For the initial installation, the admin username is `admin`, and the password will be printed in the console. You can change the password via the [command line](#CLI). * 初次安装管理员为用户名为`admin`,密码将在控制台打印,可以通过[命令行](#CLI)更改密码
![img.png](./docs/init_admin_pwd.png) ![img.png](./docs/init_admin_pwd.png)
1. 管理员界面
![web_admin](docs/web_admin.png)
2. 普通用户界面
![web_user](docs/web_admin_user.png)
1. Admin interface: 3. 每个用户可以多个地址簿,也可以将地址簿共享给其他用户
![web_admin](docs/en_img/web_admin.png) 4. 分组可以自定义,方便管理,暂时支持两种类型: `共享组``普通组`
2. Regular user interface: 5. 可以直接打开webclient,方便使用;也可以分享给游客,游客可以直接通过webclient远程到设备
![web_user](docs/en_img/web_admin_user.png) 6. Oauth,支持了`Github`, `Google` 以及 `OIDC`, 需要创建一个`OAuth App`,然后配置到后台
- 对于`Google``Github`, `Issuer``Scopes`不需要填写.
- 对于`OIDC`, `Issuer`是必须的。`Scopes`是可选的,默认为 `openid,profile,email`. 确保可以获取 `sub`,`email``preferred_username`
- `github oauth app``Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
中创建,地址 [https://github.com/settings/developers](https://github.com/settings/developers)
- `Authorization callback URL`填写`http://<your server[:port]>/api/oidc/callback`
,比如`http://127.0.0.1:21114/api/oidc/callback`
7. 登录日志
8. 链接日志
9. 文件传输日志
10. server控制
3. Each user can have multiple address books, which can also be shared with other users. - `简易模式`,已经界面化了一些简单的指令,可以直接在后台执行
4. Groups can be customized for easy management. Currently, two types are supported: `shared group` and `regular group`. ![rustdesk_command_simple](./docs/rustdesk_command_simple.png)
5. You can directly launch the client or open the web client for convenience; you can also share it with guests, who can remotely access the device via the web client.
6. OAuth support: Currently, `GitHub`, `Google` and `OIDC` are supported. You need to create an `OAuth App` and configure it in
the admin panel.
- For `Google` and `Github`, you don't need to fill the `Issuer` and `Scpoes`
- For `OIDC`, you must set the `Issuer`. And `Scopes` is optional which default is `openid,email,profile`, please make sure this `Oauth App` can access `sub`, `email` and `preferred_username`
- Create a `GitHub OAuth App`
at `Settings` -> `Developer settings` -> `OAuth Apps` -> `New OAuth App` [here](https://github.com/settings/developers).
- Set the `Authorization callback URL` to `http://<your server[:port]>/api/oidc/callback`,
e.g., `http://127.0.0.1:21114/api/oidc/callback`.
7. Login logs - `高级模式`,直接在后台执行指令
8. Connection logs * 可以官方指令
9. File transfer logs * 可以添加自定义指令
10. Server control * 可以执行自定义指令
- `Simple mode`, some simple commands have been GUI-ized and can be executed directly in the backend
![rustdesk_command_simple](./docs/en_img/rustdesk_command_simple.png)
- `Advanced mode`, commands can be executed directly in the backend
* Official commands can be used
* Custom commands can be added
* Custom commands can be executed
11. **LDAP Support**, When you setup the LDAP(test for OpenLDAP and AD), you can login with the LDAP's user. https://github.com/lejianwen/rustdesk-api/issues/114 , if LDAP fail fallback local user 11. **LDAP 支持**, 当在API Server上设置了LDAP(已测试AD和LDAP),可以通过LDAP中的用户信息进行登录 https://github.com/lejianwen/rustdesk-api/issues/114 ,如果LDAP验证失败,返回本地用户
### Web Client: ### Web Client:
1. If you're already logged into the admin panel, the web client will log in automatically. 1. 如果已经登录了后台,web client将自动直接登录
2. If you're not logged in, simply click the login button in the top right corner, and the API server will be 2. 如果没登录后台,点击右上角登录即可,api server已经自动配置好了
pre-configured. 3. 登录后,会自动同步ID服务器和KEY
3. After logging in, the ID server and key will be automatically synced. 4. 登录后,会将地址簿自动保存到web client中,方便使用
4. The address book will also be automatically saved to the web client for convenient use.
### Automated Documentation : API documentation is generated using Swag, making it easier for developers to understand and use the API.
1. Admin panel docs: `<your server[:port]>/admin/swagger/index.html` ### 自动化文档: 使用 Swag 生成 API 文档,方便开发者理解和使用 API。
2. PC client docs: `<your server[:port]>/swagger/index.html`
1. 后台文档 `<youer server[:port]>/admin/swagger/index.html`
2. PC端文档 `<youer server[:port]>/swagger/index.html`
![api_swag](docs/api_swag.png) ![api_swag](docs/api_swag.png)
### CLI ### CLI
```bash ```bash
# help # 查看帮助
./apimain -h ./apimain -h
``` ```
#### Reset admin password #### 重置管理员密码
```bash ```bash
./apimain reset-admin-pwd <pwd> ./apimain reset-admin-pwd <pwd>
``` ```
## Installation and Setup ## 安装与运行
### Configuration ### 相关配置
* [Config File](./conf/config.yaml) * [配置文件](./conf/config.yaml)
* Modify the configuration in `conf/config.yaml`. * 参考`conf/config.yaml`配置文件,修改相关配置。
* If `gorm.type` is set to `sqlite`, MySQL-related configurations are not required. * 如果`gorm.type``sqlite`,则不需要配置mysql相关配置。
* Language support: `en` and `zh-CN` are supported. The default is `zh-CN`. * 语言如果不设置默认为`zh-CN`
### 环境变量
环境变量和配置文件`conf/config.yaml`中的配置一一对应,变量名前缀是`RUSTDESK_API`
下面表格并未全部列出,可以参考`conf/config.yaml`中的配置。
| 变量名 | 说明 | 示例 |
|--------------------------------------------------------|--------------------------------------------------------------------------------|------------------------------|
| TZ | 时区 | Asia/Shanghai |
| RUSTDESK_API_LANG | 语言 | `en`,`zh-CN` |
| RUSTDESK_API_APP_WEB_CLIENT | 是否启用web-client; 1:启用,0:不启用; 默认启用 | 1 |
| RUSTDESK_API_APP_REGISTER | 是否开启注册; `true`, `false` 默认`false` | `false` |
| RUSTDESK_API_APP_SHOW_SWAGGER | 是否可见swagger文档;`1`显示,`0`不显示,默认`0`不显示 | `1` |
| RUSTDESK_API_APP_TOKEN_EXPIRE | token有效时长 | `168h` |
| RUSTDESK_API_APP_DISABLE_PWD_LOGIN | 是否禁用密码登录; `true`, `false` 默认`false` | `false` |
| RUSTDESK_API_APP_REGISTER_STATUS | 注册用户默认状态; 1 启用,2 禁用, 默认 1 | `1` |
| RUSTDESK_API_APP_CAPTCHA_THRESHOLD | 验证码触发次数; -1 不启用, 0 一直启用, >0 登录错误次数后启用 ;默认 `3` | `3` |
| RUSTDESK_API_APP_BAN_THRESHOLD | 封禁IP触发次数; 0 不启用, >0 登录错误次数后封禁IP; 默认 `0` | `0` |
| -----ADMIN配置----- | ---------- | ---------- |
| RUSTDESK_API_ADMIN_TITLE | 后台标题 | `RustDesk Api Admin` |
| RUSTDESK_API_ADMIN_HELLO | 后台欢迎语,可以使用`html` | |
| RUSTDESK_API_ADMIN_HELLO_FILE | 后台欢迎语文件,如果内容多,使用文件更方便。<br>会覆盖`RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` |
| -----GIN配置----- | ---------- | ---------- |
| RUSTDESK_API_GIN_TRUST_PROXY | 信任的代理IP列表,以`,`分割,默认信任所有 | 192.168.1.2,192.168.1.3 |
| -----GORM配置----- | ---------- | --------------------------- |
| RUSTDESK_API_GORM_TYPE | 数据库类型sqlite或者mysql,默认sqlite | sqlite |
| RUSTDESK_API_GORM_MAX_IDLE_CONNS | 数据库最大空闲连接数 | 10 |
| RUSTDESK_API_GORM_MAX_OPEN_CONNS | 数据库最大打开连接数 | 100 |
| RUSTDESK_API_RUSTDESK_PERSONAL | 是否启用个人版API, 1:启用,0:不启用; 默认启用 | 1 |
| -----MYSQL配置----- | ---------- | ---------- |
| RUSTDESK_API_MYSQL_USERNAME | mysql用户名 | root |
| RUSTDESK_API_MYSQL_PASSWORD | mysql密码 | 111111 |
| RUSTDESK_API_MYSQL_ADDR | mysql地址 | 192.168.1.66:3306 |
| RUSTDESK_API_MYSQL_DBNAME | mysql数据库名 | rustdesk |
| RUSTDESK_API_MYSQL_TLS | 是否启用TLS, 可选值: `true`, `false`, `skip-verify`, `custom` | `false` |
| -----RUSTDESK配置----- | ---------- | ---------- |
| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk的id服务器地址 | 192.168.1.66:21116 |
| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk的relay服务器地址 | 192.168.1.66:21117 |
| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk的api服务器地址 | http://192.168.1.66:21114 |
| RUSTDESK_API_RUSTDESK_KEY | Rustdesk的key | 123456789 |
| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk存放key的文件 | `./conf/data/id_ed25519.pub` |
| RUSTDESK_API_RUSTDESK_WEBCLIENT<br/>_MAGIC_QUERYONLINE | Web client v2 中是否启用新的在线状态查询方法; `1`:启用,`0`:不启用,默认不启用 | `0` |
| RUSTDESK_API_RUSTDESK_WS_HOST | 自定义Websocket Host | `wss://192.168.1.123:1234` |
| ----PROXY配置----- | ---------- | ---------- |
| RUSTDESK_API_PROXY_ENABLE | 是否启用代理:`false`, `true` | `false` |
| RUSTDESK_API_PROXY_HOST | 代理地址 | `http://127.0.0.1:1080` |
| ----JWT配置---- | -------- | -------- |
| RUSTDESK_API_JWT_KEY | 自定义JWT KEY,为空则不启用JWT<br/>如果没使用`lejianwen/rustdesk-server`中的`MUST_LOGIN`,建议设置为空 | |
| RUSTDESK_API_JWT_EXPIRE_DURATION | JWT有效时间 | `168h` |
### Environment Variables ### 运行
The environment variables correspond one-to-one with the configurations in the `conf/config.yaml` file. The prefix for variable names is `RUSTDESK_API`.
The table below does not list all configurations. Please refer to the configurations in `conf/config.yaml`.
| Variable Name | Description | Example | #### docker运行
|--------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| TZ | timezone | Asia/Shanghai |
| RUSTDESK_API_LANG | Language | `en`,`zh-CN` |
| RUSTDESK_API_APP_WEB_CLIENT | web client on/off; 1: on, 0 off, default: 1 | 1 |
| RUSTDESK_API_APP_REGISTER | register enable; `true`, `false`; default:`false` | `false` |
| RUSTDESK_API_APP_SHOW_SWAGGER | swagger visible; 1: yes, 0: no; default: 0 | `0` |
| RUSTDESK_API_APP_TOKEN_EXPIRE | token expire duration | `168h` |
| RUSTDESK_API_APP_DISABLE_PWD_LOGIN | disable password login | `false` |
| RUSTDESK_API_APP_REGISTER_STATUS | register user default status ; 1 enabled , 2 disabled ; default 1 | `1` |
| RUSTDESK_API_APP_CAPTCHA_THRESHOLD | captcha threshold; -1 disabled, 0 always enable, >0 threshold ;default `3` | `3` |
| RUSTDESK_API_APP_BAN_THRESHOLD | ban ip threshold; 0 disabled, >0 threshold ; default `0` | `0` |
| ----- ADMIN Configuration----- | ---------- | ---------- |
| RUSTDESK_API_ADMIN_TITLE | Admin Title | `RustDesk Api Admin` |
| RUSTDESK_API_ADMIN_HELLO | Admin welcome message, you can use `html` | |
| RUSTDESK_API_ADMIN_HELLO_FILE | Admin welcome message file,<br>will override `RUSTDESK_API_ADMIN_HELLO` | `./conf/admin/hello.html` |
| ----- GIN Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_GIN_TRUST_PROXY | Trusted proxy IPs, separated by commas. | 192.168.1.2,192.168.1.3 |
| ----- GORM Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_GORM_TYPE | Database type (`sqlite` or `mysql`). Default is `sqlite`. | sqlite |
| RUSTDESK_API_GORM_MAX_IDLE_CONNS | Maximum idle connections | 10 |
| RUSTDESK_API_GORM_MAX_OPEN_CONNS | Maximum open connections | 100 |
| RUSTDESK_API_RUSTDESK_PERSONAL | Open Personal Api 1:Enable,0:Disable | 1 |
| ----- MYSQL Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_MYSQL_USERNAME | MySQL username | root |
| RUSTDESK_API_MYSQL_PASSWORD | MySQL password | 111111 |
| RUSTDESK_API_MYSQL_ADDR | MySQL address | 192.168.1.66:3306 |
| RUSTDESK_API_MYSQL_DBNAME | MySQL database name | rustdesk |
| RUSTDESK_API_MYSQL_TLS | Whether to enable TLS, optional values: `true`, `false`, `skip-verify`, `custom` | `false` |
| ----- RUSTDESK Configuration ----- | --------------------------------------- | ----------------------------- |
| RUSTDESK_API_RUSTDESK_ID_SERVER | Rustdesk ID server address | 192.168.1.66:21116 |
| RUSTDESK_API_RUSTDESK_RELAY_SERVER | Rustdesk relay server address | 192.168.1.66:21117 |
| RUSTDESK_API_RUSTDESK_API_SERVER | Rustdesk API server address | http://192.168.1.66:21114 |
| RUSTDESK_API_RUSTDESK_KEY | Rustdesk key | 123456789 |
| RUSTDESK_API_RUSTDESK_KEY_FILE | Rustdesk key file | `./conf/data/id_ed25519.pub` |
| RUSTDESK_API_RUSTDESK<br/>_WEBCLIENT_MAGIC_QUERYONLINE | New online query method is enabled in the web client v2; '1': Enabled, '0': Disabled, not enabled by default | `0` |
| RUSTDESK_API_RUSTDESK_WS_HOST | Custom Websocket Host | `wss://192.168.1.123:1234` |
| ---- PROXY ----- | --------------- | ---------- |
| RUSTDESK_API_PROXY_ENABLE | proxy_enable :`false`, `true` | `false` |
| RUSTDESK_API_PROXY_HOST | proxy_host | `http://127.0.0.1:1080` |
| ----JWT---- | -------- | -------- |
| RUSTDESK_API_JWT_KEY | Custom JWT KEY, if empty JWT is not enabled.<br/>If `MUST_LOGIN` from `lejianwen/rustdesk-server` is not used, it is recommended to leave it empty. | |
| RUSTDESK_API_JWT_EXPIRE_DURATION | JWT expire duration | `168h` |
### Installation Steps 1. 直接docker运行,配置可以通过挂载配置文件`/app/conf/config.yaml`来修改,或者通过环境变量覆盖配置文件中的配置
#### Running via Docker
1. Run directly with Docker. Configuration can be modified by mounting the config file `/app/conf/config.yaml`, or by
using environment variables to override settings.
```bash ```bash
docker run -d --name rustdesk-api -p 21114:21114 \ docker run -d --name rustdesk-api -p 21114:21114 \
-v /data/rustdesk/api:/app/data \ -v /data/rustdesk/api:/app/data \
-e RUSTDESK_API_LANG=en \ -e TZ=Asia/Shanghai \
-e RUSTDESK_API_LANG=zh-CN \
-e RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 \ -e RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 \
-e RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 \ -e RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 \
-e RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 \ -e RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 \
-e RUSTDESK_API_RUSTDESK_KEY=abc123456 \ -e RUSTDESK_API_RUSTDESK_KEY=<key> \
lejianwen/rustdesk-api lejianwen/rustdesk-api
``` ```
2. Using `docker-compose`,look [WIKI](https://github.com/lejianwen/rustdesk-api/wiki) 2. 使用`docker compose`,参考[WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
#### Running from Release #### 下载release直接运行
Download the release from [release](https://github.com/lejianwen/rustdesk-api/releases). [下载地址](https://github.com/lejianwen/rustdesk-api/releases)
#### Source Installation #### 源码安装
1. Clone the repository: 1. 克隆仓库
```bash ```bash
git clone https://github.com/lejianwen/rustdesk-api.git git clone https://github.com/lejianwen/rustdesk-api.git
cd rustdesk-api cd rustdesk-api
``` ```
2. Install dependencies: 2. 安装依赖
```bash ```bash
go mod tidy go mod tidy
# Install Swag if you need to generate documentation; otherwise, you can skip this step #安装swag,如果不需要生成文档,可以不安装
go install github.com/swaggo/swag/cmd/swag@latest go install github.com/swaggo/swag/cmd/swag@latest
``` ```
3. Build the admin front-end (the front-end code is 3. 编译后台前端,前端代码在[rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)中
in [rustdesk-api-web](https://github.com/lejianwen/rustdesk-api-web)):
```bash ```bash
cd resources cd resources
mkdir -p admin mkdir -p admin
@@ -252,33 +254,29 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re
npm run build npm run build
cp -ar dist/* ../admin/ cp -ar dist/* ../admin/
``` ```
4. 运行
4. Run:
```bash ```bash
# Run directly #直接运行
go run cmd/apimain.go go run cmd/apimain.go
# Or generate and run the API using generate_api.go #或者使用generate_api.go生成api并运行
go generate generate_api.go go generate generate_api.go
``` ```
> **Note:** When using `go run` or the compiled binary, the `conf` and `resources` > 注意:使用 `go run` 或编译后的二进制时,当前目录下必须存在 `conf` `resources`
> directories must exist relative to the current working directory. If you run > 目录。如果在其他目录运行,可通过 `-c` 和环境变量
> the program from another location, specify absolute paths with `-c` and the > `RUSTDESK_API_GIN_RESOURCES_PATH` 指定绝对路径,例如:
> `RUSTDESK_API_GIN_RESOURCES_PATH` environment variable. Example:
> ```bash > ```bash
> RUSTDESK_API_GIN_RESOURCES_PATH=/opt/rustdesk-api/resources ./apimain -c /opt/rustdesk-api/conf/config.yaml > RUSTDESK_API_GIN_RESOURCES_PATH=/opt/rustdesk-api/resources ./apimain -c /opt/rustdesk-api/conf/config.yaml
> ``` > ```
5. 编译,如果想自己编译,先cd到项目根目录,然后windows下直接运行`build.bat`,linux下运行`build.sh`,编译后会在`release`
目录下生成对应的可执行文件。直接运行编译后的可执行文件即可。
5. To compile, change to the project root directory. For Windows, run `build.bat`, and for Linux, run `build.sh`. After 6. 打开浏览器访问`http://<your server[:port]>/_admin/`,默认用户名密码为`admin`,请及时更改密码。
compiling, the corresponding executables will be generated in the `release` directory. Run the compiled executables
directly.
6. Open your browser and visit `http://<your server[:port]>/_admin/`, with default credentials `admin admin`. Please
change the password promptly.
#### Running with my forked server-s6 image #### 使用`lejianwen/server-s6`镜像运行
- Connection timeout issue resolved - 已解决链接超时问题
- Can enforce login before initiating a connection - 可以强制登录后才能发起链接
- github https://github.com/lejianwen/rustdesk-server - github https://github.com/lejianwen/rustdesk-server
```yaml ```yaml
@@ -314,22 +312,24 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re
restart: unless-stopped restart: unless-stopped
``` ```
## Others
## 其他
- [WIKI](https://github.com/lejianwen/rustdesk-api/wiki) - [WIKI](https://github.com/lejianwen/rustdesk-api/wiki)
- [Connection Timeout](https://github.com/lejianwen/rustdesk-api/issues/92) - [链接超时问题](https://github.com/lejianwen/rustdesk-api/issues/92)
- [Change client ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer) - [修改客户端ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
- [Web client source](https://hub.docker.com/r/keyurbhole/flutter_web_desk) - [webclient来源](https://hub.docker.com/r/keyurbhole/flutter_web_desk)
## Acknowledgements
Thanks to everyone who contributed! ## 鸣谢
感谢所有做过贡献的人!
<a href="https://github.com/lejianwen/rustdesk-api/graphs/contributors"> <a href="https://github.com/lejianwen/rustdesk-api/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lejianwen/rustdesk-api" /> <img src="https://contrib.rocks/image?repo=lejianwen/rustdesk-api" />
</a> </a>
## Thanks for your support! If you find this project useful, please give it a ⭐️. Thank you! ## 感谢你的支持!如果这个项目对你有帮助,请点个⭐️鼓励一下,谢谢!
[lejianwen/rustdesk-server]: https://github.com/lejianwen/rustdesk-server [lejianwen/rustdesk-server]: https://github.com/lejianwen/rustdesk-server
+17 -17
View File
@@ -25,9 +25,9 @@ import (
const DatabaseVersion = 265 const DatabaseVersion = 265
// @title 管理系统API // @title Management System API
// @version 1.0 // @version 1.0
// @description 接口 // @description API
// @basePath /api // @basePath /api
// @securityDefinitions.apikey token // @securityDefinitions.apikey token
// @in header // @in header
@@ -111,10 +111,10 @@ func main() {
} }
func InitGlobal() { func InitGlobal() {
//配置解析 // config parsing
global.Viper = config.Init(&global.Config, global.ConfigPath) global.Viper = config.Init(&global.Config, global.ConfigPath)
//日志 // logging
global.Logger = logger.New(&logger.Config{ global.Logger = logger.New(&logger.Config{
Path: global.Config.Logger.Path, Path: global.Config.Logger.Path,
Level: global.Config.Logger.Level, Level: global.Config.Logger.Level,
@@ -219,11 +219,11 @@ func DatabaseAutoUpdate() {
db := global.DB db := global.DB
if global.Config.Gorm.Type == config.TypeMysql { if global.Config.Gorm.Type == config.TypeMysql {
//检查存不存在数据库,不存在则创建 // check whether the database exists; create it if not
dbName := db.Migrator().CurrentDatabase() dbName := db.Migrator().CurrentDatabase()
if dbName == "" { if dbName == "" {
dbName = global.Config.Mysql.Dbname dbName = global.Config.Mysql.Dbname
// 移除 DSN 中的数据库名称,以便初始连接时不指定数据库 // remove the database name from the DSN so the initial connection does not specify a database
dsnWithoutDB := fmt.Sprintf("%s:%s@(%s)/%s?charset=utf8mb4&parseTime=True&loc=Local", dsnWithoutDB := fmt.Sprintf("%s:%s@(%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
global.Config.Mysql.Username, global.Config.Mysql.Username,
global.Config.Mysql.Password, global.Config.Mysql.Password,
@@ -231,19 +231,19 @@ func DatabaseAutoUpdate() {
"", "",
) )
//新链接 // new connection
dbWithoutDB := orm.NewMysql(&orm.MysqlConfig{ dbWithoutDB := orm.NewMysql(&orm.MysqlConfig{
Dsn: dsnWithoutDB, Dsn: dsnWithoutDB,
}, global.Logger) }, global.Logger)
// 获取底层的 *sql.DB 对象,并确保在程序退出时关闭连接 // get the underlying *sql.DB object and ensure the connection is closed when the program exits
sqlDBWithoutDB, err := dbWithoutDB.DB() sqlDBWithoutDB, err := dbWithoutDB.DB()
if err != nil { if err != nil {
global.Logger.Errorf("获取底层 *sql.DB 对象失败: %v", err) global.Logger.Errorf("failed to get underlying *sql.DB object: %v", err)
return return
} }
defer func() { defer func() {
if err := sqlDBWithoutDB.Close(); err != nil { if err := sqlDBWithoutDB.Close(); err != nil {
global.Logger.Errorf("关闭连接失败: %v", err) global.Logger.Errorf("failed to close connection: %v", err)
} }
}() }()
@@ -258,20 +258,20 @@ func DatabaseAutoUpdate() {
if !db.Migrator().HasTable(&model.Version{}) { if !db.Migrator().HasTable(&model.Version{}) {
Migrate(uint(version)) Migrate(uint(version))
} else { } else {
//查找最后一个version // find the last version
var v model.Version var v model.Version
db.Last(&v) db.Last(&v)
if v.Version < uint(version) { if v.Version < uint(version) {
Migrate(uint(version)) Migrate(uint(version))
} }
// 245迁移 // 245 migration
if v.Version < 245 { if v.Version < 245 {
//oauths 表的 oauth_type 字段设置为 op同样的值 // set the oauths table's oauth_type field to the same value as op
db.Exec("update oauths set oauth_type = op") db.Exec("update oauths set oauth_type = op")
db.Exec("update oauths set issuer = 'https://accounts.google.com' where op = 'google'") db.Exec("update oauths set issuer = 'https://accounts.google.com' where op = 'google'")
db.Exec("update user_thirds set oauth_type = third_type, op = third_type") db.Exec("update user_thirds set oauth_type = third_type, op = third_type")
//通过email迁移旧的google授权 // migrate old google authorizations by email
uts := make([]model.UserThird, 0) uts := make([]model.UserThird, 0)
db.Where("oauth_type = ?", "google").Find(&uts) db.Where("oauth_type = ?", "google").Find(&uts)
for _, ut := range uts { for _, ut := range uts {
@@ -311,7 +311,7 @@ func Migrate(version uint) {
global.Logger.Error("migrate err :=>", err) global.Logger.Error("migrate err :=>", err)
} }
global.DB.Create(&model.Version{Version: version}) global.DB.Create(&model.Version{Version: version})
//如果是初次则创建一个默认用户 // if this is the first run, create a default user
var vc int64 var vc int64
global.DB.Model(&model.Version{}).Count(&vc) global.DB.Model(&model.Version{}).Count(&vc)
if vc == 1 { if vc == 1 {
@@ -333,7 +333,7 @@ func Migrate(version uint) {
Type: model.GroupTypeShare, Type: model.GroupTypeShare,
} }
service.AllService.GroupService.Create(groupShare) service.AllService.GroupService.Create(groupShare)
//true // is true
is_admin := true is_admin := true
admin := &model.User{ admin := &model.User{
Username: "admin", Username: "admin",
@@ -343,7 +343,7 @@ func Migrate(version uint) {
GroupId: 1, GroupId: 1,
} }
// 生成随机密码 // generate a random password
pwd := utils.RandomString(8) pwd := utils.RandomString(8)
global.Logger.Info("Admin Password Is: ", pwd) global.Logger.Info("Admin Password Is: ", pwd)
var err error var err error
-1
View File
@@ -1 +0,0 @@
### 👏👏👏 你好 ***{{username}}*** 欢迎使用 [RustDesk API](https://github.com/lejianwen/rustdesk-api)
+8 -8
View File
@@ -1,18 +1,18 @@
lang: "zh-CN" lang: "en"
app: app:
web-client: 1 # 1:启用 0:禁用 web-client: 1 # 1:enable 0:disable
register: false #是否开启注册 register: false #whether registration is enabled
register-status: 1 # 注册用户默认状态 1:启用 2:禁用 register-status: 1 # default status for registered users 1:enable 2:disable
captcha-threshold: 3 # <0:disabled, 0 always, >0:enabled captcha-threshold: 3 # <0:disabled, 0 always, >0:enabled
ban-threshold: 0 # 0:disabled, >0:enabled ban-threshold: 0 # 0:disabled, >0:enabled
show-swagger: 0 # 1:启用 0:禁用 show-swagger: 0 # 1:enable 0:disable
token-expire: 168h token-expire: 168h
web-sso: true #web auth sso web-sso: true #web auth sso
disable-pwd-login: false #禁用密码登录 disable-pwd-login: false #disable password login
admin: admin:
title: "RustDesk API Admin" title: "RustDesk API Admin"
hello-file: "./conf/admin/hello.html" #优先使用file hello-file: "./conf/admin/hello.html" #prefer to use a file for the welcome message
hello: "" hello: ""
# ID Server and Relay Server ports https://github.com/lejianwen/rustdesk-api/issues/257 # ID Server and Relay Server ports https://github.com/lejianwen/rustdesk-api/issues/257
id-server-port: 21116 # ID Server port (for server cmd) id-server-port: 21116 # ID Server port (for server cmd)
@@ -20,7 +20,7 @@ admin:
gin: gin:
api-addr: "0.0.0.0:21114" api-addr: "0.0.0.0:21114"
mode: "release" #release,debug,test mode: "release" #release,debug,test
resources-path: 'resources' #对外静态文件目录 resources-path: 'resources' #public static file directory
trust-proxy: "" trust-proxy: ""
gorm: gorm:
type: "sqlite" type: "sqlite"
+4 -4
View File
@@ -58,7 +58,7 @@ func (a *Admin) Init() {
} }
} }
// Init 初始化配置 // Init initializes the configuration
func Init(rowVal *Config, path string) *viper.Viper { func Init(rowVal *Config, path string) *viper.Viper {
if path == "" { if path == "" {
path = DefaultConfig path = DefaultConfig
@@ -77,9 +77,9 @@ func Init(rowVal *Config, path string) *viper.Viper {
v.WatchConfig() v.WatchConfig()
//监听配置修改没什么必要 // watching for config changes is not really necessary
v.OnConfigChange(func(e fsnotify.Event) { v.OnConfigChange(func(e fsnotify.Event) {
//配置文件修改监听 // watch for config file changes
fmt.Println("config file changed:", e.Name) fmt.Println("config file changed:", e.Name)
if err2 := v.Unmarshal(rowVal); err2 != nil { if err2 := v.Unmarshal(rowVal); err2 != nil {
fmt.Println(err2) fmt.Println(err2)
@@ -96,7 +96,7 @@ func Init(rowVal *Config, path string) *viper.Viper {
return v return v
} }
// ReadEnv 读取环境变量 // ReadEnv reads environment variables
func ReadEnv(rowVal interface{}) *viper.Viper { func ReadEnv(rowVal interface{}) *viper.Viper {
v := viper.New() v := viper.New()
v.AutomaticEnv() v.AutomaticEnv()
+2 -2
View File
@@ -18,7 +18,7 @@ services:
ports: ports:
- 21114:21114 - 21114:21114
volumes: volumes:
- ./data/rustdesk/api:/app/data #将数据库挂载出来方便备份 - ./data/rustdesk/api:/app/data #mount the database out for easy backup
- ./conf:/app/conf # config - ./conf:/app/conf # config
# - ./resources:/app/resources # 静态资源 # - ./resources:/app/resources # static resources
restart: unless-stopped restart: unless-stopped
+1 -1
View File
@@ -13,5 +13,5 @@ services:
volumes: volumes:
- ./data/rustdesk/api:/app/data # database - ./data/rustdesk/api:/app/data # database
# - ./conf:/app/conf # config # - ./conf:/app/conf # config
# - ./resources:/app/resources # 静态资源 # - ./resources:/app/resources # static resources
restart: unless-stopped restart: unless-stopped
+64
View File
@@ -0,0 +1,64 @@
# RustDesk full stack (server + relay + API/Web Admin) — self-contained example.
#
# Copy to docker-compose.yml and adjust the public IP / keys / secrets:
# cp docker-compose.yml.example docker-compose.yml
#
# Everything is inline (no .env). The Ed25519 key below is an EXAMPLE — generate
# your own for production. The two keys belong together:
# - hbbs/hbbr get the SECRET key via -k
# - rustdesk-api gets the matching PUBLIC key via RUSTDESK_API_RUSTDESK_KEY
# (the public key is also what clients see as their "Key").
services:
hbbs:
container_name: hbbs
image: rustdesk/rustdesk-server:latest
command: hbbs -r 194.164.204.114:21117 -k 1jqLELJaIjaRtt1Tcj6BhqJ7DhT9WszBH/XUHrqJdhdg4K98HmANQFOpUx/vPZFRWnHPTYYHyIB8uH3Xxr8PTw==
environment:
- TZ=Europe/Berlin
- ENCRYPTED_ONLY=1
- MUST_LOGIN=Y
volumes:
- ./data/server:/root
ports:
- "21115:21115"
- "21116:21116"
- "21116:21116/udp"
- "21118:21118"
depends_on:
- hbbr
restart: unless-stopped
hbbr:
container_name: hbbr
image: rustdesk/rustdesk-server:latest
command: hbbr -k 1jqLELJaIjaRtt1Tcj6BhqJ7DhT9WszBH/XUHrqJdhdg4K98HmANQFOpUx/vPZFRWnHPTYYHyIB8uH3Xxr8PTw==
environment:
- TZ=Europe/Berlin
volumes:
- ./data/server:/root
ports:
- "21117:21117"
- "21119:21119"
restart: unless-stopped
rustdesk-api:
container_name: rustdesk-api
image: git.hackner.dev/thomas/rustdesk-api:latest
command: ["./apimain"]
environment:
- TZ=Europe/Berlin
- RUSTDESK_API_LANG=en
- RUSTDESK_API_RUSTDESK_ID_SERVER=194.164.204.114:21116
- RUSTDESK_API_RUSTDESK_RELAY_SERVER=194.164.204.114:21117
- RUSTDESK_API_RUSTDESK_API_SERVER=http://194.164.204.114:21114
- RUSTDESK_API_RUSTDESK_KEY=YOCvfB5gDUBTqVMf7z2RUVpxz02GB8iAfLh918a/D08=
- RUSTDESK_API_JWT_KEY=z5rt4z465rtzdh5sudtuzrutd66zz6
ports:
- "21114:21114"
volumes:
- ./api:/app/data
depends_on:
- hbbs
- hbbr
restart: unless-stopped
+428 -428
View File
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+109 -109
View File
@@ -17,7 +17,7 @@ const docTemplateapi = `{
"paths": { "paths": {
"/": { "/": {
"get": { "get": {
"description": "首页", "description": "home",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -25,9 +25,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"首页" "home"
], ],
"summary": "首页", "summary": "home",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -51,7 +51,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "地址列表", "description": "address list",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -59,9 +59,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址" "address"
], ],
"summary": "地址列表", "summary": "address list",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -83,7 +83,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "地址更新", "description": "address update",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -91,12 +91,12 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址" "address"
], ],
"summary": "地址更新", "summary": "address update",
"parameters": [ "parameters": [
{ {
"description": "地址表单", "description": "address form",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -128,7 +128,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "添加地址", "description": "add address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -136,9 +136,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "添加地址", "summary": "add address",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -169,7 +169,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "删除地址", "description": "delete address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -177,9 +177,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "删除地址", "summary": "delete address",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -212,7 +212,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "更新地址", "description": "update address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -220,9 +220,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "更新地址", "summary": "update address",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -255,7 +255,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "地址", "description": "address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -263,19 +263,19 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "地址列表", "summary": "address list",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "current", "name": "current",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
@@ -309,7 +309,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "个人地址", "description": "personal address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -317,9 +317,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "个人地址", "summary": "personal address",
"parameters": [ "parameters": [
{ {
"description": "string valid", "description": "string valid",
@@ -353,7 +353,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "设置", "description": "settings",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -361,9 +361,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "设置", "summary": "settings",
"parameters": [ "parameters": [
{ {
"description": "string valid", "description": "string valid",
@@ -397,7 +397,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "共享", "description": "shared",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -405,19 +405,19 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "共享地址簿", "summary": "shared address book",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "current", "name": "current",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
} }
@@ -445,7 +445,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -453,9 +453,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签添加", "summary": "add tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -488,7 +488,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -496,9 +496,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签重命名", "summary": "rename tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -531,7 +531,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -539,9 +539,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签修改颜色", "summary": "change tag color",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -574,7 +574,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -582,9 +582,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签删除", "summary": "delete tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -617,7 +617,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -625,9 +625,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签", "summary": "tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -655,7 +655,7 @@ const docTemplateapi = `{
}, },
"/audit/conn": { "/audit/conn": {
"post": { "post": {
"description": "审计连接", "description": "audit connection",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -663,12 +663,12 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"审计" "audit"
], ],
"summary": "审计连接", "summary": "audit connection",
"parameters": [ "parameters": [
{ {
"description": "审计连接", "description": "audit connection",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -695,7 +695,7 @@ const docTemplateapi = `{
}, },
"/audit/file": { "/audit/file": {
"post": { "post": {
"description": "审计文件", "description": "audit file",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -703,12 +703,12 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"审计" "audit"
], ],
"summary": "审计文件", "summary": "audit file",
"parameters": [ "parameters": [
{ {
"description": "审计文件", "description": "audit file",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -740,7 +740,7 @@ const docTemplateapi = `{
"token": [] "token": []
} }
], ],
"description": "用户信息", "description": "user info",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -748,9 +748,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"用户" "user"
], ],
"summary": "用户信息", "summary": "user info",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -774,7 +774,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "机器", "description": "machine",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -782,25 +782,25 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"群组" "group"
], ],
"summary": "设备", "summary": "device",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "状态", "description": "status",
"name": "status", "name": "status",
"in": "query" "in": "query"
}, },
@@ -829,7 +829,7 @@ const docTemplateapi = `{
}, },
"/heartbeat": { "/heartbeat": {
"post": { "post": {
"description": "心跳", "description": "heartbeat",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -837,9 +837,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"首页" "home"
], ],
"summary": "心跳", "summary": "heartbeat",
"responses": { "responses": {
"200": { "200": {
"description": "OK" "description": "OK"
@@ -855,7 +855,7 @@ const docTemplateapi = `{
}, },
"/login": { "/login": {
"post": { "post": {
"description": "登录", "description": "login",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -863,12 +863,12 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"登录" "login"
], ],
"summary": "登录", "summary": "login",
"parameters": [ "parameters": [
{ {
"description": "登录表单", "description": "login form",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -895,7 +895,7 @@ const docTemplateapi = `{
}, },
"/login-options": { "/login-options": {
"get": { "get": {
"description": "登录选项", "description": "login options",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -903,9 +903,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"登录" "login"
], ],
"summary": "登录选项", "summary": "login options",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -927,7 +927,7 @@ const docTemplateapi = `{
}, },
"/logout": { "/logout": {
"post": { "post": {
"description": "登出", "description": "logout",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -935,9 +935,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"登录" "login"
], ],
"summary": "登出", "summary": "logout",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1048,7 +1048,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "机器", "description": "machine",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1056,25 +1056,25 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"群组" "group"
], ],
"summary": "机器", "summary": "machine",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "状态", "description": "status",
"name": "status", "name": "status",
"in": "query" "in": "query"
}, },
@@ -1108,7 +1108,7 @@ const docTemplateapi = `{
"token": [] "token": []
} }
], ],
"description": "服务配置,给webclient提供api-server", "description": "service config, provides an api-server for the webclient",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1118,7 +1118,7 @@ const docTemplateapi = `{
"tags": [ "tags": [
"WEBCLIENT" "WEBCLIENT"
], ],
"summary": "服务配置", "summary": "service config",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1142,7 +1142,7 @@ const docTemplateapi = `{
"token": [] "token": []
} }
], ],
"description": "服务配置,给webclient提供api-server", "description": "service config, provides an api-server for the webclient",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1152,7 +1152,7 @@ const docTemplateapi = `{
"tags": [ "tags": [
"WEBCLIENT_V2" "WEBCLIENT_V2"
], ],
"summary": "服务配置", "summary": "service config",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1171,7 +1171,7 @@ const docTemplateapi = `{
}, },
"/shared-peer": { "/shared-peer": {
"post": { "post": {
"description": "分享的peer", "description": "shared peer",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1181,7 +1181,7 @@ const docTemplateapi = `{
"tags": [ "tags": [
"WEBCLIENT" "WEBCLIENT"
], ],
"summary": "分享的peer", "summary": "shared peer",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1200,7 +1200,7 @@ const docTemplateapi = `{
}, },
"/sysinfo": { "/sysinfo": {
"post": { "post": {
"description": "提交系统信息", "description": "submit system info",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1210,10 +1210,10 @@ const docTemplateapi = `{
"tags": [ "tags": [
"System" "System"
], ],
"summary": "提交系统信息", "summary": "submit system info",
"parameters": [ "parameters": [
{ {
"description": "系统信息表单", "description": "system info form",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -1240,7 +1240,7 @@ const docTemplateapi = `{
}, },
"/sysinfo_ver": { "/sysinfo_ver": {
"post": { "post": {
"description": "获取系统版本信息", "description": "get system version info",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1250,7 +1250,7 @@ const docTemplateapi = `{
"tags": [ "tags": [
"System" "System"
], ],
"summary": "获取系统版本信息", "summary": "get system version info",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1274,7 +1274,7 @@ const docTemplateapi = `{
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "用户列表", "description": "user list",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1282,25 +1282,25 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"群组" "group"
], ],
"summary": "用户列表", "summary": "user list",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "状态", "description": "status",
"name": "status", "name": "status",
"in": "query" "in": "query"
}, },
@@ -1344,7 +1344,7 @@ const docTemplateapi = `{
}, },
"/version": { "/version": {
"get": { "get": {
"description": "版本", "description": "version",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1352,9 +1352,9 @@ const docTemplateapi = `{
"application/json" "application/json"
], ],
"tags": [ "tags": [
"首页" "home"
], ],
"summary": "版本", "summary": "version",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1593,7 +1593,7 @@ const docTemplateapi = `{
"type": "integer" "type": "integer"
}, },
"color": { "color": {
"description": "color flutter的颜色值,从0x00000000 0xFFFFFFFF; 前两位表示透明度,后面6位表示颜色, 可以转成rgba", "description": "color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color, can be converted to rgba",
"type": "integer" "type": "integer"
}, },
"created_at": { "created_at": {
@@ -1683,8 +1683,8 @@ var SwaggerInfoapi = &swag.Spec{
Host: "", Host: "",
BasePath: "/api", BasePath: "/api",
Schemes: []string{}, Schemes: []string{},
Title: "管理系统API", Title: "management systemAPI",
Description: "接口", Description: "API",
InfoInstanceName: "api", InfoInstanceName: "api",
SwaggerTemplate: docTemplateapi, SwaggerTemplate: docTemplateapi,
LeftDelim: "{{", LeftDelim: "{{",
+109 -109
View File
@@ -1,8 +1,8 @@
{ {
"swagger": "2.0", "swagger": "2.0",
"info": { "info": {
"description": "接口", "description": "API",
"title": "管理系统API", "title": "management systemAPI",
"contact": {}, "contact": {},
"version": "1.0" "version": "1.0"
}, },
@@ -10,7 +10,7 @@
"paths": { "paths": {
"/": { "/": {
"get": { "get": {
"description": "首页", "description": "home",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -18,9 +18,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"首页" "home"
], ],
"summary": "首页", "summary": "home",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -44,7 +44,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "地址列表", "description": "address list",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -52,9 +52,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址" "address"
], ],
"summary": "地址列表", "summary": "address list",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -76,7 +76,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "地址更新", "description": "address update",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -84,12 +84,12 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址" "address"
], ],
"summary": "地址更新", "summary": "address update",
"parameters": [ "parameters": [
{ {
"description": "地址表单", "description": "address form",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -121,7 +121,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "添加地址", "description": "add address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -129,9 +129,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "添加地址", "summary": "add address",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -162,7 +162,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "删除地址", "description": "delete address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -170,9 +170,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "删除地址", "summary": "delete address",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -205,7 +205,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "更新地址", "description": "update address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -213,9 +213,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "更新地址", "summary": "update address",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -248,7 +248,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "地址", "description": "address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -256,19 +256,19 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "地址列表", "summary": "address list",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "current", "name": "current",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
@@ -302,7 +302,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "个人地址", "description": "personal address",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -310,9 +310,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "个人地址", "summary": "personal address",
"parameters": [ "parameters": [
{ {
"description": "string valid", "description": "string valid",
@@ -346,7 +346,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "设置", "description": "settings",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -354,9 +354,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "设置", "summary": "settings",
"parameters": [ "parameters": [
{ {
"description": "string valid", "description": "string valid",
@@ -390,7 +390,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "共享", "description": "shared",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -398,19 +398,19 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "共享地址簿", "summary": "shared address book",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "current", "name": "current",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
} }
@@ -438,7 +438,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -446,9 +446,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签添加", "summary": "add tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -481,7 +481,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -489,9 +489,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签重命名", "summary": "rename tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -524,7 +524,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -532,9 +532,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签修改颜色", "summary": "change tag color",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -567,7 +567,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -575,9 +575,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签删除", "summary": "delete tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -610,7 +610,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "标签", "description": "tag",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -618,9 +618,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"地址[Personal]" "address[Personal]"
], ],
"summary": "标签", "summary": "tag",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
@@ -648,7 +648,7 @@
}, },
"/audit/conn": { "/audit/conn": {
"post": { "post": {
"description": "审计连接", "description": "audit connection",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -656,12 +656,12 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"审计" "audit"
], ],
"summary": "审计连接", "summary": "audit connection",
"parameters": [ "parameters": [
{ {
"description": "审计连接", "description": "audit connection",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -688,7 +688,7 @@
}, },
"/audit/file": { "/audit/file": {
"post": { "post": {
"description": "审计文件", "description": "audit file",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -696,12 +696,12 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"审计" "audit"
], ],
"summary": "审计文件", "summary": "audit file",
"parameters": [ "parameters": [
{ {
"description": "审计文件", "description": "audit file",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -733,7 +733,7 @@
"token": [] "token": []
} }
], ],
"description": "用户信息", "description": "user info",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -741,9 +741,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"用户" "user"
], ],
"summary": "用户信息", "summary": "user info",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -767,7 +767,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "机器", "description": "machine",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -775,25 +775,25 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"群组" "group"
], ],
"summary": "设备", "summary": "device",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "状态", "description": "status",
"name": "status", "name": "status",
"in": "query" "in": "query"
}, },
@@ -822,7 +822,7 @@
}, },
"/heartbeat": { "/heartbeat": {
"post": { "post": {
"description": "心跳", "description": "heartbeat",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -830,9 +830,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"首页" "home"
], ],
"summary": "心跳", "summary": "heartbeat",
"responses": { "responses": {
"200": { "200": {
"description": "OK" "description": "OK"
@@ -848,7 +848,7 @@
}, },
"/login": { "/login": {
"post": { "post": {
"description": "登录", "description": "login",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -856,12 +856,12 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"登录" "login"
], ],
"summary": "登录", "summary": "login",
"parameters": [ "parameters": [
{ {
"description": "登录表单", "description": "login form",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -888,7 +888,7 @@
}, },
"/login-options": { "/login-options": {
"get": { "get": {
"description": "登录选项", "description": "login options",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -896,9 +896,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"登录" "login"
], ],
"summary": "登录选项", "summary": "login options",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -920,7 +920,7 @@
}, },
"/logout": { "/logout": {
"post": { "post": {
"description": "登出", "description": "logout",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -928,9 +928,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"登录" "login"
], ],
"summary": "登出", "summary": "logout",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1041,7 +1041,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "机器", "description": "machine",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1049,25 +1049,25 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"群组" "group"
], ],
"summary": "机器", "summary": "machine",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "状态", "description": "status",
"name": "status", "name": "status",
"in": "query" "in": "query"
}, },
@@ -1101,7 +1101,7 @@
"token": [] "token": []
} }
], ],
"description": "服务配置,给webclient提供api-server", "description": "service config, provides an api-server for the webclient",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1111,7 +1111,7 @@
"tags": [ "tags": [
"WEBCLIENT" "WEBCLIENT"
], ],
"summary": "服务配置", "summary": "service config",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1135,7 +1135,7 @@
"token": [] "token": []
} }
], ],
"description": "服务配置,给webclient提供api-server", "description": "service config, provides an api-server for the webclient",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1145,7 +1145,7 @@
"tags": [ "tags": [
"WEBCLIENT_V2" "WEBCLIENT_V2"
], ],
"summary": "服务配置", "summary": "service config",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1164,7 +1164,7 @@
}, },
"/shared-peer": { "/shared-peer": {
"post": { "post": {
"description": "分享的peer", "description": "shared peer",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1174,7 +1174,7 @@
"tags": [ "tags": [
"WEBCLIENT" "WEBCLIENT"
], ],
"summary": "分享的peer", "summary": "shared peer",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1193,7 +1193,7 @@
}, },
"/sysinfo": { "/sysinfo": {
"post": { "post": {
"description": "提交系统信息", "description": "submit system info",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1203,10 +1203,10 @@
"tags": [ "tags": [
"System" "System"
], ],
"summary": "提交系统信息", "summary": "submit system info",
"parameters": [ "parameters": [
{ {
"description": "系统信息表单", "description": "system info form",
"name": "body", "name": "body",
"in": "body", "in": "body",
"required": true, "required": true,
@@ -1233,7 +1233,7 @@
}, },
"/sysinfo_ver": { "/sysinfo_ver": {
"post": { "post": {
"description": "获取系统版本信息", "description": "get system version info",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1243,7 +1243,7 @@
"tags": [ "tags": [
"System" "System"
], ],
"summary": "获取系统版本信息", "summary": "get system version info",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1267,7 +1267,7 @@
"BearerAuth": [] "BearerAuth": []
} }
], ],
"description": "用户列表", "description": "user list",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1275,25 +1275,25 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"群组" "group"
], ],
"summary": "用户列表", "summary": "user list",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
"description": "页码", "description": "page number",
"name": "page", "name": "page",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "每页数量", "description": "items per page",
"name": "pageSize", "name": "pageSize",
"in": "query" "in": "query"
}, },
{ {
"type": "integer", "type": "integer",
"description": "状态", "description": "status",
"name": "status", "name": "status",
"in": "query" "in": "query"
}, },
@@ -1337,7 +1337,7 @@
}, },
"/version": { "/version": {
"get": { "get": {
"description": "版本", "description": "version",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1345,9 +1345,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"首页" "home"
], ],
"summary": "版本", "summary": "version",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "OK",
@@ -1586,7 +1586,7 @@
"type": "integer" "type": "integer"
}, },
"color": { "color": {
"description": "color flutter的颜色值,从0x00000000 0xFFFFFFFF; 前两位表示透明度,后面6位表示颜色, 可以转成rgba", "description": "color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color, can be converted to rgba",
"type": "integer" "type": "integer"
}, },
"created_at": { "created_at": {
+110 -110
View File
@@ -146,8 +146,8 @@ definitions:
collection_id: collection_id:
type: integer type: integer
color: color:
description: color flutter的颜色值,从0x00000000 0xFFFFFFFF; 前两位表示透明度,后面6位表示颜色, description: color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color,
可以转成rgba can be converted to rgba
type: integer type: integer
created_at: created_at:
type: string type: string
@@ -194,15 +194,15 @@ definitions:
type: object type: object
info: info:
contact: {} contact: {}
description: 接口 description: API
title: 管理系统API title: management systemAPI
version: "1.0" version: "1.0"
paths: paths:
/: /:
get: get:
consumes: consumes:
- application/json - application/json
description: 首页 description: home
produces: produces:
- application/json - application/json
responses: responses:
@@ -214,14 +214,14 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
summary: 首页 summary: home
tags: tags:
- 首页 - home
/ab: /ab:
get: get:
consumes: consumes:
- application/json - application/json
description: 地址列表 description: address list
produces: produces:
- application/json - application/json
responses: responses:
@@ -235,15 +235,15 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 地址列表 summary: address list
tags: tags:
- 地址 - address
post: post:
consumes: consumes:
- application/json - application/json
description: 地址更新 description: address update
parameters: parameters:
- description: 地址表单 - description: address form
in: body in: body
name: body name: body
required: true required: true
@@ -262,14 +262,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 地址更新 summary: address update
tags: tags:
- 地址 - address
/ab/peer/add/{guid}: /ab/peer/add/{guid}:
delete: delete:
consumes: consumes:
- application/json - application/json
description: 删除地址 description: delete address
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -289,13 +289,13 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 删除地址 summary: delete address
tags: tags:
- 地址[Personal] - address[Personal]
post: post:
consumes: consumes:
- application/json - application/json
description: 添加地址 description: add address
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -315,14 +315,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 添加地址 summary: add address
tags: tags:
- 地址[Personal] - address[Personal]
/ab/peer/update/{guid}: /ab/peer/update/{guid}:
put: put:
consumes: consumes:
- application/json - application/json
description: 更新地址 description: update address
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -342,20 +342,20 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 更新地址 summary: update address
tags: tags:
- 地址[Personal] - address[Personal]
/ab/peers: /ab/peers:
post: post:
consumes: consumes:
- application/json - application/json
description: 地址 description: address
parameters: parameters:
- description: 页码 - description: page number
in: query in: query
name: current name: current
type: integer type: integer
- description: 每页数量 - description: items per page
in: query in: query
name: pageSize name: pageSize
type: integer type: integer
@@ -376,14 +376,14 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 地址列表 summary: address list
tags: tags:
- 地址[Personal] - address[Personal]
/ab/personal: /ab/personal:
post: post:
consumes: consumes:
- application/json - application/json
description: 个人地址 description: personal address
parameters: parameters:
- description: string valid - description: string valid
in: body in: body
@@ -403,14 +403,14 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 个人地址 summary: personal address
tags: tags:
- 地址[Personal] - address[Personal]
/ab/settings: /ab/settings:
post: post:
consumes: consumes:
- application/json - application/json
description: 设置 description: settings
parameters: parameters:
- description: string valid - description: string valid
in: body in: body
@@ -430,20 +430,20 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 设置 summary: settings
tags: tags:
- 地址[Personal] - address[Personal]
/ab/shared/profiles: /ab/shared/profiles:
post: post:
consumes: consumes:
- application/json - application/json
description: 共享 description: shared
parameters: parameters:
- description: 页码 - description: page number
in: query in: query
name: current name: current
type: integer type: integer
- description: 每页数量 - description: items per page
in: query in: query
name: pageSize name: pageSize
type: integer type: integer
@@ -460,14 +460,14 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 共享地址簿 summary: shared address book
tags: tags:
- 地址[Personal] - address[Personal]
/ab/tag/{guid}: /ab/tag/{guid}:
delete: delete:
consumes: consumes:
- application/json - application/json
description: 标签 description: tag
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -487,14 +487,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 标签删除 summary: delete tag
tags: tags:
- 地址[Personal] - address[Personal]
/ab/tag/add/{guid}: /ab/tag/add/{guid}:
post: post:
consumes: consumes:
- application/json - application/json
description: 标签 description: tag
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -514,14 +514,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 标签添加 summary: add tag
tags: tags:
- 地址[Personal] - address[Personal]
/ab/tag/rename/{guid}: /ab/tag/rename/{guid}:
put: put:
consumes: consumes:
- application/json - application/json
description: 标签 description: tag
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -541,14 +541,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 标签重命名 summary: rename tag
tags: tags:
- 地址[Personal] - address[Personal]
/ab/tag/update/{guid}: /ab/tag/update/{guid}:
put: put:
consumes: consumes:
- application/json - application/json
description: 标签 description: tag
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -568,14 +568,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 标签修改颜色 summary: change tag color
tags: tags:
- 地址[Personal] - address[Personal]
/ab/tags/{guid}: /ab/tags/{guid}:
post: post:
consumes: consumes:
- application/json - application/json
description: 标签 description: tag
parameters: parameters:
- description: guid - description: guid
in: path in: path
@@ -595,16 +595,16 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 标签 summary: tag
tags: tags:
- 地址[Personal] - address[Personal]
/audit/conn: /audit/conn:
post: post:
consumes: consumes:
- application/json - application/json
description: 审计连接 description: audit connection
parameters: parameters:
- description: 审计连接 - description: audit connection
in: body in: body
name: body name: body
required: true required: true
@@ -621,16 +621,16 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
summary: 审计连接 summary: audit connection
tags: tags:
- 审计 - audit
/audit/file: /audit/file:
post: post:
consumes: consumes:
- application/json - application/json
description: 审计文件 description: audit file
parameters: parameters:
- description: 审计文件 - description: audit file
in: body in: body
name: body name: body
required: true required: true
@@ -647,14 +647,14 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
summary: 审计文件 summary: audit file
tags: tags:
- 审计 - audit
/currentUser: /currentUser:
get: get:
consumes: consumes:
- application/json - application/json
description: 用户信息 description: user info
produces: produces:
- application/json - application/json
responses: responses:
@@ -668,24 +668,24 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- token: [] - token: []
summary: 用户信息 summary: user info
tags: tags:
- 用户 - user
/device-group/accessible: /device-group/accessible:
get: get:
consumes: consumes:
- application/json - application/json
description: 机器 description: machine
parameters: parameters:
- description: 页码 - description: page number
in: query in: query
name: page name: page
type: integer type: integer
- description: 每页数量 - description: items per page
in: query in: query
name: pageSize name: pageSize
type: integer type: integer
- description: 状态 - description: status
in: query in: query
name: status name: status
type: integer type: integer
@@ -706,14 +706,14 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 设备 summary: device
tags: tags:
- 群组 - group
/heartbeat: /heartbeat:
post: post:
consumes: consumes:
- application/json - application/json
description: 心跳 description: heartbeat
produces: produces:
- application/json - application/json
responses: responses:
@@ -723,16 +723,16 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
summary: 心跳 summary: heartbeat
tags: tags:
- 首页 - home
/login: /login:
post: post:
consumes: consumes:
- application/json - application/json
description: 登录 description: login
parameters: parameters:
- description: 登录表单 - description: login form
in: body in: body
name: body name: body
required: true required: true
@@ -749,14 +749,14 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
summary: 登录 summary: login
tags: tags:
- 登录 - login
/login-options: /login-options:
get: get:
consumes: consumes:
- application/json - application/json
description: 登录选项 description: login options
produces: produces:
- application/json - application/json
responses: responses:
@@ -770,14 +770,14 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
summary: 登录选项 summary: login options
tags: tags:
- 登录 - login
/logout: /logout:
post: post:
consumes: consumes:
- application/json - application/json
description: 登出 description: logout
produces: produces:
- application/json - application/json
responses: responses:
@@ -789,9 +789,9 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
summary: 登出 summary: logout
tags: tags:
- 登录 - login
/oidc/auth: /oidc/auth:
post: post:
consumes: consumes:
@@ -853,17 +853,17 @@ paths:
get: get:
consumes: consumes:
- application/json - application/json
description: 机器 description: machine
parameters: parameters:
- description: 页码 - description: page number
in: query in: query
name: page name: page
type: integer type: integer
- description: 每页数量 - description: items per page
in: query in: query
name: pageSize name: pageSize
type: integer type: integer
- description: 状态 - description: status
in: query in: query
name: status name: status
type: integer type: integer
@@ -884,14 +884,14 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 机器 summary: machine
tags: tags:
- 群组 - group
/server-config: /server-config:
get: get:
consumes: consumes:
- application/json - application/json
description: 服务配置,给webclient提供api-server description: service config, provides an api-server for the webclient
produces: produces:
- application/json - application/json
responses: responses:
@@ -905,14 +905,14 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- token: [] - token: []
summary: 服务配置 summary: service config
tags: tags:
- WEBCLIENT - WEBCLIENT
/server-config-v2: /server-config-v2:
get: get:
consumes: consumes:
- application/json - application/json
description: 服务配置,给webclient提供api-server description: service config, provides an api-server for the webclient
produces: produces:
- application/json - application/json
responses: responses:
@@ -926,14 +926,14 @@ paths:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
security: security:
- token: [] - token: []
summary: 服务配置 summary: service config
tags: tags:
- WEBCLIENT_V2 - WEBCLIENT_V2
/shared-peer: /shared-peer:
post: post:
consumes: consumes:
- application/json - application/json
description: 分享的peer description: shared peer
produces: produces:
- application/json - application/json
responses: responses:
@@ -945,16 +945,16 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
summary: 分享的peer summary: shared peer
tags: tags:
- WEBCLIENT - WEBCLIENT
/sysinfo: /sysinfo:
post: post:
consumes: consumes:
- application/json - application/json
description: 提交系统信息 description: submit system info
parameters: parameters:
- description: 系统信息表单 - description: system info form
in: body in: body
name: body name: body
required: true required: true
@@ -971,14 +971,14 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
summary: 提交系统信息 summary: submit system info
tags: tags:
- System - System
/sysinfo_ver: /sysinfo_ver:
post: post:
consumes: consumes:
- application/json - application/json
description: 获取系统版本信息 description: get system version info
produces: produces:
- application/json - application/json
responses: responses:
@@ -990,24 +990,24 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
summary: 获取系统版本信息 summary: get system version info
tags: tags:
- System - System
/users: /users:
get: get:
consumes: consumes:
- application/json - application/json
description: 用户列表 description: user list
parameters: parameters:
- description: 页码 - description: page number
in: query in: query
name: page name: page
type: integer type: integer
- description: 每页数量 - description: items per page
in: query in: query
name: pageSize name: pageSize
type: integer type: integer
- description: 状态 - description: status
in: query in: query
name: status name: status
type: integer type: integer
@@ -1035,14 +1035,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse' $ref: '#/definitions/response.ErrorResponse'
security: security:
- BearerAuth: [] - BearerAuth: []
summary: 用户列表 summary: user list
tags: tags:
- 群组 - group
/version: /version:
get: get:
consumes: consumes:
- application/json - application/json
description: 版本 description: version
produces: produces:
- application/json - application/json
responses: responses:
@@ -1054,9 +1054,9 @@ paths:
description: Internal Server Error description: Internal Server Error
schema: schema:
$ref: '#/definitions/response.Response' $ref: '#/definitions/response.Response'
summary: 版本 summary: version
tags: tags:
- 首页 - home
securityDefinitions: securityDefinitions:
BearerAuth: BearerAuth:
in: header in: header
+2 -2
View File
@@ -24,7 +24,7 @@ import (
func ApiInitValidator() { func ApiInitValidator() {
validate := validator.New() validate := validator.New()
// 定义不同的语言翻译 // define translations for different languages
enT := en.New() enT := en.New()
cn := zh_Hans_CN.New() cn := zh_Hans_CN.New()
koT := ko.New() koT := ko.New()
@@ -81,7 +81,7 @@ func ApiInitValidator() {
return label return label
}) })
Validator.Validate = validate Validator.Validate = validate
Validator.UT = uni // 存储 Universal Translator Validator.UT = uni // store the Universal Translator
Validator.VTrans = zhTrans Validator.VTrans = zhTrans
Validator.ValidStruct = func(ctx *gin.Context, i interface{}) []string { Validator.ValidStruct = func(ctx *gin.Context, i interface{}) []string {
+2 -2
View File
@@ -10,14 +10,14 @@ import (
func InitI18n() { func InitI18n() {
bundle := i18n.NewBundle(language.English) bundle := i18n.NewBundle(language.English)
bundle.RegisterUnmarshalFunc("toml", toml.Unmarshal) bundle.RegisterUnmarshalFunc("toml", toml.Unmarshal)
//读取global.Config.Gin.ResourcesPath下的所有语言文件 // read all language files under global.Config.Gin.ResourcesPath
dir := Config.Gin.ResourcesPath + "/i18n" dir := Config.Gin.ResourcesPath + "/i18n"
fileInfos, err := os.ReadDir(dir) fileInfos, err := os.ReadDir(dir)
if err != nil { if err != nil {
panic(err) panic(err)
} }
for _, fileInfo := range fileInfos { for _, fileInfo := range fileInfos {
//如果文件名不是.toml结尾 // if the file name does not end with .toml
if fileInfo.IsDir() || fileInfo.Name()[len(fileInfo.Name())-5:] != ".toml" { if fileInfo.IsDir() || fileInfo.Name()[len(fileInfo.Name())-5:] != ".toml" {
continue continue
} }
+39 -39
View File
@@ -15,10 +15,10 @@ import (
type AddressBook struct { type AddressBook struct {
} }
// Detail 地址簿 // Detail address book
// @Tags 地址簿 // @Tags address book
// @Summary 地址簿详情 // @Summary address book details
// @Description 地址簿详情 // @Description address book details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -38,13 +38,13 @@ func (ct *AddressBook) Detail(c *gin.Context) {
return return
} }
// Create 创建地址簿 // Create create address book
// @Tags 地址簿 // @Tags address book
// @Summary 创建地址簿 // @Summary create address book
// @Description 创建地址簿 // @Description create address book
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AddressBookForm true "地址簿信息" // @Param body body admin.AddressBookForm true "address book info"
// @Success 200 {object} response.Response{data=model.AddressBook} // @Success 200 {object} response.Response{data=model.AddressBook}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book/create [post] // @Router /admin/address_book/create [post]
@@ -84,13 +84,13 @@ func (ct *AddressBook) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// BatchCreate 批量创建地址簿 // BatchCreate batch create address books
// @Tags 地址簿 // @Tags address book
// @Summary 批量创建地址簿 // @Summary batch create address books
// @Description 批量创建地址簿 // @Description batch create address books
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AddressBookForm true "地址簿信息" // @Param body body admin.AddressBookForm true "address book info"
// @Success 200 {object} response.Response{data=model.AddressBook} // @Success 200 {object} response.Response{data=model.AddressBook}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book/batchCreate [post] // @Router /admin/address_book/batchCreate [post]
@@ -113,13 +113,13 @@ func (ct *AddressBook) BatchCreate(c *gin.Context) {
return return
} }
if ul > 1 { if ul > 1 {
//多用户置空标签 //clear tags in multi-user mode
f.Tags = []string{} f.Tags = []string{}
//多用户只能创建到默认地址簿 //in multi-user mode, can only create in the default address book
f.CollectionId = 0 f.CollectionId = 0
} }
//创建标签 //create tag
/*for _, fu := range f.UserIds { /*for _, fu := range f.UserIds {
if fu == 0 { if fu == 0 {
continue continue
@@ -148,16 +148,16 @@ func (ct *AddressBook) BatchCreate(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 地址簿 // @Tags address book
// @Summary 地址簿列表 // @Summary address book list
// @Description 地址簿列表 // @Description address book list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param user_id query int false "用户id" // @Param user_id query int false "userid"
// @Param is_my query int false "是否是我的" // @Param is_my query int false "whether it is mine"
// @Success 200 {object} response.Response{data=model.AddressBookList} // @Success 200 {object} response.Response{data=model.AddressBookList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book/list [get] // @Router /admin/address_book/list [get]
@@ -196,13 +196,13 @@ func (ct *AddressBook) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 地址簿 // @Tags address book
// @Summary 地址簿编辑 // @Summary edit address book
// @Description 地址簿编辑 // @Description edit address book
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AddressBookForm true "地址簿信息" // @Param body body admin.AddressBookForm true "address book info"
// @Success 200 {object} response.Response{data=model.AddressBook} // @Success 200 {object} response.Response{data=model.AddressBook}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book/update [post] // @Router /admin/address_book/update [post]
@@ -240,13 +240,13 @@ func (ct *AddressBook) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 地址簿 // @Tags address book
// @Summary 地址簿删除 // @Summary delete address book
// @Description 地址簿删除 // @Description delete address book
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AddressBookForm true "地址簿信息" // @Param body body admin.AddressBookForm true "address book info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book/delete [post] // @Router /admin/address_book/delete [post]
@@ -277,12 +277,12 @@ func (ct *AddressBook) Delete(c *gin.Context) {
} }
// ShareByWebClient // ShareByWebClient
// @Tags 地址簿 // @Tags address book
// @Summary 地址簿分享 // @Summary share address book
// @Description 地址簿分享 // @Description share address book
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.ShareByWebClientForm true "地址簿信息" // @Param body body admin.ShareByWebClientForm true "address book info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book/share [post] // @Router /admin/address_book/share [post]
+27 -27
View File
@@ -14,10 +14,10 @@ import (
type AddressBookCollection struct { type AddressBookCollection struct {
} }
// Detail 地址簿名称 // Detail address book name
// @Tags 地址簿名称 // @Tags address book name
// @Summary 地址簿名称详情 // @Summary address book name details
// @Description 地址簿名称详情 // @Description address book name details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -37,13 +37,13 @@ func (abc *AddressBookCollection) Detail(c *gin.Context) {
return return
} }
// Create 创建地址簿名称 // Create create address book name
// @Tags 地址簿名称 // @Tags address book name
// @Summary 创建地址簿名称 // @Summary create address book name
// @Description 创建地址簿名称 // @Description create address book name
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollection true "地址簿名称信息" // @Param body body model.AddressBookCollection true "address book name info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection/create [post] // @Router /admin/address_book_collection/create [post]
@@ -72,16 +72,16 @@ func (abc *AddressBookCollection) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 地址簿名称 // @Tags address book name
// @Summary 地址簿名称列表 // @Summary address book name list
// @Description 地址簿名称列表 // @Description address book name list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param is_my query int false "是否是我的" // @Param is_my query int false "whether it is mine"
// @Param user_id query int false "用户id" // @Param user_id query int false "userid"
// @Success 200 {object} response.Response{data=model.AddressBookCollectionList} // @Success 200 {object} response.Response{data=model.AddressBookCollectionList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection/list [get] // @Router /admin/address_book_collection/list [get]
@@ -100,13 +100,13 @@ func (abc *AddressBookCollection) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 地址簿名称 // @Tags address book name
// @Summary 地址簿名称编辑 // @Summary edit address book name
// @Description 地址簿名称编辑 // @Description edit address book name
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollection true "地址簿名称信息" // @Param body body model.AddressBookCollection true "address book name info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection/update [post] // @Router /admin/address_book_collection/update [post]
@@ -135,13 +135,13 @@ func (abc *AddressBookCollection) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 地址簿名称 // @Tags address book name
// @Summary 地址簿名称删除 // @Summary delete address book name
// @Description 地址簿名称删除 // @Description delete address book name
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollection true "地址簿名称信息" // @Param body body model.AddressBookCollection true "address book name info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection/delete [post] // @Router /admin/address_book_collection/delete [post]
@@ -14,17 +14,17 @@ import (
type AddressBookCollectionRule struct { type AddressBookCollectionRule struct {
} }
// List 列表 // List list
// @Tags 地址簿规则 // @Tags address book rules
// @Summary 地址簿规则列表 // @Summary address book rule list
// @Description 地址簿规则列表 // @Description address book rule list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param is_my query int false "是否是我的" // @Param is_my query int false "whether it is mine"
// @Param user_id query int false "用户id" // @Param user_id query int false "userid"
// @Param collection_id query int false "地址簿集合id" // @Param collection_id query int false "address book collectionid"
// @Success 200 {object} response.Response{data=model.AddressBookCollectionList} // @Success 200 {object} response.Response{data=model.AddressBookCollectionList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection_rule/list [get] // @Router /admin/address_book_collection_rule/list [get]
@@ -47,10 +47,10 @@ func (abcr *AddressBookCollectionRule) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Detail 地址簿规则 // Detail address book rules
// @Tags 地址簿规则 // @Tags address book rules
// @Summary 地址簿规则详情 // @Summary address book rule details
// @Description 地址簿规则详情 // @Description address book rule details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -69,13 +69,13 @@ func (abcr *AddressBookCollectionRule) Detail(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound")) response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
} }
// Create 创建地址簿规则 // Create create address book rule
// @Tags 地址簿规则 // @Tags address book rules
// @Summary 创建地址簿规则 // @Summary create address book rule
// @Description 创建地址簿规则 // @Description create address book rule
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollectionRule true "地址簿规则信息" // @Param body body model.AddressBookCollectionRule true "address book rule info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection_rule/create [post] // @Router /admin/address_book_collection_rule/create [post]
@@ -134,7 +134,7 @@ func (abcr *AddressBookCollectionRule) CheckForm(t *model.AddressBookCollectionR
} else { } else {
return "ParamsError", false return "ParamsError", false
} }
// 重复检查 // duplicate check
ex := service.AllService.AddressBookService.RuleInfoByToIdAndCid(t.Type, t.ToId, t.CollectionId) ex := service.AllService.AddressBookService.RuleInfoByToIdAndCid(t.Type, t.ToId, t.CollectionId)
if t.Id == 0 && ex.Id > 0 { if t.Id == 0 && ex.Id > 0 {
return "ItemExists", false return "ItemExists", false
@@ -145,13 +145,13 @@ func (abcr *AddressBookCollectionRule) CheckForm(t *model.AddressBookCollectionR
return "", true return "", true
} }
// Update 编辑 // Update edit
// @Tags 地址簿规则 // @Tags address book rules
// @Summary 地址簿规则编辑 // @Summary edit address book rule
// @Description 地址簿规则编辑 // @Description edit address book rule
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollectionRule true "地址簿规则信息" // @Param body body model.AddressBookCollectionRule true "address book rule info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection_rule/update [post] // @Router /admin/address_book_collection_rule/update [post]
@@ -185,13 +185,13 @@ func (abcr *AddressBookCollectionRule) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 地址簿规则 // @Tags address book rules
// @Summary 地址簿规则删除 // @Summary delete address book rule
// @Description 地址簿规则删除 // @Description delete address book rule
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollectionRule true "地址簿规则信息" // @Param body body model.AddressBookCollectionRule true "address book rule info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/address_book_collection_rule/delete [post] // @Router /admin/address_book_collection_rule/delete [post]
+36 -36
View File
@@ -13,16 +13,16 @@ import (
type Audit struct { type Audit struct {
} }
// ConnList 列表 // ConnList list
// @Tags 链接日志 // @Tags connection log
// @Summary 链接日志列表 // @Summary connection log list
// @Description 链接日志列表 // @Description connection log list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param peer_id query int false "目标设备" // @Param peer_id query int false "target device"
// @Param from_peer query int false "来源设备" // @Param from_peer query int false "source device"
// @Success 200 {object} response.Response{data=model.AuditConnList} // @Success 200 {object} response.Response{data=model.AuditConnList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/audit_conn/list [get] // @Router /admin/audit_conn/list [get]
@@ -45,13 +45,13 @@ func (a *Audit) ConnList(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// ConnDelete 删除 // ConnDelete delete
// @Tags 链接日志 // @Tags connection log
// @Summary 链接日志删除 // @Summary delete connection log
// @Description 链接日志删除 // @Description delete connection log
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AuditConn true "链接日志信息" // @Param body body model.AuditConn true "connection log info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/audit_conn/delete [post] // @Router /admin/audit_conn/delete [post]
@@ -81,13 +81,13 @@ func (a *Audit) ConnDelete(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound")) response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
} }
// BatchConnDelete 删除 // BatchConnDelete delete
// @Tags 链接日志 // @Tags connection log
// @Summary 链接日志批量删除 // @Summary batch delete connection logs
// @Description 链接日志批量删除 // @Description batch delete connection logs
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AuditConnLogIds true "链接日志" // @Param body body admin.AuditConnLogIds true "connection log"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/audit_conn/batchDelete [post] // @Router /admin/audit_conn/batchDelete [post]
@@ -112,16 +112,16 @@ func (a *Audit) BatchConnDelete(c *gin.Context) {
return return
} }
// FileList 列表 // FileList list
// @Tags 文件日志 // @Tags file log
// @Summary 文件日志列表 // @Summary file log list
// @Description 文件日志列表 // @Description file log list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param peer_id query int false "目标设备" // @Param peer_id query int false "target device"
// @Param from_peer query int false "来源设备" // @Param from_peer query int false "source device"
// @Success 200 {object} response.Response{data=model.AuditFileList} // @Success 200 {object} response.Response{data=model.AuditFileList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/audit_file/list [get] // @Router /admin/audit_file/list [get]
@@ -144,13 +144,13 @@ func (a *Audit) FileList(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// FileDelete 删除 // FileDelete delete
// @Tags 文件日志 // @Tags file log
// @Summary 文件日志删除 // @Summary delete file log
// @Description 文件日志删除 // @Description delete file log
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AuditFile true "文件日志信息" // @Param body body model.AuditFile true "file log info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/audit_file/delete [post] // @Router /admin/audit_file/delete [post]
@@ -180,13 +180,13 @@ func (a *Audit) FileDelete(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound")) response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
} }
// BatchFileDelete 删除 // BatchFileDelete delete
// @Tags 文件日志 // @Tags file log
// @Summary 文件日志批量删除 // @Summary batch delete file logs
// @Description 文件日志批量删除 // @Description batch delete file logs
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AuditFileLogIds true "文件日志" // @Param body body admin.AuditFileLogIds true "file log"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/audit_file/batchDelete [post] // @Router /admin/audit_file/batchDelete [post]
+9 -9
View File
@@ -13,10 +13,10 @@ import (
type Config struct { type Config struct {
} }
// ServerConfig RUSTDESK服务配置 // ServerConfig RUSTDESKservice config
// @Tags ADMIN // @Tags ADMIN
// @Summary RUSTDESK服务配置 // @Summary RUSTDESKservice config
// @Description 服务配置,给webclient提供api-server // @Description service config, provides an api-server for the webclient
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -33,10 +33,10 @@ func (co *Config) ServerConfig(c *gin.Context) {
response.Success(c, cf) response.Success(c, cf)
} }
// AppConfig APP服务配置 // AppConfig APPservice config
// @Tags ADMIN // @Tags ADMIN
// @Summary APP服务配置 // @Summary APPservice config
// @Description APP服务配置 // @Description APPservice config
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -49,10 +49,10 @@ func (co *Config) AppConfig(c *gin.Context) {
}) })
} }
// AdminConfig ADMIN服务配置 // AdminConfig ADMINservice config
// @Tags ADMIN // @Tags ADMIN
// @Summary ADMIN服务配置 // @Summary ADMINservice config
// @Description ADMIN服务配置 // @Description ADMINservice config
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
+25 -25
View File
@@ -12,10 +12,10 @@ import (
type DeviceGroup struct { type DeviceGroup struct {
} }
// Detail 设备群组 // Detail device group
// @Tags 设备群组 // @Tags device group
// @Summary 设备群组详情 // @Summary device group details
// @Description 设备群组详情 // @Description device group details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -35,13 +35,13 @@ func (ct *DeviceGroup) Detail(c *gin.Context) {
return return
} }
// Create 创建设备群组 // Create create device group
// @Tags 设备群组 // @Tags device group
// @Summary 创建设备群组 // @Summary create device group
// @Description 创建设备群组 // @Description create device group
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.DeviceGroupForm true "设备群组信息" // @Param body body admin.DeviceGroupForm true "device group info"
// @Success 200 {object} response.Response{data=model.DeviceGroup} // @Success 200 {object} response.Response{data=model.DeviceGroup}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/device_group/create [post] // @Router /admin/device_group/create [post]
@@ -66,14 +66,14 @@ func (ct *DeviceGroup) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 群组 // @Tags group
// @Summary 群组列表 // @Summary group list
// @Description 群组列表 // @Description group list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Success 200 {object} response.Response{data=model.GroupList} // @Success 200 {object} response.Response{data=model.GroupList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/device_group/list [get] // @Router /admin/device_group/list [get]
@@ -88,13 +88,13 @@ func (ct *DeviceGroup) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 设备群组 // @Tags device group
// @Summary 设备群组编辑 // @Summary edit device group
// @Description 设备群组编辑 // @Description edit device group
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.DeviceGroupForm true "群组信息" // @Param body body admin.DeviceGroupForm true "group info"
// @Success 200 {object} response.Response{data=model.Group} // @Success 200 {object} response.Response{data=model.Group}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/device_group/update [post] // @Router /admin/device_group/update [post]
@@ -123,13 +123,13 @@ func (ct *DeviceGroup) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 设备群组 // @Tags device group
// @Summary 设备群组删除 // @Summary delete device group
// @Description 设备群组删除 // @Description delete device group
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.DeviceGroupForm true "群组信息" // @Param body body admin.DeviceGroupForm true "group info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/device_group/delete [post] // @Router /admin/device_group/delete [post]
+12 -12
View File
@@ -13,10 +13,10 @@ import (
type File struct { type File struct {
} }
// OssToken 文件 // OssToken file
// @Tags 文件 // @Tags file
// @Summary 获取ossToken // @Summary getossToken
// @Description 获取ossToken // @Description getossToken
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -33,7 +33,7 @@ type FileBack struct {
Url string `json:"url"` Url string `json:"url"`
} }
// Notify 上传成功后回调 // Notify callback after successful upload
func (f *File) Notify(c *gin.Context) { func (f *File) Notify(c *gin.Context) {
res := global.Oss.Verify(c.Request) res := global.Oss.Verify(c.Request)
@@ -50,13 +50,13 @@ func (f *File) Notify(c *gin.Context) {
} }
// Upload 上传文件到本地 // Upload upload file to local
// @Tags 文件 // @Tags file
// @Summary 上传文件到本地 // @Summary upload file to local
// @Description 上传文件到本地 // @Description upload file to local
// @Accept multipart/form-data // @Accept multipart/form-data
// @Produce json // @Produce json
// @Param file formData file true "上传文件示例" // @Param file formData file true "file upload example"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/file/upload [post] // @Router /admin/file/upload [post]
@@ -71,12 +71,12 @@ func (f *File) Upload(c *gin.Context) {
if err != nil { if err != nil {
return return
} }
// 上传文件至指定目录 // upload the file to the specified directory
err = c.SaveUploadedFile(file, dst) err = c.SaveUploadedFile(file, dst)
if err != nil { if err != nil {
return return
} }
// 返回文件web地址 // return filewebaddress
response.Success(c, gin.H{ response.Success(c, gin.H{
"url": webPath + file.Filename, "url": webPath + file.Filename,
}) })
+25 -25
View File
@@ -12,10 +12,10 @@ import (
type Group struct { type Group struct {
} }
// Detail 群组 // Detail group
// @Tags 群组 // @Tags group
// @Summary 群组详情 // @Summary group details
// @Description 群组详情 // @Description group details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -35,13 +35,13 @@ func (ct *Group) Detail(c *gin.Context) {
return return
} }
// Create 创建群组 // Create create group
// @Tags 群组 // @Tags group
// @Summary 创建群组 // @Summary create group
// @Description 创建群组 // @Description create group
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.GroupForm true "群组信息" // @Param body body admin.GroupForm true "group info"
// @Success 200 {object} response.Response{data=model.Group} // @Success 200 {object} response.Response{data=model.Group}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/group/create [post] // @Router /admin/group/create [post]
@@ -66,14 +66,14 @@ func (ct *Group) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 群组 // @Tags group
// @Summary 群组列表 // @Summary group list
// @Description 群组列表 // @Description group list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Success 200 {object} response.Response{data=model.GroupList} // @Success 200 {object} response.Response{data=model.GroupList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/group/list [get] // @Router /admin/group/list [get]
@@ -88,13 +88,13 @@ func (ct *Group) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 群组 // @Tags group
// @Summary 群组编辑 // @Summary edit group
// @Description 群组编辑 // @Description edit group
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.GroupForm true "群组信息" // @Param body body admin.GroupForm true "group info"
// @Success 200 {object} response.Response{data=model.Group} // @Success 200 {object} response.Response{data=model.Group}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/group/update [post] // @Router /admin/group/update [post]
@@ -123,13 +123,13 @@ func (ct *Group) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 群组 // @Tags group
// @Summary 群组删除 // @Summary delete group
// @Description 群组删除 // @Description delete group
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.GroupForm true "群组信息" // @Param body body admin.GroupForm true "group info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/group/delete [post] // @Router /admin/group/delete [post]
+15 -15
View File
@@ -17,13 +17,13 @@ import (
type Login struct { type Login struct {
} }
// Login 登录 // Login login
// @Tags 登录 // @Tags login
// @Summary 登录 // @Summary login
// @Description 登录 // @Description login
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.Login true "登录信息" // @Param body body admin.Login true "login info"
// @Success 200 {object} response.Response{data=adResp.LoginPayload} // @Success 200 {object} response.Response{data=adResp.LoginPayload}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/login [post] // @Router /admin/login [post]
@@ -34,7 +34,7 @@ func (ct *Login) Login(c *gin.Context) {
return return
} }
// 检查登录限制 // check login limit
loginLimiter := global.LoginLimiter loginLimiter := global.LoginLimiter
clientIp := c.ClientIP() clientIp := c.ClientIP()
_, needCaptcha := loginLimiter.CheckSecurityStatus(clientIp) _, needCaptcha := loginLimiter.CheckSecurityStatus(clientIp)
@@ -56,7 +56,7 @@ func (ct *Login) Login(c *gin.Context) {
return return
} }
// 检查是否需要验证码 // check whether a captcha is required
if needCaptcha { if needCaptcha {
if f.CaptchaId == "" || f.Captcha == "" || !loginLimiter.VerifyCaptcha(f.CaptchaId, f.Captcha) { if f.CaptchaId == "" || f.Captcha == "" || !loginLimiter.VerifyCaptcha(f.CaptchaId, f.Captcha) {
response.Fail(c, 101, response.TranslateMsg(c, "CaptchaError")) response.Fail(c, 101, response.TranslateMsg(c, "CaptchaError"))
@@ -95,7 +95,7 @@ func (ct *Login) Login(c *gin.Context) {
Platform: f.Platform, Platform: f.Platform,
}) })
// 登录成功,清除登录限制 // login successful, clear the login limit
loginLimiter.RemoveAttempts(clientIp) loginLimiter.RemoveAttempts(clientIp)
responseLoginSuccess(c, u, ut.Token) responseLoginSuccess(c, u, ut.Token)
} }
@@ -129,10 +129,10 @@ func (ct *Login) Captcha(c *gin.Context) {
}) })
} }
// Logout 登出 // Logout logout
// @Tags 登录 // @Tags login
// @Summary 登出 // @Summary logout
// @Description 登出 // @Description logout
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -148,9 +148,9 @@ func (ct *Login) Logout(c *gin.Context) {
} }
// LoginOptions // LoginOptions
// @Tags 登录 // @Tags login
// @Summary 登录选项 // @Summary login options
// @Description 登录选项 // @Description login options
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} []string // @Success 200 {object} []string
+21 -21
View File
@@ -14,10 +14,10 @@ import (
type LoginLog struct { type LoginLog struct {
} }
// Detail 登录日志 // Detail login log
// @Tags 登录日志 // @Tags login log
// @Summary 登录日志详情 // @Summary login log details
// @Description 登录日志详情 // @Description login log details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -37,15 +37,15 @@ func (ct *LoginLog) Detail(c *gin.Context) {
return return
} }
// List 列表 // List list
// @Tags 登录日志 // @Tags login log
// @Summary 登录日志列表 // @Summary login log list
// @Description 登录日志列表 // @Description login log list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param user_id query int false "用户ID" // @Param user_id query int false "userID"
// @Success 200 {object} response.Response{data=model.LoginLogList} // @Success 200 {object} response.Response{data=model.LoginLogList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/login_log/list [get] // @Router /admin/login_log/list [get]
@@ -65,13 +65,13 @@ func (ct *LoginLog) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Delete 删除 // Delete delete
// @Tags 登录日志 // @Tags login log
// @Summary 登录日志删除 // @Summary delete login log
// @Description 登录日志删除 // @Description delete login log
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.LoginLog true "登录日志信息" // @Param body body model.LoginLog true "login log info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/login_log/delete [post] // @Router /admin/login_log/delete [post]
@@ -101,13 +101,13 @@ func (ct *LoginLog) Delete(c *gin.Context) {
response.Fail(c, 101, err.Error()) response.Fail(c, 101, err.Error())
} }
// BatchDelete 删除 // BatchDelete delete
// @Tags 登录日志 // @Tags login log
// @Summary 登录日志批量删除 // @Summary batch delete login logs
// @Description 登录日志批量删除 // @Description batch delete login logs
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.LoginLogIds true "登录日志" // @Param body body admin.LoginLogIds true "login log"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/login_log/batchDelete [post] // @Router /admin/login_log/batchDelete [post]
+23 -23
View File
@@ -12,15 +12,15 @@ import (
type AddressBook struct{} type AddressBook struct{}
// List 列表 // List list
// @Tags 我的地址簿 // @Tags my address book
// @Summary 地址簿列表 // @Summary address book list
// @Description 地址簿列表 // @Description address book list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param user_id query int false "用户id" // @Param user_id query int false "userid"
// @Success 200 {object} response.Response{data=model.AddressBookList} // @Success 200 {object} response.Response{data=model.AddressBookList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book/list [get] // @Router /admin/my/address_book/list [get]
@@ -34,7 +34,7 @@ func (ct *AddressBook) List(c *gin.Context) {
u := service.AllService.UserService.CurUser(c) u := service.AllService.UserService.CurUser(c)
query.UserId = int(u.Id) query.UserId = int(u.Id)
res := service.AllService.AddressBookService.List(query.Page, query.PageSize, func(tx *gorm.DB) { res := service.AllService.AddressBookService.List(query.Page, query.PageSize, func(tx *gorm.DB) {
//预加载地址簿名称 //preload address book name
tx.Preload("Collection", func(txc *gorm.DB) *gorm.DB { tx.Preload("Collection", func(txc *gorm.DB) *gorm.DB {
return txc.Select("id,name") return txc.Select("id,name")
}) })
@@ -60,13 +60,13 @@ func (ct *AddressBook) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Create 创建地址簿 // Create create address book
// @Tags 我的地址簿 // @Tags my address book
// @Summary 创建地址簿 // @Summary create address book
// @Description 创建地址簿 // @Description create address book
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AddressBookForm true "地址簿信息" // @Param body body admin.AddressBookForm true "address book info"
// @Success 200 {object} response.Response{data=model.AddressBook} // @Success 200 {object} response.Response{data=model.AddressBook}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book/create [post] // @Router /admin/my/address_book/create [post]
@@ -104,13 +104,13 @@ func (ct *AddressBook) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Update 编辑 // Update edit
// @Tags 我的地址簿 // @Tags my address book
// @Summary 地址簿编辑 // @Summary edit address book
// @Description 地址簿编辑 // @Description edit address book
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AddressBookForm true "地址簿信息" // @Param body body admin.AddressBookForm true "address book info"
// @Success 200 {object} response.Response{data=model.AddressBook} // @Success 200 {object} response.Response{data=model.AddressBook}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book/update [post] // @Router /admin/my/address_book/update [post]
@@ -158,13 +158,13 @@ func (ct *AddressBook) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 我的地址簿 // @Tags my address book
// @Summary 地址簿删除 // @Summary delete address book
// @Description 地址簿删除 // @Description delete address book
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.AddressBookForm true "地址簿信息" // @Param body body admin.AddressBookForm true "address book info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book/delete [post] // @Router /admin/my/address_book/delete [post]
@@ -13,13 +13,13 @@ import (
type AddressBookCollection struct { type AddressBookCollection struct {
} }
// Create 创建地址簿名称 // Create create address book name
// @Tags 我的地址簿名称 // @Tags my address book name
// @Summary 创建地址簿名称 // @Summary create address book name
// @Description 创建地址簿名称 // @Description create address book name
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollection true "地址簿名称信息" // @Param body body model.AddressBookCollection true "address book name info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection/create [post] // @Router /admin/my/address_book_collection/create [post]
@@ -45,14 +45,14 @@ func (abc *AddressBookCollection) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 我的地址簿名称 // @Tags my address book name
// @Summary 地址簿名称列表 // @Summary address book name list
// @Description 地址簿名称列表 // @Description address book name list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Success 200 {object} response.Response{data=model.AddressBookCollectionList} // @Success 200 {object} response.Response{data=model.AddressBookCollectionList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection/list [get] // @Router /admin/my/address_book_collection/list [get]
@@ -71,13 +71,13 @@ func (abc *AddressBookCollection) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 我的地址簿名称 // @Tags my address book name
// @Summary 地址簿名称编辑 // @Summary edit address book name
// @Description 地址簿名称编辑 // @Description edit address book name
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollection true "地址簿名称信息" // @Param body body model.AddressBookCollection true "address book name info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection/update [post] // @Router /admin/my/address_book_collection/update [post]
@@ -120,13 +120,13 @@ func (abc *AddressBookCollection) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 我的地址簿名称 // @Tags my address book name
// @Summary 地址簿名称删除 // @Summary delete address book name
// @Description 地址簿名称删除 // @Description delete address book name
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollection true "地址簿名称信息" // @Param body body model.AddressBookCollection true "address book name info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection/delete [post] // @Router /admin/my/address_book_collection/delete [post]
@@ -13,17 +13,17 @@ import (
type AddressBookCollectionRule struct { type AddressBookCollectionRule struct {
} }
// List 列表 // List list
// @Tags 我的地址簿规则 // @Tags my address book rules
// @Summary 地址簿规则列表 // @Summary address book rule list
// @Description 地址簿规则列表 // @Description address book rule list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param is_my query int false "是否是我的" // @Param is_my query int false "whether it is mine"
// @Param user_id query int false "用户id" // @Param user_id query int false "userid"
// @Param collection_id query int false "地址簿集合id" // @Param collection_id query int false "address book collectionid"
// @Success 200 {object} response.Response{data=model.AddressBookCollectionList} // @Success 200 {object} response.Response{data=model.AddressBookCollectionList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection_rule/list [get] // @Router /admin/my/address_book_collection_rule/list [get]
@@ -46,13 +46,13 @@ func (abcr *AddressBookCollectionRule) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Create 创建地址簿规则 // Create create address book rule
// @Tags 我的地址簿规则 // @Tags my address book rules
// @Summary 创建地址簿规则 // @Summary create address book rule
// @Description 创建地址簿规则 // @Description create address book rule
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollectionRule true "地址簿规则信息" // @Param body body model.AddressBookCollectionRule true "address book rule info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection_rule/create [post] // @Router /admin/my/address_book_collection_rule/create [post]
@@ -106,12 +106,12 @@ func (abcr *AddressBookCollectionRule) CheckForm(u *model.User, t *model.Address
if tou.Id == 0 { if tou.Id == 0 {
return "ItemNotFound", false return "ItemNotFound", false
} }
//非管理员不能分享给非本组织用户 //non-admins cannot share with users outside their own organization
//if tou.GroupId != u.GroupId { //if tou.GroupId != u.GroupId {
// return "NoAccess", false // return "NoAccess", false
//} //}
} else if t.Type == model.ShareAddressBookRuleTypeGroup { } else if t.Type == model.ShareAddressBookRuleTypeGroup {
//非管理员不能分享给其他组 //non-admins cannot share with other groups
//if t.ToId != u.GroupId { //if t.ToId != u.GroupId {
// return "NoAccess", false // return "NoAccess", false
//} //}
@@ -123,7 +123,7 @@ func (abcr *AddressBookCollectionRule) CheckForm(u *model.User, t *model.Address
} else { } else {
return "ParamsError", false return "ParamsError", false
} }
// 重复检查 // duplicate check
ex := service.AllService.AddressBookService.RuleInfoByToIdAndCid(t.Type, t.ToId, t.CollectionId) ex := service.AllService.AddressBookService.RuleInfoByToIdAndCid(t.Type, t.ToId, t.CollectionId)
if t.Id == 0 && ex.Id > 0 { if t.Id == 0 && ex.Id > 0 {
return "ItemExists", false return "ItemExists", false
@@ -134,13 +134,13 @@ func (abcr *AddressBookCollectionRule) CheckForm(u *model.User, t *model.Address
return "", true return "", true
} }
// Update 编辑 // Update edit
// @Tags 我的地址簿规则 // @Tags my address book rules
// @Summary 地址簿规则编辑 // @Summary edit address book rule
// @Description 地址簿规则编辑 // @Description edit address book rule
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollectionRule true "地址簿规则信息" // @Param body body model.AddressBookCollectionRule true "address book rule info"
// @Success 200 {object} response.Response{data=model.AddressBookCollection} // @Success 200 {object} response.Response{data=model.AddressBookCollection}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection_rule/update [post] // @Router /admin/my/address_book_collection_rule/update [post]
@@ -185,13 +185,13 @@ func (abcr *AddressBookCollectionRule) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 我的地址簿规则 // @Tags my address book rules
// @Summary 地址簿规则删除 // @Summary delete address book rule
// @Description 地址簿规则删除 // @Description delete address book rule
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.AddressBookCollectionRule true "地址簿规则信息" // @Param body body model.AddressBookCollectionRule true "address book rule info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/address_book_collection_rule/delete [post] // @Router /admin/my/address_book_collection_rule/delete [post]
+17 -17
View File
@@ -13,15 +13,15 @@ import (
type LoginLog struct { type LoginLog struct {
} }
// List 列表 // List list
// @Tags 我的登录日志 // @Tags my login logs
// @Summary 登录日志列表 // @Summary login log list
// @Description 登录日志列表 // @Description login log list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param user_id query int false "用户ID" // @Param user_id query int false "userID"
// @Success 200 {object} response.Response{data=model.LoginLogList} // @Success 200 {object} response.Response{data=model.LoginLogList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/login_log/list [get] // @Router /admin/my/login_log/list [get]
@@ -40,13 +40,13 @@ func (ct *LoginLog) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Delete 删除 // Delete delete
// @Tags 我的登录日志 // @Tags my login logs
// @Summary 登录日志删除 // @Summary delete login log
// @Description 登录日志删除 // @Description delete login log
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.LoginLog true "登录日志信息" // @Param body body model.LoginLog true "login log info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/login_log/delete [post] // @Router /admin/my/login_log/delete [post]
@@ -81,13 +81,13 @@ func (ct *LoginLog) Delete(c *gin.Context) {
response.Fail(c, 101, err.Error()) response.Fail(c, 101, err.Error())
} }
// BatchDelete 删除 // BatchDelete delete
// @Tags 我的登录日志 // @Tags my login logs
// @Summary 登录日志批量删除 // @Summary batch delete login logs
// @Description 登录日志批量删除 // @Description batch delete login logs
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.LoginLogIds true "登录日志" // @Param body body admin.LoginLogIds true "login log"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/login_log/batchDelete [post] // @Router /admin/my/login_log/batchDelete [post]
+9 -9
View File
@@ -12,18 +12,18 @@ import (
type Peer struct { type Peer struct {
} }
// List 列表 // List list
// @Tags 我的设备 // @Tags my devices
// @Summary 设备列表 // @Summary device list
// @Description 设备列表 // @Description device list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param time_ago query int false "时间" // @Param time_ago query int false "time"
// @Param id query string false "ID" // @Param id query string false "ID"
// @Param hostname query string false "主机名" // @Param hostname query string false "hostname"
// @Param uuids query string false "uuids 用逗号分隔" // @Param uuids query string false "uuids separated by commas"
// @Success 200 {object} response.Response{data=model.PeerList} // @Success 200 {object} response.Response{data=model.PeerList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/peer/list [get] // @Router /admin/my/peer/list [get]
+15 -15
View File
@@ -12,14 +12,14 @@ import (
type ShareRecord struct { type ShareRecord struct {
} }
// List 分享记录列表 // List share record list
// @Tags 我的分享记录 // @Tags my share records
// @Summary 分享记录列表 // @Summary share record list
// @Description 分享记录列表 // @Description share record list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/share_record/list [get] // @Router /admin/my/share_record/list [get]
@@ -37,13 +37,13 @@ func (sr *ShareRecord) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Delete 分享记录删除 // Delete delete share record
// @Tags 我的分享记录 // @Tags my share records
// @Summary 分享记录删除 // @Summary delete share record
// @Description 分享记录删除 // @Description delete share record
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.ShareRecordForm true "分享记录信息" // @Param body body admin.ShareRecordForm true "share record info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/share_record/delete [post] // @Router /admin/my/share_record/delete [post]
@@ -78,10 +78,10 @@ func (sr *ShareRecord) Delete(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "OperationFailed")+err.Error()) response.Fail(c, 101, response.TranslateMsg(c, "OperationFailed")+err.Error())
} }
// BatchDelete 批量删除我的分享记录 // BatchDelete batch delete my share records
// @Tags 我的 // @Tags my
// @Summary 批量删除我的分享记录 // @Summary batch delete my share records
// @Description 批量删除我的分享记录 // @Description batch delete my share records
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.PeerShareRecordBatchDeleteForm true "id" // @Param body body admin.PeerShareRecordBatchDeleteForm true "id"
+23 -23
View File
@@ -11,16 +11,16 @@ import (
type Tag struct{} type Tag struct{}
// List 列表 // List list
// @Tags 我的标签 // @Tags my tags
// @Summary 标签列表 // @Summary tag list
// @Description 标签列表 // @Description tag list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param is_my query int false "是否是我的" // @Param is_my query int false "whether it is mine"
// @Param user_id query int false "用户id" // @Param user_id query int false "userid"
// @Success 200 {object} response.Response{data=model.TagList} // @Success 200 {object} response.Response{data=model.TagList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/tag/list [get] // @Router /admin/my/tag/list [get]
@@ -45,13 +45,13 @@ func (ct *Tag) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Create 创建标签 // Create create tag
// @Tags 我的标签 // @Tags my tags
// @Summary 创建标签 // @Summary create tag
// @Description 创建标签 // @Description create tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.TagForm true "标签信息" // @Param body body admin.TagForm true "tag info"
// @Success 200 {object} response.Response{data=model.Tag} // @Success 200 {object} response.Response{data=model.Tag}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/tag/create [post] // @Router /admin/my/tag/create [post]
@@ -78,13 +78,13 @@ func (ct *Tag) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Update 编辑 // Update edit
// @Tags 我的标签 // @Tags my tags
// @Summary 标签编辑 // @Summary edit tag
// @Description 标签编辑 // @Description edit tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.TagForm true "标签信息" // @Param body body admin.TagForm true "tag info"
// @Success 200 {object} response.Response{data=model.Tag} // @Success 200 {object} response.Response{data=model.Tag}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/tag/update [post] // @Router /admin/my/tag/update [post]
@@ -133,13 +133,13 @@ func (ct *Tag) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 标签 // @Tags tag
// @Summary 标签删除 // @Summary delete tag
// @Description 标签删除 // @Description delete tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.TagForm true "标签信息" // @Param body body admin.TagForm true "tag info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/my/tag/delete [post] // @Router /admin/my/tag/delete [post]
+20 -20
View File
@@ -64,7 +64,7 @@ func (o *Oauth) ToBind(c *gin.Context) {
}) })
} }
// Confirm 确认授权登录 // Confirm confirm authorized login
func (o *Oauth) Confirm(c *gin.Context) { func (o *Oauth) Confirm(c *gin.Context) {
j := &adminReq.OauthConfirmForm{} j := &adminReq.OauthConfirmForm{}
err := c.ShouldBindJSON(j) err := c.ShouldBindJSON(j)
@@ -140,8 +140,8 @@ func (o *Oauth) Unbind(c *gin.Context) {
// Detail Oauth // Detail Oauth
// @Tags Oauth // @Tags Oauth
// @Summary Oauth详情 // @Summary Oauthdetails
// @Description Oauth详情 // @Description Oauthdetails
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -161,13 +161,13 @@ func (o *Oauth) Detail(c *gin.Context) {
return return
} }
// Create 创建Oauth // Create createOauth
// @Tags Oauth // @Tags Oauth
// @Summary 创建Oauth // @Summary createOauth
// @Description 创建Oauth // @Description createOauth
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.OauthForm true "Oauth信息" // @Param body body admin.OauthForm true "Oauthinfo"
// @Success 200 {object} response.Response{data=model.Oauth} // @Success 200 {object} response.Response{data=model.Oauth}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/oauth/create [post] // @Router /admin/oauth/create [post]
@@ -202,14 +202,14 @@ func (o *Oauth) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags Oauth // @Tags Oauth
// @Summary Oauth列表 // @Summary Oauthlist
// @Description Oauth列表 // @Description Oauthlist
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Success 200 {object} response.Response{data=model.OauthList} // @Success 200 {object} response.Response{data=model.OauthList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/oauth/list [get] // @Router /admin/oauth/list [get]
@@ -224,13 +224,13 @@ func (o *Oauth) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags Oauth // @Tags Oauth
// @Summary Oauth编辑 // @Summary Oauthedit
// @Description Oauth编辑 // @Description Oauthedit
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.OauthForm true "Oauth信息" // @Param body body admin.OauthForm true "Oauthinfo"
// @Success 200 {object} response.Response{data=model.OauthList} // @Success 200 {object} response.Response{data=model.OauthList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/oauth/update [post] // @Router /admin/oauth/update [post]
@@ -259,13 +259,13 @@ func (o *Oauth) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags Oauth // @Tags Oauth
// @Summary Oauth删除 // @Summary Oauthdelete
// @Description Oauth删除 // @Description Oauthdelete
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.OauthForm true "Oauth信息" // @Param body body admin.OauthForm true "Oauthinfo"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/oauth/delete [post] // @Router /admin/oauth/delete [post]
+34 -34
View File
@@ -14,10 +14,10 @@ import (
type Peer struct { type Peer struct {
} }
// Detail 设备 // Detail device
// @Tags 设备 // @Tags device
// @Summary 设备详情 // @Summary device details
// @Description 设备详情 // @Description device details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -37,13 +37,13 @@ func (ct *Peer) Detail(c *gin.Context) {
return return
} }
// Create 创建设备 // Create create device
// @Tags 设备 // @Tags device
// @Summary 创建设备 // @Summary create device
// @Description 创建设备 // @Description create device
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.PeerForm true "设备信息" // @Param body body admin.PeerForm true "device info"
// @Success 200 {object} response.Response{data=model.Peer} // @Success 200 {object} response.Response{data=model.Peer}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/peer/create [post] // @Router /admin/peer/create [post]
@@ -68,18 +68,18 @@ func (ct *Peer) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 设备 // @Tags device
// @Summary 设备列表 // @Summary device list
// @Description 设备列表 // @Description device list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param time_ago query int false "时间" // @Param time_ago query int false "time"
// @Param id query string false "ID" // @Param id query string false "ID"
// @Param hostname query string false "主机名" // @Param hostname query string false "hostname"
// @Param uuids query string false "uuids 用逗号分隔" // @Param uuids query string false "uuids separated by commas"
// @Success 200 {object} response.Response{data=model.PeerList} // @Success 200 {object} response.Response{data=model.PeerList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/peer/list [get] // @Router /admin/peer/list [get]
@@ -121,13 +121,13 @@ func (ct *Peer) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 设备 // @Tags device
// @Summary 设备编辑 // @Summary edit device
// @Description 设备编辑 // @Description edit device
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.PeerForm true "设备信息" // @Param body body admin.PeerForm true "device info"
// @Success 200 {object} response.Response{data=model.Peer} // @Success 200 {object} response.Response{data=model.Peer}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/peer/update [post] // @Router /admin/peer/update [post]
@@ -156,13 +156,13 @@ func (ct *Peer) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 设备 // @Tags device
// @Summary 设备删除 // @Summary delete device
// @Description 设备删除 // @Description delete device
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.PeerForm true "设备信息" // @Param body body admin.PeerForm true "device info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/peer/delete [post] // @Router /admin/peer/delete [post]
@@ -192,13 +192,13 @@ func (ct *Peer) Delete(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound")) response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
} }
// BatchDelete 批量删除 // BatchDelete batch delete
// @Tags 设备 // @Tags device
// @Summary 批量设备删除 // @Summary batch delete devices
// @Description 批量设备删除 // @Description batch delete devices
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.PeerBatchDeleteForm true "设备id" // @Param body body admin.PeerBatchDeleteForm true "deviceid"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/peer/batchDelete [post] // @Router /admin/peer/batchDelete [post]
@@ -232,7 +232,7 @@ func (ct *Peer) SimpleData(c *gin.Context) {
return return
} }
res := service.AllService.PeerService.List(1, 99999, func(tx *gorm.DB) { res := service.AllService.PeerService.List(1, 99999, func(tx *gorm.DB) {
//可以公开的情报 //information that can be made public
tx.Select("id,version") tx.Select("id,version")
tx.Where("id in (?)", f.Ids) tx.Where("id in (?)", f.Ids)
}) })
+1 -1
View File
@@ -25,7 +25,7 @@ func (r *Rustdesk) CmdList(c *gin.Context) {
return return
} }
res := service.AllService.ServerCmdService.List(q.Page, 9999) res := service.AllService.ServerCmdService.List(q.Page, 9999)
//在列表前添加系统命令 //add system commands before the list
list := make([]*model.ServerCmd, 0) list := make([]*model.ServerCmd, 0)
list = append(list, model.SysIdServerCmds...) list = append(list, model.SysIdServerCmds...)
list = append(list, model.SysRelayServerCmds...) list = append(list, model.SysRelayServerCmds...)
+16 -16
View File
@@ -12,15 +12,15 @@ import (
type ShareRecord struct { type ShareRecord struct {
} }
// List 列表 // List list
// @Tags 分享记录 // @Tags share record
// @Summary 分享记录列表 // @Summary share record list
// @Description 分享记录列表 // @Description share record list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param user_id query int false "用户ID" // @Param user_id query int false "userID"
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/share_record/list [get] // @Router /admin/share_record/list [get]
@@ -39,13 +39,13 @@ func (sr *ShareRecord) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Delete 删除 // Delete delete
// @Tags 分享记录 // @Tags share record
// @Summary 分享记录删除 // @Summary delete share record
// @Description 分享记录删除 // @Description delete share record
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.ShareRecordForm true "分享记录信息" // @Param body body admin.ShareRecordForm true "share record info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/share_record/delete [post] // @Router /admin/share_record/delete [post]
@@ -75,10 +75,10 @@ func (sr *ShareRecord) Delete(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound")) response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
} }
// BatchDelete 批量删除 // BatchDelete batch delete
// @Tags 分享记录 // @Tags share record
// @Summary 批量分享记录 // @Summary batch share records
// @Description 批量分享记录 // @Description batch share records
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.PeerShareRecordBatchDeleteForm true "id" // @Param body body admin.PeerShareRecordBatchDeleteForm true "id"
+27 -27
View File
@@ -13,10 +13,10 @@ import (
type Tag struct { type Tag struct {
} }
// Detail 标签 // Detail tag
// @Tags 标签 // @Tags tag
// @Summary 标签详情 // @Summary tag details
// @Description 标签详情 // @Description tag details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -41,13 +41,13 @@ func (ct *Tag) Detail(c *gin.Context) {
return return
} }
// Create 创建标签 // Create create tag
// @Tags 标签 // @Tags tag
// @Summary 创建标签 // @Summary create tag
// @Description 创建标签 // @Description create tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.TagForm true "标签信息" // @Param body body admin.TagForm true "tag info"
// @Success 200 {object} response.Response{data=model.Tag} // @Success 200 {object} response.Response{data=model.Tag}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/tag/create [post] // @Router /admin/tag/create [post]
@@ -76,16 +76,16 @@ func (ct *Tag) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 标签 // @Tags tag
// @Summary 标签列表 // @Summary tag list
// @Description 标签列表 // @Description tag list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param is_my query int false "是否是我的" // @Param is_my query int false "whether it is mine"
// @Param user_id query int false "用户id" // @Param user_id query int false "userid"
// @Success 200 {object} response.Response{data=model.TagList} // @Success 200 {object} response.Response{data=model.TagList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/tag/list [get] // @Router /admin/tag/list [get]
@@ -110,13 +110,13 @@ func (ct *Tag) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 标签 // @Tags tag
// @Summary 标签编辑 // @Summary edit tag
// @Description 标签编辑 // @Description edit tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.TagForm true "标签信息" // @Param body body admin.TagForm true "tag info"
// @Success 200 {object} response.Response{data=model.Tag} // @Success 200 {object} response.Response{data=model.Tag}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/tag/update [post] // @Router /admin/tag/update [post]
@@ -150,13 +150,13 @@ func (ct *Tag) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 标签 // @Tags tag
// @Summary 标签删除 // @Summary delete tag
// @Description 标签删除 // @Description delete tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.TagForm true "标签信息" // @Param body body admin.TagForm true "tag info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/tag/delete [post] // @Router /admin/tag/delete [post]
+46 -46
View File
@@ -16,10 +16,10 @@ import (
type User struct { type User struct {
} }
// Detail 管理员 // Detail administrator
// @Tags 用户 // @Tags user
// @Summary 管理员详情 // @Summary administrator details
// @Description 管理员详情 // @Description administrator details
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param id path int true "ID" // @Param id path int true "ID"
@@ -39,13 +39,13 @@ func (ct *User) Detail(c *gin.Context) {
return return
} }
// Create 管理员 // Create administrator
// @Tags 用户 // @Tags user
// @Summary 创建管理员 // @Summary create administrator
// @Description 创建管理员 // @Description create administrator
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.UserForm true "管理员信息" // @Param body body admin.UserForm true "administrator info"
// @Success 200 {object} response.Response{data=model.User} // @Success 200 {object} response.Response{data=model.User}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user/create [post] // @Router /admin/user/create [post]
@@ -70,15 +70,15 @@ func (ct *User) Create(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// List 列表 // List list
// @Tags 用户 // @Tags user
// @Summary 管理员列表 // @Summary administrator list
// @Description 管理员列表 // @Description administrator list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param username query int false "账户" // @Param username query int false "account"
// @Success 200 {object} response.Response{data=model.UserList} // @Success 200 {object} response.Response{data=model.UserList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user/list [get] // @Router /admin/user/list [get]
@@ -97,13 +97,13 @@ func (ct *User) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Update 编辑 // Update edit
// @Tags 用户 // @Tags user
// @Summary 管理员编辑 // @Summary edit administrator
// @Description 管理员编辑 // @Description edit administrator
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.UserForm true "用户信息" // @Param body body admin.UserForm true "user info"
// @Success 200 {object} response.Response{data=model.User} // @Success 200 {object} response.Response{data=model.User}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user/update [post] // @Router /admin/user/update [post]
@@ -132,13 +132,13 @@ func (ct *User) Update(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Delete 删除 // Delete delete
// @Tags 用户 // @Tags user
// @Summary 管理员删除 // @Summary delete administrator
// @Description 管理员编删除 // @Description delete administrator
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.UserForm true "用户信息" // @Param body body admin.UserForm true "user info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user/delete [post] // @Router /admin/user/delete [post]
@@ -168,13 +168,13 @@ func (ct *User) Delete(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound")) response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
} }
// UpdatePassword 修改密码 // UpdatePassword change password
// @Tags 用户 // @Tags user
// @Summary 修改密码 // @Summary change password
// @Description 修改密码 // @Description change password
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.UserPasswordForm true "用户信息" // @Param body body admin.UserPasswordForm true "user info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user/updatePassword [post] // @Router /admin/user/updatePassword [post]
@@ -203,10 +203,10 @@ func (ct *User) UpdatePassword(c *gin.Context) {
response.Success(c, nil) response.Success(c, nil)
} }
// Current 当前用户 // Current current user
// @Tags 用户 // @Tags user
// @Summary 当前用户 // @Summary current user
// @Description 当前用户 // @Description current user
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response{data=adResp.LoginPayload} // @Success 200 {object} response.Response{data=adResp.LoginPayload}
@@ -220,13 +220,13 @@ func (ct *User) Current(c *gin.Context) {
responseLoginSuccess(c, u, t) responseLoginSuccess(c, u, t)
} }
// ChangeCurPwd 修改当前用户密码 // ChangeCurPwd change the current user's password
// @Tags 用户 // @Tags user
// @Summary 修改当前用户密码 // @Summary change the current user's password
// @Description 修改当前用户密码 // @Description change the current user's password
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.ChangeCurPasswordForm true "用户信息" // @Param body body admin.ChangeCurPasswordForm true "user info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user/changeCurPwd [post] // @Router /admin/user/changeCurPwd [post]
@@ -261,9 +261,9 @@ func (ct *User) ChangeCurPwd(c *gin.Context) {
} }
// MyOauth // MyOauth
// @Tags 用户 // @Tags user
// @Summary 我的授权 // @Summary my authorizations
// @Description 我的授权 // @Description my authorizations
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response{data=[]adResp.UserOauthItem} // @Success 200 {object} response.Response{data=[]adResp.UserOauthItem}
@@ -321,7 +321,7 @@ func (ct *User) Register(c *gin.Context) {
return return
} }
regStatus := model.StatusCode(global.Config.App.RegisterStatus) regStatus := model.StatusCode(global.Config.App.RegisterStatus)
// 注册状态可能未配置,默认启用 // the registration status may not be configured; enabled by default
if regStatus != model.COMMON_STATUS_DISABLED && regStatus != model.COMMON_STATUS_ENABLE { if regStatus != model.COMMON_STATUS_DISABLED && regStatus != model.COMMON_STATUS_ENABLE {
regStatus = model.COMMON_STATUS_ENABLE regStatus = model.COMMON_STATUS_ENABLE
} }
@@ -332,11 +332,11 @@ func (ct *User) Register(c *gin.Context) {
return return
} }
if regStatus == model.COMMON_STATUS_DISABLED { if regStatus == model.COMMON_STATUS_DISABLED {
// 需要管理员审核 // requires administrator approval
response.Fail(c, 101, response.TranslateMsg(c, "RegisterSuccessWaitAdminConfirm")) response.Fail(c, 101, response.TranslateMsg(c, "RegisterSuccessWaitAdminConfirm"))
return return
} }
// 注册成功后自动登录 // automatically log in after successful registration
ut := service.AllService.UserService.Login(u, &model.LoginLog{ ut := service.AllService.UserService.Login(u, &model.LoginLog{
UserId: u.Id, UserId: u.Id,
Client: model.LoginLogClientWebAdmin, Client: model.LoginLogClientWebAdmin,
+17 -17
View File
@@ -13,15 +13,15 @@ import (
type UserToken struct { type UserToken struct {
} }
// List 列表 // List list
// @Tags 登录凭证 // @Tags login credential
// @Summary 登录凭证列表 // @Summary login credential list
// @Description 登录凭证列表 // @Description login credential list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param page_size query int false "页大小" // @Param page_size query int false "page size"
// @Param user_id query int false "用户ID" // @Param user_id query int false "userID"
// @Success 200 {object} response.Response{data=model.UserTokenList} // @Success 200 {object} response.Response{data=model.UserTokenList}
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user_token/list [get] // @Router /admin/user_token/list [get]
@@ -41,13 +41,13 @@ func (ct *UserToken) List(c *gin.Context) {
response.Success(c, res) response.Success(c, res)
} }
// Delete 删除 // Delete delete
// @Tags 登录凭证 // @Tags login credential
// @Summary 登录凭证删除 // @Summary delete login credential
// @Description 登录凭证删除 // @Description delete login credential
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body model.UserToken true "登录凭证信息" // @Param body body model.UserToken true "login credential info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user_token/delete [post] // @Router /admin/user_token/delete [post]
@@ -82,13 +82,13 @@ func (ct *UserToken) Delete(c *gin.Context) {
response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound")) response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
} }
// BatchDelete 批量删除 // BatchDelete batch delete
// @Tags 登录凭证 // @Tags login credential
// @Summary 登录凭证批量删除 // @Summary batch delete login credentials
// @Description 登录凭证批量删除 // @Description batch delete login credentials
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body admin.UserTokenBatchDeleteForm true "登录凭证信息" // @Param body body admin.UserTokenBatchDeleteForm true "login credential info"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /admin/user_token/batchDelete [post] // @Router /admin/user_token/batchDelete [post]
+58 -58
View File
@@ -20,9 +20,9 @@ type Ab struct {
} }
// Ab // Ab
// @Tags 地址 // @Tags address
// @Summary 地址列表 // @Summary address list
// @Description 地址列表 // @Description address list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -36,7 +36,7 @@ func (a *Ab) Ab(c *gin.Context) {
tags := service.AllService.TagService.ListByUserIdAndCollectionId(user.Id, 0) tags := service.AllService.TagService.ListByUserIdAndCollectionId(user.Id, 0)
tagColors := map[string]uint{} tagColors := map[string]uint{}
//将tags中的name转成一个以逗号分割的字符串 // convert the name in tags into a comma-separated string
var tagNames []string var tagNames []string
for _, tag := range tags.Tags { for _, tag := range tags.Tags {
tagNames = append(tagNames, tag.Name) tagNames = append(tagNames, tag.Name)
@@ -56,12 +56,12 @@ func (a *Ab) Ab(c *gin.Context) {
} }
// UpAb // UpAb
// @Tags 地址 // @Tags address
// @Summary 地址更新 // @Summary address update
// @Description 地址更新 // @Description address update
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body requstform.AddressBookForm true "地址表单" // @Param body body requstform.AddressBookForm true "address form"
// @Success 200 {string} string "null" // @Success 200 {string} string "null"
// @Failure 500 {object} response.ErrorResponse // @Failure 500 {object} response.ErrorResponse
// @Router /ab [post] // @Router /ab [post]
@@ -99,9 +99,9 @@ func (a *Ab) UpAb(c *gin.Context) {
} }
// PTags // PTags
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 标签 // @Summary tag
// @Description 标签 // @Description tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -128,9 +128,9 @@ func (a *Ab) PTags(c *gin.Context) {
} }
// TagAdd // TagAdd
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 标签添加 // @Summary add tag
// @Description 标签 // @Description tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -177,9 +177,9 @@ func (a *Ab) TagAdd(c *gin.Context) {
} }
// TagRename // TagRename
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 标签重命名 // @Summary rename tag
// @Description 标签 // @Description tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -229,9 +229,9 @@ func (a *Ab) TagRename(c *gin.Context) {
} }
// TagUpdate // TagUpdate
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 标签修改颜色 // @Summary change tag color
// @Description 标签 // @Description tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -275,9 +275,9 @@ func (a *Ab) TagUpdate(c *gin.Context) {
} }
// TagDel // TagDel
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 标签删除 // @Summary delete tag
// @Description 标签 // @Description tag
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -324,9 +324,9 @@ func (a *Ab) TagDel(c *gin.Context) {
} }
// Personal // Personal
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 个人地址 // @Summary personal address
// @Description 个人地址 // @Description personal address
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param string body string false "string valid" // @Param string body string false "string valid"
@@ -345,7 +345,7 @@ func (a *Ab) Personal(c *gin.Context) {
*/ */
if global.Config.Rustdesk.Personal == 1 { if global.Config.Rustdesk.Personal == 1 {
guid := a.ComposeGuid(user.GroupId, user.Id, 0) guid := a.ComposeGuid(user.GroupId, user.Id, 0)
//如果返回了guid,后面的请求会有变化 //if it returns guid, subsequent requests will change
c.JSON(http.StatusOK, gin.H{ c.JSON(http.StatusOK, gin.H{
"guid": guid, "guid": guid,
"name": user.Username, "name": user.Username,
@@ -358,9 +358,9 @@ func (a *Ab) Personal(c *gin.Context) {
} }
// Settings // Settings
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 设置 // @Summary settings
// @Description 设置 // @Description settings
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param string body string false "string valid" // @Param string body string false "string valid"
@@ -370,18 +370,18 @@ func (a *Ab) Personal(c *gin.Context) {
// @Security BearerAuth // @Security BearerAuth
func (a *Ab) Settings(c *gin.Context) { func (a *Ab) Settings(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{ c.JSON(http.StatusOK, gin.H{
"max_peer_one_ab": 0, //最大peer数,0表示不限制 "max_peer_one_ab": 0, //max peer count, 0 means no limit
}) })
} }
// SharedProfiles // SharedProfiles
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 共享地址簿 // @Summary shared address book
// @Description 共享 // @Description shared
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param current query int false "页码" // @Param current query int false "page number"
// @Param pageSize query int false "每页数量" // @Param pageSize query int false "items per page"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /ab/shared/profiles [post] // @Router /ab/shared/profiles [post]
@@ -401,14 +401,14 @@ func (a *Ab) SharedProfiles(c *gin.Context) {
}) })
} }
allAbIds := make(map[uint]int) //用map去重,并保留最大Rule allAbIds := make(map[uint]int) //use map to deduplicate and keep the maximum Rule
allUserIds := make(map[uint]*model.User) allUserIds := make(map[uint]*model.User)
rules := service.AllService.AddressBookService.CollectionReadRules(user) rules := service.AllService.AddressBookService.CollectionReadRules(user)
for _, rule := range rules { for _, rule := range rules {
//先判断是否存在 //first check whether it exists
r, ok := allAbIds[rule.CollectionId] r, ok := allAbIds[rule.CollectionId]
if ok { if ok {
//再判断权限大小 //then check the permission level
if r < rule.Rule { if r < rule.Rule {
allAbIds[rule.CollectionId] = rule.Rule allAbIds[rule.CollectionId] = rule.Rule
} }
@@ -448,7 +448,7 @@ func (a *Ab) SharedProfiles(c *gin.Context) {
// ParseGuid // ParseGuid
func (a *Ab) ParseGuid(guid string) (gid, uid, cid uint) { func (a *Ab) ParseGuid(guid string) (gid, uid, cid uint) {
//用-切割 guid // split guid by -
guids := strings.Split(guid, "-") guids := strings.Split(guid, "-")
if len(guids) < 2 { if len(guids) < 2 {
return 0, 0, 0 return 0, 0, 0
@@ -521,13 +521,13 @@ func (a *Ab) CheckGuid(cu *model.User, guid string) (gid, uid, cid uint, err err
} }
// Peers // Peers
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 地址列表 // @Summary address list
// @Description 地址 // @Description address
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param current query int false "页码" // @Param current query int false "page number"
// @Param pageSize query int false "每页数量" // @Param pageSize query int false "items per page"
// @Param ab query string false "guid" // @Param ab query string false "guid"
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
@@ -557,9 +557,9 @@ func (a *Ab) Peers(c *gin.Context) {
} }
// PeerAdd // PeerAdd
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 添加地址 // @Summary add address
// @Description 添加地址 // @Description add address
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -568,7 +568,7 @@ func (a *Ab) Peers(c *gin.Context) {
// @Router /ab/peer/add/{guid} [post] // @Router /ab/peer/add/{guid} [post]
// @Security BearerAuth // @Security BearerAuth
func (a *Ab) PeerAdd(c *gin.Context) { func (a *Ab) PeerAdd(c *gin.Context) {
// forceAlwaysRelay永远是字符串"false" // forceAlwaysRelay is always the string "false"
//f := &gin.H{} //f := &gin.H{}
f := &requstform.PersonalAddressBookForm{} f := &requstform.PersonalAddressBookForm{}
err := c.ShouldBindJSON(f) err := c.ShouldBindJSON(f)
@@ -613,9 +613,9 @@ func (a *Ab) PeerAdd(c *gin.Context) {
} }
// PeerDel // PeerDel
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 删除地址 // @Summary delete address
// @Description 删除地址 // @Description delete address
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -661,9 +661,9 @@ func (a *Ab) PeerDel(c *gin.Context) {
} }
// PeerUpdate // PeerUpdate
// @Tags 地址[Personal] // @Tags address[Personal]
// @Summary 更新地址 // @Summary update address
// @Description 更新地址 // @Description update address
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param guid path string true "guid" // @Param guid path string true "guid"
@@ -693,7 +693,7 @@ func (a *Ab) PeerUpdate(c *gin.Context) {
return return
} }
//fmt.Println(f) //fmt.Println(f)
//判断f["Id"]是否存在 // determine whether f["Id"] exists
fid, ok := f["id"] fid, ok := f["id"]
if !ok { if !ok {
response.Error(c, response.TranslateMsg(c, "ParamsError")) response.Error(c, response.TranslateMsg(c, "ParamsError"))
@@ -706,9 +706,9 @@ func (a *Ab) PeerUpdate(c *gin.Context) {
response.Error(c, response.TranslateMsg(c, "ItemNotFound")) response.Error(c, response.TranslateMsg(c, "ItemNotFound"))
return return
} }
//允许的字段 //allowed fields
allowUp := []string{"password", "hash", "tags", "alias"} allowUp := []string{"password", "hash", "tags", "alias"}
//f中的字段如果不在allowUp中,就删除 // if a field in f is not in allowUp, delete it
for k := range f { for k := range f {
if !utils.InArray(k, allowUp) { if !utils.InArray(k, allowUp) {
delete(f, k) delete(f, k)
+8 -8
View File
@@ -14,12 +14,12 @@ type Audit struct {
} }
// AuditConn // AuditConn
// @Tags 审计 // @Tags audit
// @Summary 审计连接 // @Summary audit connection
// @Description 审计连接 // @Description audit connection
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body request.AuditConnForm true "审计连接" // @Param body body request.AuditConnForm true "audit connection"
// @Success 200 {string} string "" // @Success 200 {string} string ""
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /audit/conn [post] // @Router /audit/conn [post]
@@ -59,12 +59,12 @@ func (a *Audit) AuditConn(c *gin.Context) {
} }
// AuditFile // AuditFile
// @Tags 审计 // @Tags audit
// @Summary 审计文件 // @Summary audit file
// @Description 审计文件 // @Description audit file
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body request.AuditFileForm true "审计文件" // @Param body body request.AuditFileForm true "audit file"
// @Success 200 {string} string "" // @Success 200 {string} string ""
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /audit/file [post] // @Router /audit/file [post]
+21 -21
View File
@@ -13,15 +13,15 @@ import (
type Group struct { type Group struct {
} }
// Users 用户列表 // Users user list
// @Tags 群组 // @Tags group
// @Summary 用户列表 // @Summary user list
// @Description 用户列表 // @Description user list
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param pageSize query int false "每页数量" // @Param pageSize query int false "items per page"
// @Param status query int false "状态" // @Param status query int false "status"
// @Param accessible query string false "accessible" // @Param accessible query string false "accessible"
// @Success 200 {object} response.DataResponse{data=[]apiResp.UserPayload} // @Success 200 {object} response.DataResponse{data=[]apiResp.UserPayload}
// @Failure 500 {object} response.ErrorResponse // @Failure 500 {object} response.ErrorResponse
@@ -38,7 +38,7 @@ func (g *Group) Users(c *gin.Context) {
gr := service.AllService.GroupService.InfoById(u.GroupId) gr := service.AllService.GroupService.InfoById(u.GroupId)
userList := &model.UserList{} userList := &model.UserList{}
if !*u.IsAdmin && gr.Type != model.GroupTypeShare { if !*u.IsAdmin && gr.Type != model.GroupTypeShare {
//仅能获取到自己 //can only retrieve one's own
userList.Users = append(userList.Users, u) userList.Users = append(userList.Users, u)
userList.Total = 1 userList.Total = 1
} else { } else {
@@ -58,14 +58,14 @@ func (g *Group) Users(c *gin.Context) {
} }
// Peers // Peers
// @Tags 群组 // @Tags group
// @Summary 机器 // @Summary machine
// @Description 机器 // @Description machine
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param pageSize query int false "每页数量" // @Param pageSize query int false "items per page"
// @Param status query int false "状态" // @Param status query int false "status"
// @Param accessible query string false "accessible" // @Param accessible query string false "accessible"
// @Success 200 {object} response.DataResponse // @Success 200 {object} response.DataResponse
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
@@ -82,7 +82,7 @@ func (g *Group) Peers(c *gin.Context) {
gr := service.AllService.GroupService.InfoById(u.GroupId) gr := service.AllService.GroupService.InfoById(u.GroupId)
users := make([]*model.User, 0, 1) users := make([]*model.User, 0, 1)
if !*u.IsAdmin && gr.Type != model.GroupTypeShare { if !*u.IsAdmin && gr.Type != model.GroupTypeShare {
//仅能获取到自己 //can only retrieve one's own
users = append(users, u) users = append(users, u)
} else { } else {
users = service.AllService.UserService.ListIdAndNameByGroupId(u.GroupId) users = service.AllService.UserService.ListIdAndNameByGroupId(u.GroupId)
@@ -122,14 +122,14 @@ func (g *Group) Peers(c *gin.Context) {
} }
// Device // Device
// @Tags 群组 // @Tags group
// @Summary 设备 // @Summary device
// @Description 机器 // @Description machine
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param page query int false "页码" // @Param page query int false "page number"
// @Param pageSize query int false "每页数量" // @Param pageSize query int false "items per page"
// @Param status query int false "状态" // @Param status query int false "status"
// @Param accessible query string false "accessible" // @Param accessible query string false "accessible"
// @Success 200 {object} response.DataResponse // @Success 200 {object} response.DataResponse
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
+14 -14
View File
@@ -13,10 +13,10 @@ import (
type Index struct { type Index struct {
} }
// Index 首页 // Index home
// @Tags 首页 // @Tags home
// @Summary 首页 // @Summary home
// @Description 首页 // @Description home
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -29,10 +29,10 @@ func (i *Index) Index(c *gin.Context) {
) )
} }
// Heartbeat 心跳 // Heartbeat heartbeat
// @Tags 首页 // @Tags home
// @Summary 心跳 // @Summary heartbeat
// @Description 心跳 // @Description heartbeat
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} nil // @Success 200 {object} nil
@@ -54,7 +54,7 @@ func (i *Index) Heartbeat(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{}) c.JSON(http.StatusOK, gin.H{})
return return
} }
//如果在40s以内则不更新 // do not update if within 40s
if time.Now().Unix()-peer.LastOnlineTime >= 30 { if time.Now().Unix()-peer.LastOnlineTime >= 30 {
upp := &model.Peer{RowId: peer.RowId, LastOnlineTime: time.Now().Unix(), LastOnlineIp: c.ClientIP()} upp := &model.Peer{RowId: peer.RowId, LastOnlineTime: time.Now().Unix(), LastOnlineIp: c.ClientIP()}
service.AllService.PeerService.Update(upp) service.AllService.PeerService.Update(upp)
@@ -62,17 +62,17 @@ func (i *Index) Heartbeat(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{}) c.JSON(http.StatusOK, gin.H{})
} }
// Version 版本 // Version version
// @Tags 首页 // @Tags home
// @Summary 版本 // @Summary version
// @Description 版本 // @Description version
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
// @Failure 500 {object} response.Response // @Failure 500 {object} response.Response
// @Router /version [get] // @Router /version [get]
func (i *Index) Version(c *gin.Context) { func (i *Index) Version(c *gin.Context) {
//读取resources/version文件 // read the resources/version file
v := service.AllService.AppService.GetAppVersion() v := service.AllService.AppService.GetAppVersion()
response.Success( response.Success(
c, c,
+13 -13
View File
@@ -16,13 +16,13 @@ import (
type Login struct { type Login struct {
} }
// Login 登录 // Login login
// @Tags 登录 // @Tags login
// @Summary 登录 // @Summary login
// @Description 登录 // @Description login
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body api.LoginForm true "登录表单" // @Param body body api.LoginForm true "login form"
// @Success 200 {object} apiResp.LoginRes // @Success 200 {object} apiResp.LoginRes
// @Failure 500 {object} response.ErrorResponse // @Failure 500 {object} response.ErrorResponse
// @Router /login [post] // @Router /login [post]
@@ -32,7 +32,7 @@ func (l *Login) Login(c *gin.Context) {
return return
} }
// 检查登录限制 // check login limit
loginLimiter := global.LoginLimiter loginLimiter := global.LoginLimiter
clientIp := c.ClientIP() clientIp := c.ClientIP()
@@ -68,7 +68,7 @@ func (l *Login) Login(c *gin.Context) {
return return
} }
//根据refer判断是webclient还是app // determine whether it is webclient or app based on refer
ref := c.GetHeader("referer") ref := c.GetHeader("referer")
if ref != "" { if ref != "" {
f.DeviceInfo.Type = model.LoginLogClientWeb f.DeviceInfo.Type = model.LoginLogClientWeb
@@ -92,9 +92,9 @@ func (l *Login) Login(c *gin.Context) {
} }
// LoginOptions // LoginOptions
// @Tags 登录 // @Tags login
// @Summary 登录选项 // @Summary login options
// @Description 登录选项 // @Description login options
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} []string // @Success 200 {object} []string
@@ -123,9 +123,9 @@ func (l *Login) LoginOptions(c *gin.Context) {
} }
// Logout // Logout
// @Tags 登录 // @Tags login
// @Summary 登出 // @Summary logout
// @Description 登出 // @Description logout
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {string} string // @Success 200 {string} string
+18 -18
View File
@@ -65,37 +65,37 @@ func (o *Oauth) OidcAuthQueryPre(c *gin.Context) (*model.User, *model.UserToken)
var ut *model.UserToken var ut *model.UserToken
q := &api.OidcAuthQuery{} q := &api.OidcAuthQuery{}
// 解析查询参数并处理错误 // parse query parameters and handle errors
if err := c.ShouldBindQuery(q); err != nil { if err := c.ShouldBindQuery(q); err != nil {
response.Error(c, response.TranslateMsg(c, "ParamsError")+": "+err.Error()) response.Error(c, response.TranslateMsg(c, "ParamsError")+": "+err.Error())
return nil, nil return nil, nil
} }
// 获取 OAuth 缓存 // get OAuth cache
v := service.AllService.OauthService.GetOauthCache(q.Code) v := service.AllService.OauthService.GetOauthCache(q.Code)
if v == nil { if v == nil {
response.Error(c, response.TranslateMsg(c, "OauthExpired")) response.Error(c, response.TranslateMsg(c, "OauthExpired"))
return nil, nil return nil, nil
} }
// 如果 UserId 为 0,说明还在授权中 // if UserId is 0, authorization is still in progress
if v.UserId == 0 { if v.UserId == 0 {
//fix: 1.4.2 webclient oidc //fix: 1.4.2 webclient oidc
c.JSON(http.StatusOK, gin.H{"message": "Authorization in progress, please login and bind", "error": "No authed oidc is found"}) c.JSON(http.StatusOK, gin.H{"message": "Authorization in progress, please login and bind", "error": "No authed oidc is found"})
return nil, nil return nil, nil
} }
// 获取用户信息 // get user info
u = service.AllService.UserService.InfoById(v.UserId) u = service.AllService.UserService.InfoById(v.UserId)
if u == nil { if u == nil {
response.Error(c, response.TranslateMsg(c, "UserNotFound")) response.Error(c, response.TranslateMsg(c, "UserNotFound"))
return nil, nil return nil, nil
} }
// 删除 OAuth 缓存 // delete OAuth cache
service.AllService.OauthService.DeleteOauthCache(q.Code) service.AllService.OauthService.DeleteOauthCache(q.Code)
// 创建登录日志并生成用户令牌 // create a login log and generate a user token
ut = service.AllService.UserService.Login(u, &model.LoginLog{ ut = service.AllService.UserService.Login(u, &model.LoginLog{
UserId: u.Id, UserId: u.Id,
Client: v.DeviceType, Client: v.DeviceType,
@@ -111,7 +111,7 @@ func (o *Oauth) OidcAuthQueryPre(c *gin.Context) (*model.User, *model.UserToken)
return nil, nil return nil, nil
} }
// 返回用户令牌 // return user token
return u, ut return u, ut
} }
@@ -136,7 +136,7 @@ func (o *Oauth) OidcAuthQuery(c *gin.Context) {
}) })
} }
// OauthCallback 回调 // OauthCallback callback
// @Tags Oauth // @Tags Oauth
// @Summary OauthCallback // @Summary OauthCallback
// @Description OauthCallback // @Description OauthCallback
@@ -156,7 +156,7 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
} }
cacheKey := state cacheKey := state
oauthService := service.AllService.OauthService oauthService := service.AllService.OauthService
//从缓存中获取 //get from cache
oauthCache := oauthService.GetOauthCache(cacheKey) oauthCache := oauthService.GetOauthCache(cacheKey)
if oauthCache == nil { if oauthCache == nil {
c.HTML(http.StatusOK, "oauth_fail.html", gin.H{ c.HTML(http.StatusOK, "oauth_fail.html", gin.H{
@@ -169,7 +169,7 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
action := oauthCache.Action action := oauthCache.Action
verifier := oauthCache.Verifier verifier := oauthCache.Verifier
var user *model.User var user *model.User
// 获取用户信息 // get user info
code := c.Query("code") code := c.Query("code")
err, oauthUser := oauthService.Callback(code, verifier, op, nonce) err, oauthUser := oauthService.Callback(code, verifier, op, nonce)
if err != nil { if err != nil {
@@ -184,7 +184,7 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
if action == service.OauthActionTypeBind { if action == service.OauthActionTypeBind {
//fmt.Println("bind", ty, userData) //fmt.Println("bind", ty, userData)
// 检查此openid是否已经绑定过 // check whether this openid has already been bound
utr := oauthService.UserThirdInfo(op, openid) utr := oauthService.UserThirdInfo(op, openid)
if utr.UserId > 0 { if utr.UserId > 0 {
c.HTML(http.StatusOK, "oauth_fail.html", gin.H{ c.HTML(http.StatusOK, "oauth_fail.html", gin.H{
@@ -192,7 +192,7 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
}) })
return return
} }
//绑定 //bind
user = service.AllService.UserService.InfoById(userId) user = service.AllService.UserService.InfoById(userId)
if user == nil { if user == nil {
c.HTML(http.StatusOK, "oauth_fail.html", gin.H{ c.HTML(http.StatusOK, "oauth_fail.html", gin.H{
@@ -200,7 +200,7 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
}) })
return return
} }
//绑定 //bind
err := oauthService.BindOauthUser(userId, oauthUser, op) err := oauthService.BindOauthUser(userId, oauthUser, op)
if err != nil { if err != nil {
c.HTML(http.StatusOK, "oauth_fail.html", gin.H{ c.HTML(http.StatusOK, "oauth_fail.html", gin.H{
@@ -214,7 +214,7 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
return return
} else if action == service.OauthActionTypeLogin { } else if action == service.OauthActionTypeLogin {
//登录 //login
if userId != 0 { if userId != 0 {
c.HTML(http.StatusOK, "oauth_fail.html", gin.H{ c.HTML(http.StatusOK, "oauth_fail.html", gin.H{
"message": "OauthHasBeenSuccess", "message": "OauthHasBeenSuccess",
@@ -225,13 +225,13 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
if user == nil { if user == nil {
oauthConfig := oauthService.InfoByOp(op) oauthConfig := oauthService.InfoByOp(op)
if !*oauthConfig.AutoRegister { if !*oauthConfig.AutoRegister {
//c.String(http.StatusInternalServerError, "还未绑定用户,请先绑定") //c.String(http.StatusInternalServerError, "not yet bound to a user, please bind first")
oauthCache.UpdateFromOauthUser(oauthUser) oauthCache.UpdateFromOauthUser(oauthUser)
c.Redirect(http.StatusFound, "/_admin/#/oauth/bind/"+cacheKey) c.Redirect(http.StatusFound, "/_admin/#/oauth/bind/"+cacheKey)
return return
} }
//自动注册 //auto register
err, user = service.AllService.UserService.RegisterByOauth(oauthUser, op) err, user = service.AllService.UserService.RegisterByOauth(oauthUser, op)
if err != nil { if err != nil {
c.HTML(http.StatusOK, "oauth_fail.html", gin.H{ c.HTML(http.StatusOK, "oauth_fail.html", gin.H{
@@ -242,7 +242,7 @@ func (o *Oauth) OauthCallback(c *gin.Context) {
} }
oauthCache.UserId = user.Id oauthCache.UserId = user.Id
oauthService.SetOauthCache(cacheKey, oauthCache, 0) oauthService.SetOauthCache(cacheKey, oauthCache, 0)
// 如果是webadmin,登录成功后跳转到webadmin // if it is webadmin, after successful login redirect to webadmin
if oauthCache.DeviceType == model.LoginLogClientWebAdmin { if oauthCache.DeviceType == model.LoginLogClientWebAdmin {
/*service.AllService.UserService.Login(u, &model.LoginLog{ /*service.AllService.UserService.Login(u, &model.LoginLog{
UserId: u.Id, UserId: u.Id,
@@ -299,7 +299,7 @@ func (o *Oauth) Message(c *gin.Context) {
} }
} }
//返回js内容 //returnjscontent
c.Header("Content-Type", "application/javascript") c.Header("Content-Type", "application/javascript")
c.String(http.StatusOK, res) c.String(http.StatusOK, res)
} }
+10 -10
View File
@@ -15,11 +15,11 @@ type Peer struct {
// SysInfo // SysInfo
// @Tags System // @Tags System
// @Summary 提交系统信息 // @Summary submit system info
// @Description 提交系统信息 // @Description submit system info
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Param body body requstform.PeerForm true "系统信息表单" // @Param body body requstform.PeerForm true "system info form"
// @Success 200 {string} string "SYSINFO_UPDATED,ID_NOT_FOUND" // @Success 200 {string} string "SYSINFO_UPDATED,ID_NOT_FOUND"
// @Failure 500 {object} response.ErrorResponse // @Failure 500 {object} response.ErrorResponse
// @Router /sysinfo [post] // @Router /sysinfo [post]
@@ -52,25 +52,25 @@ func (p *Peer) SysInfo(c *gin.Context) {
return return
} }
} }
//SYSINFO_UPDATED 上传成功 //SYSINFO_UPDATED upload successful
//ID_NOT_FOUND 下次心跳会上传 //ID_NOT_FOUND will be uploaded on the next heartbeat
//直接响应文本 //respond with text directly
c.String(http.StatusOK, "SYSINFO_UPDATED") c.String(http.StatusOK, "SYSINFO_UPDATED")
} }
// SysInfoVer // SysInfoVer
// @Tags System // @Tags System
// @Summary 获取系统版本信息 // @Summary get system version info
// @Description 获取系统版本信息 // @Description get system version info
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {string} string "" // @Success 200 {string} string ""
// @Failure 500 {object} response.ErrorResponse // @Failure 500 {object} response.ErrorResponse
// @Router /sysinfo_ver [post] // @Router /sysinfo_ver [post]
func (p *Peer) SysInfoVer(c *gin.Context) { func (p *Peer) SysInfoVer(c *gin.Context) {
//读取resources/version文件 // read the resources/version file
v := service.AllService.AppService.GetAppVersion() v := service.AllService.AppService.GetAppVersion()
// 加上启动时间,方便client上传信息 // add the start time so the client can conveniently upload info
v = fmt.Sprintf("%s\n%s", v, service.AllService.AppService.GetStartTime()) v = fmt.Sprintf("%s\n%s", v, service.AllService.AppService.GetStartTime())
c.String(http.StatusOK, v) c.String(http.StatusOK, v)
} }
+8 -8
View File
@@ -10,10 +10,10 @@ import (
type User struct { type User struct {
} }
// currentUser 当前用户 // currentUser current user
// @Tags 用户 // @Tags user
// @Summary 用户信息 // @Summary user info
// @Description 用户信息 // @Description user info
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} apiResp.UserPayload // @Success 200 {object} apiResp.UserPayload
@@ -26,10 +26,10 @@ type User struct {
// c.JSON(http.StatusOK, up) // c.JSON(http.StatusOK, up)
//} //}
// Info 用户信息 // Info user info
// @Tags 用户 // @Tags user
// @Summary 用户信息 // @Summary user info
// @Description 用户信息 // @Description user info
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} apiResp.UserPayload // @Success 200 {object} apiResp.UserPayload
+10 -10
View File
@@ -12,10 +12,10 @@ import (
type WebClient struct { type WebClient struct {
} }
// ServerConfig 服务配置 // ServerConfig service config
// @Tags WEBCLIENT // @Tags WEBCLIENT
// @Summary 服务配置 // @Summary service config
// @Description 服务配置,给webclient提供api-server // @Description service config, provides an api-server for the webclient
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -42,10 +42,10 @@ func (i *WebClient) ServerConfig(c *gin.Context) {
) )
} }
// SharedPeer 分享的peer // SharedPeer shared peer
// @Tags WEBCLIENT // @Tags WEBCLIENT
// @Summary 分享的peer // @Summary shared peer
// @Description 分享的peer // @Description shared peer
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
@@ -65,7 +65,7 @@ func (i *WebClient) SharedPeer(c *gin.Context) {
return return
} }
if sr.Expire != 0 { if sr.Expire != 0 {
//判断是否过期,created_at + expire > now //check whether expired,created_at + expire > now
ca := time.Time(sr.CreatedAt) ca := time.Time(sr.CreatedAt)
if ca.Add(time.Second * time.Duration(sr.Expire)).Before(time.Now()) { if ca.Add(time.Second * time.Duration(sr.Expire)).Before(time.Now()) {
response.Fail(c, 101, "share expired") response.Fail(c, 101, "share expired")
@@ -89,10 +89,10 @@ func (i *WebClient) SharedPeer(c *gin.Context) {
}) })
} }
// ServerConfigV2 服务配置 // ServerConfigV2 service config
// @Tags WEBCLIENT_V2 // @Tags WEBCLIENT_V2
// @Summary 服务配置 // @Summary service config
// @Description 服务配置,给webclient提供api-server // @Description service config, provides an api-server for the webclient
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} response.Response // @Success 200 {object} response.Response
+1 -1
View File
@@ -25,7 +25,7 @@ func ApiInit() {
} }
if global.Config.Gin.Mode == gin.ReleaseMode { if global.Config.Gin.Mode == gin.ReleaseMode {
//修改gin Recovery日志 输出为logger的输出点 // redirect gin's Recovery log output to the logger's output
if global.Logger != nil { if global.Logger != nil {
gin.DefaultErrorWriter = global.Logger.WriterLevel(logrus.ErrorLevel) gin.DefaultErrorWriter = global.Logger.WriterLevel(logrus.ErrorLevel)
} }
+3 -3
View File
@@ -6,11 +6,11 @@ import (
"github.com/lejianwen/rustdesk-api/v2/service" "github.com/lejianwen/rustdesk-api/v2/service"
) )
// BackendUserAuth 后台权限验证中间件 // BackendUserAuth backend permission verification middleware
func BackendUserAuth() gin.HandlerFunc { func BackendUserAuth() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
//测试先关闭 //disabled for testing
token := c.GetHeader("api-token") token := c.GetHeader("api-token")
if token == "" { if token == "" {
response.Fail(c, 403, response.TranslateMsg(c, "NeedLogin")) response.Fail(c, 403, response.TranslateMsg(c, "NeedLogin"))
@@ -34,7 +34,7 @@ func BackendUserAuth() gin.HandlerFunc {
c.Set("curUser", user) c.Set("curUser", user)
c.Set("token", token) c.Set("token", token)
//如果时间小于1天,token自动续期 // if the remaining time is less than 1 day, the token is auto-renewed
service.AllService.UserService.AutoRefreshAccessToken(ut) service.AllService.UserService.AutoRefreshAccessToken(ut)
c.Next() c.Next()
+1 -1
View File
@@ -5,7 +5,7 @@ import (
"net/http" "net/http"
) )
// Cors 跨域 // Cors CORS
func Cors() gin.HandlerFunc { func Cors() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
origin := c.GetHeader("Origin") origin := c.GetHeader("Origin")
+2 -2
View File
@@ -9,7 +9,7 @@ import (
func JwtAuth() gin.HandlerFunc { func JwtAuth() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
//测试先关闭 //disabled for testing
token := c.GetHeader("api-token") token := c.GetHeader("api-token")
if token == "" { if token == "" {
response.Fail(c, 403, response.TranslateMsg(c, "NeedLogin")) response.Fail(c, 403, response.TranslateMsg(c, "NeedLogin"))
@@ -31,7 +31,7 @@ func JwtAuth() gin.HandlerFunc {
user := service.AllService.UserService.InfoById(uid) user := service.AllService.UserService.InfoById(uid)
//user := &model.User{ //user := &model.User{
// Id: uid, // Id: uid,
// Username: "测试用户", // Username: "test user",
//} //}
if user.Id == 0 { if user.Id == 0 {
response.Fail(c, 403, response.TranslateMsg(c, "NeedLogin")) response.Fail(c, 403, response.TranslateMsg(c, "NeedLogin"))
+1 -1
View File
@@ -6,7 +6,7 @@ import (
"github.com/sirupsen/logrus" "github.com/sirupsen/logrus"
) )
// Logger 日志中间件 // Logger logging middleware
func Logger() gin.HandlerFunc { func Logger() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
global.Logger.WithFields( global.Logger.WithFields(
+5 -5
View File
@@ -9,7 +9,7 @@ import (
func RustAuth() gin.HandlerFunc { func RustAuth() gin.HandlerFunc {
return func(c *gin.Context) { return func(c *gin.Context) {
//fmt.Println(c.Request.URL, c.Request.Header) //fmt.Println(c.Request.URL, c.Request.Header)
//获取HTTP_AUTHORIZATION //getHTTP_AUTHORIZATION
token := c.GetHeader("Authorization") token := c.GetHeader("Authorization")
if token == "" { if token == "" {
c.JSON(401, gin.H{ c.JSON(401, gin.H{
@@ -25,13 +25,13 @@ func RustAuth() gin.HandlerFunc {
c.Abort() c.Abort()
return return
} }
//提取token,格式是Bearer {token} //extracttoken, format is Bearer {token}
//这里只是简单的提取 //this is just a simple extraction
token = token[7:] token = token[7:]
//验证token // verify the token
//检查是否设置了jwt key //check whether it is set jwt key
if len(global.Jwt.Key) > 0 { if len(global.Jwt.Key) > 0 {
uid, _ := service.AllService.UserService.VerifyJWT(token) uid, _ := service.AllService.UserService.VerifyJWT(token)
if uid == 0 { if uid == 0 {
+3 -3
View File
@@ -27,7 +27,7 @@ type AddressBookForm struct {
} }
func (a AddressBookForm) ToAddressBook() *model.AddressBook { func (a AddressBookForm) ToAddressBook() *model.AddressBook {
//tags转换 //tagsconvert
tags, _ := json.Marshal(a.Tags) tags, _ := json.Marshal(a.Tags)
return &model.AddressBook{ return &model.AddressBook{
@@ -52,7 +52,7 @@ func (a AddressBookForm) ToAddressBook() *model.AddressBook {
} }
func (a AddressBookForm) ToAddressBooks() []*model.AddressBook { func (a AddressBookForm) ToAddressBooks() []*model.AddressBook {
//tags转换 //tagsconvert
tags, _ := json.Marshal(a.Tags) tags, _ := json.Marshal(a.Tags)
abs := make([]*model.AddressBook, 0, len(a.UserIds)) abs := make([]*model.AddressBook, 0, len(a.UserIds))
@@ -92,7 +92,7 @@ type AddressBookQuery struct {
type ShareByWebClientForm struct { type ShareByWebClientForm struct {
Id string `json:"id" validate:"required"` Id string `json:"id" validate:"required"`
PasswordType string `json:"password_type" validate:"required,oneof=once fixed"` //只能是once,fixed PasswordType string `json:"password_type" validate:"required,oneof=once fixed"` //can only be once,fixed
Password string `json:"password" validate:"required"` Password string `json:"password" validate:"required"`
Expire int64 `json:"expire"` Expire int64 `json:"expire"`
} }
+4 -4
View File
@@ -1,10 +1,10 @@
package admin package admin
type Login struct { type Login struct {
Username string `json:"username" validate:"required" label:"用户名"` Username string `json:"username" validate:"required" label:"username"`
Password string `json:"password,omitempty" validate:"required" label:"密码"` Password string `json:"password,omitempty" validate:"required" label:"password"`
Platform string `json:"platform" label:"平台"` Platform string `json:"platform" label:"platform"`
Captcha string `json:"captcha,omitempty" label:"验证码"` Captcha string `json:"captcha,omitempty" label:"captcha"`
CaptchaId string `json:"captcha_id,omitempty"` CaptchaId string `json:"captcha_id,omitempty"`
} }
+1 -1
View File
@@ -7,7 +7,7 @@ import (
type UserForm struct { type UserForm struct {
Id uint `json:"id"` Id uint `json:"id"`
Username string `json:"username" validate:"required,gte=2,lte=32"` Username string `json:"username" validate:"required,gte=2,lte=32"`
Email string `json:"email"` //validate:"required,email" email不强制 Email string `json:"email"` //validate:"required,email" emailnot enforced
//Password string `json:"password" validate:"required,gte=4,lte=20"` //Password string `json:"password" validate:"required,gte=4,lte=20"`
Nickname string `json:"nickname"` Nickname string `json:"nickname"`
Avatar string `json:"avatar"` Avatar string `json:"avatar"`
+1 -1
View File
@@ -1,7 +1,7 @@
package api package api
type OidcAuthRequest struct { type OidcAuthRequest struct {
DeviceInfo DeviceInfoInLogin `json:"deviceInfo" label:"设备信息"` DeviceInfo DeviceInfoInLogin `json:"deviceInfo" label:"device info"`
Id string `json:"id" label:"id"` Id string `json:"id" label:"id"`
Op string `json:"op" label:"op"` Op string `json:"op" label:"op"`
Uuid string `json:"uuid" label:"uuid"` Uuid string `json:"uuid" label:"uuid"`
+1 -1
View File
@@ -36,7 +36,7 @@ func (pf *PeerForm) ToPeer() *model.Peer {
} }
} }
// PersonalAddressBookForm 个人地址簿表单 // PersonalAddressBookForm personal address book form
type PersonalAddressBookForm struct { type PersonalAddressBookForm struct {
model.AddressBook model.AddressBook
ForceAlwaysRelay string `json:"forceAlwaysRelay"` ForceAlwaysRelay string `json:"forceAlwaysRelay"`
+10 -10
View File
@@ -29,25 +29,25 @@ type DeviceInfoInLogin struct {
} }
type LoginForm struct { type LoginForm struct {
AutoLogin bool `json:"autoLogin" label:"自动登录"` AutoLogin bool `json:"autoLogin" label:"auto login"`
DeviceInfo DeviceInfoInLogin `json:"deviceInfo" label:"设备信息"` DeviceInfo DeviceInfoInLogin `json:"deviceInfo" label:"device info"`
Id string `json:"id" label:"id"` Id string `json:"id" label:"id"`
Type string `json:"type" label:"type"` Type string `json:"type" label:"type"`
Uuid string `json:"uuid" label:"uuid"` Uuid string `json:"uuid" label:"uuid"`
Username string `json:"username" validate:"required,gte=2,lte=32" label:"用户名"` Username string `json:"username" validate:"required,gte=2,lte=32" label:"username"`
Password string `json:"password,omitempty" validate:"gte=4,lte=32" label:"密码"` Password string `json:"password,omitempty" validate:"gte=4,lte=32" label:"password"`
} }
type UserListQuery struct { type UserListQuery struct {
Page uint `json:"page" form:"page" validate:"required" label:"页码"` Page uint `json:"page" form:"page" validate:"required" label:"page number"`
PageSize uint `json:"pageSize" form:"pageSize" validate:"required" label:"每页数量"` PageSize uint `json:"pageSize" form:"pageSize" validate:"required" label:"items per page"`
Status int `json:"status" form:"status" label:"状态"` Status int `json:"status" form:"status" label:"status"`
Accessible string `json:"accessible" form:"accessible"` Accessible string `json:"accessible" form:"accessible"`
} }
type PeerListQuery struct { type PeerListQuery struct {
Page uint `json:"page" form:"page" validate:"required" label:"页码"` Page uint `json:"page" form:"page" validate:"required" label:"page number"`
PageSize uint `json:"pageSize" form:"pageSize" validate:"required" label:"每页数量"` PageSize uint `json:"pageSize" form:"pageSize" validate:"required" label:"items per page"`
Status int `json:"status" form:"status" label:"状态"` Status int `json:"status" form:"status" label:"status"`
Accessible string `json:"accessible" form:"accessible"` Accessible string `json:"accessible" form:"accessible"`
} }
+2 -2
View File
@@ -22,7 +22,7 @@ type WebClientPeerInfoPayload struct {
func (wcpp *WebClientPeerPayload) FromAddressBook(a *model.AddressBook) { func (wcpp *WebClientPeerPayload) FromAddressBook(a *model.AddressBook) {
wcpp.ViewStyle = "shrink" wcpp.ViewStyle = "shrink"
//24小时前 //24 hours ago
wcpp.Tm = time.Now().Add(-time.Hour * 24).UnixNano() wcpp.Tm = time.Now().Add(-time.Hour * 24).UnixNano()
wcpp.Info = WebClientPeerInfoPayload{ wcpp.Info = WebClientPeerInfoPayload{
Username: a.Username, Username: a.Username,
@@ -34,7 +34,7 @@ func (wcpp *WebClientPeerPayload) FromAddressBook(a *model.AddressBook) {
func (wcpp *WebClientPeerPayload) FromShareRecord(sr *model.ShareRecord) { func (wcpp *WebClientPeerPayload) FromShareRecord(sr *model.ShareRecord) {
wcpp.ViewStyle = "shrink" wcpp.ViewStyle = "shrink"
//24小时前 //24 hours ago
wcpp.Tm = time.Now().UnixNano() wcpp.Tm = time.Now().UnixNano()
wcpp.Tmppwd = sr.Password wcpp.Tmppwd = sr.Password
wcpp.Info = WebClientPeerInfoPayload{ wcpp.Info = WebClientPeerInfoPayload{
+1 -1
View File
@@ -50,7 +50,7 @@ func Init(g *gin.Engine) {
RustdeskCmdBind(adg) RustdeskCmdBind(adg)
DeviceGroupBind(adg) DeviceGroupBind(adg)
//访问静态文件 //access static files
//g.StaticFS("/upload", http.Dir(global.Config.Gin.ResourcesPath+"/upload")) //g.StaticFS("/upload", http.Dir(global.Config.Gin.ResourcesPath+"/upload"))
} }
+6 -6
View File
@@ -18,7 +18,7 @@ func ApiInit(g *gin.Engine) {
if global.Config.App.ShowSwagger == 1 { if global.Config.App.ShowSwagger == 1 {
g.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, ginSwagger.InstanceName("api"))) g.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, ginSwagger.InstanceName("api")))
} }
// 加载 HTML 模板 // load HTML template
g.LoadHTMLGlob("resources/templates/*") g.LoadHTMLGlob("resources/templates/*")
frg := g.Group("/api") frg := g.Group("/api")
@@ -33,7 +33,7 @@ func ApiInit(g *gin.Engine) {
{ {
l := &api.Login{} l := &api.Login{}
// 如果返回oidc则可以通过oidc登录 // if oidc is returned, login via oidc is possible
frg.GET("/login-options", l.LoginOptions) frg.GET("/login-options", l.LoginOptions)
frg.POST("/login", l.Login) frg.POST("/login", l.Login)
@@ -56,7 +56,7 @@ func ApiInit(g *gin.Engine) {
} }
{ {
pe := &api.Peer{} pe := &api.Peer{}
//提交系统信息 //submit system info
frg.POST("/sysinfo", pe.SysInfo) frg.POST("/sysinfo", pe.SysInfo)
frg.POST("/sysinfo_ver", pe.SysInfoVer) frg.POST("/sysinfo_ver", pe.SysInfoVer)
} }
@@ -93,14 +93,14 @@ func ApiInit(g *gin.Engine) {
{ {
ab := &api.Ab{} ab := &api.Ab{}
//获取地址 //get address
frg.GET("/ab", ab.Ab) frg.GET("/ab", ab.Ab)
//更新地址 //update address
frg.POST("/ab", ab.UpAb) frg.POST("/ab", ab.UpAb)
} }
PersonalRoutes(frg) PersonalRoutes(frg)
//访问静态文件 //access static files
g.StaticFS("/upload", http.Dir(global.Config.Gin.ResourcesPath+"/public/upload")) g.StaticFS("/upload", http.Dir(global.Config.Gin.ResourcesPath+"/public/upload"))
} }
+2 -2
View File
@@ -10,7 +10,7 @@ type Handler interface {
Gc() error Gc() error
} }
// MaxTimeOut 最大超时时间 // MaxTimeOut maximum timeout
const ( const (
TypeMem = "memory" TypeMem = "memory"
@@ -49,7 +49,7 @@ func EncodeValue(value interface{}) (string, error) {
} }
func DecodeValue(value string, rtv interface{}) error { func DecodeValue(value string, rtv interface{}) error {
//判断rtv的类型是否是string,如果是string,直接赋值并返回 // check whether rtv's type is string; if so, assign directly and return
/*switch rtv.(type) { /*switch rtv.(type) {
case *string: case *string:
*(rtv.(*string)) = value *(rtv.(*string)) = value
+6 -6
View File
@@ -42,7 +42,7 @@ func TestFileCacheSet(t *testing.T) {
err := fc.Set("123", "ddd", 0) err := fc.Set("123", "ddd", 0)
if err != nil { if err != nil {
fmt.Println(err.Error()) fmt.Println(err.Error())
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
} }
@@ -50,12 +50,12 @@ func TestFileCacheGet(t *testing.T) {
fc := New("file") fc := New("file")
err := fc.Set("123", "45156", 300) err := fc.Set("123", "45156", 300)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
res := "" res := ""
err = fc.Get("123", &res) err = fc.Get("123", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
fmt.Println("res", res) fmt.Println("res", res)
} }
@@ -69,7 +69,7 @@ func TestRedisCacheSet(t *testing.T) {
err := rc.Set("123", "ddd", 0) err := rc.Set("123", "ddd", 0)
if err != nil { if err != nil {
fmt.Println(err.Error()) fmt.Println(err.Error())
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
} }
@@ -81,12 +81,12 @@ func TestRedisCacheGet(t *testing.T) {
}) })
err := rc.Set("123", "451156", 300) err := rc.Set("123", "451156", 300)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
res := "" res := ""
err = rc.Get("123", &res) err = rc.Get("123", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
fmt.Println("res", res) fmt.Println("res", res)
} }
+4 -4
View File
@@ -32,12 +32,12 @@ func (c *FileCache) Get(key string, value interface{}) error {
return err return err
} }
// 获取值,如果文件不存在或者过期,返回空,过滤掉错误 // get value; if the file does not exist or has expired, return empty and ignore errors
func (c *FileCache) getValue(key string) (string, error) { func (c *FileCache) getValue(key string) (string, error) {
f := c.fileName(key) f := c.fileName(key)
fileInfo, err := os.Stat(f) fileInfo, err := os.Stat(f)
if err != nil { if err != nil {
//文件不存在 // file does not exist
return "", nil return "", nil
} }
difT := time.Now().Sub(fileInfo.ModTime()) difT := time.Now().Sub(fileInfo.ModTime())
@@ -52,7 +52,7 @@ func (c *FileCache) getValue(key string) (string, error) {
return string(data), nil return string(data), nil
} }
// 保存值 // save value
func (c *FileCache) saveValue(key string, value string, exp int) error { func (c *FileCache) saveValue(key string, value string, exp int) error {
f := c.fileName(key) f := c.fileName(key)
lock := c.getLock(f) lock := c.getLock(f)
@@ -91,7 +91,7 @@ func (c *FileCache) fileName(key string) string {
} }
func (c *FileCache) Gc() error { func (c *FileCache) Gc() error {
//检查文件过期时间,并删除 // check file expiration time and delete
return nil return nil
} }
+7 -7
View File
@@ -11,7 +11,7 @@ func TestFileSet(t *testing.T) {
err := fc.Set("123", "ddd", 0) err := fc.Set("123", "ddd", 0)
if err != nil { if err != nil {
fmt.Println(err.Error()) fmt.Println(err.Error())
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
} }
@@ -21,7 +21,7 @@ func TestFileGet(t *testing.T) {
err := fc.Get("123", &res) err := fc.Get("123", &res)
if err != nil { if err != nil {
fmt.Println(err.Error()) fmt.Println(err.Error())
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
fmt.Println("res", res) fmt.Println("res", res)
} }
@@ -32,7 +32,7 @@ func TestFileSetGet(t *testing.T) {
err = fc.Get("key1", &res) err = fc.Get("key1", &res)
if err != nil { if err != nil {
fmt.Println(err.Error()) fmt.Println(err.Error())
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
fmt.Println("res", res) fmt.Println("res", res)
} }
@@ -46,7 +46,7 @@ func TestFileGetJson(t *testing.T) {
err2 := fc.Get("123", res) err2 := fc.Get("123", res)
fmt.Println("res", res) fmt.Println("res", res)
if err2 != nil { if err2 != nil {
t.Fatalf("读取失败" + err2.Error()) t.Fatalf("read failed" + err2.Error())
} }
} }
func TestFileSetGetJson(t *testing.T) { func TestFileSetGetJson(t *testing.T) {
@@ -59,7 +59,7 @@ func TestFileSetGetJson(t *testing.T) {
} }
err := fc.Set("123", old, 300) err := fc.Set("123", old, 300)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
//old_rr.AA = "aaa" //old_rr.AA = "aaa"
fmt.Println("old_rr", old) fmt.Println("old_rr", old)
@@ -68,10 +68,10 @@ func TestFileSetGetJson(t *testing.T) {
err2 := fc.Get("123", res) err2 := fc.Get("123", res)
fmt.Println("res", res) fmt.Println("res", res)
if err2 != nil { if err2 != nil {
t.Fatalf("读取失败" + err2.Error()) t.Fatalf("read failed" + err2.Error())
} }
if !reflect.DeepEqual(res, old) { if !reflect.DeepEqual(res, old) {
t.Fatalf("读取错误") t.Fatalf("read error")
} }
} }
+9 -9
View File
@@ -11,8 +11,8 @@ import (
type MemoryCache struct { type MemoryCache struct {
data map[string]*CacheItem data map[string]*CacheItem
ll *list.List // 用于实现LRU ll *list.List // used to implement LRU
pq PriorityQueue // 用于实现TTL pq PriorityQueue // used to implement TTL
quit chan struct{} quit chan struct{}
mu sync.Mutex mu sync.Mutex
maxBytes int64 maxBytes int64
@@ -58,12 +58,12 @@ func (pq *PriorityQueue) Pop() interface{} {
} }
func (m *MemoryCache) Get(key string, value interface{}) error { func (m *MemoryCache) Get(key string, value interface{}) error {
// 使用反射将存储的值设置到传入的指针变量中 // use reflection to set the stored value into the passed-in pointer variable
val := reflect.ValueOf(value) val := reflect.ValueOf(value)
if val.Kind() != reflect.Ptr { if val.Kind() != reflect.Ptr {
return errors.New("value must be a pointer") return errors.New("value must be a pointer")
} }
//设为空值 // set to zero value
val.Elem().Set(reflect.Zero(val.Elem().Type())) val.Elem().Set(reflect.Zero(val.Elem().Type()))
m.mu.Lock() m.mu.Lock()
@@ -78,7 +78,7 @@ func (m *MemoryCache) Get(key string, value interface{}) error {
m.deleteItem(item) m.deleteItem(item)
return nil return nil
} }
//移动到队列尾部 // move to the tail of the queue
m.ll.MoveToBack(item.ListEle) m.ll.MoveToBack(item.ListEle)
err := DecodeValue(item.Value, value) err := DecodeValue(item.Value, value)
@@ -97,11 +97,11 @@ func (m *MemoryCache) Set(key string, value interface{}, exp int) error {
if err != nil { if err != nil {
return err return err
} }
//key 所占用的内存 // memory occupied by the key
keyBytes := int64(len(key)) keyBytes := int64(len(key))
//value所占用的内存空间大小 // size of memory occupied by the value
valueBytes := int64(len(v)) valueBytes := int64(len(v))
//判断是否超过最大内存限制 // check whether the maximum memory limit is exceeded
if m.maxBytes != 0 && m.maxBytes < keyBytes+valueBytes { if m.maxBytes != 0 && m.maxBytes < keyBytes+valueBytes {
return errors.New("exceed maxBytes") return errors.New("exceed maxBytes")
} }
@@ -176,7 +176,7 @@ func (m *MemoryCache) startEviction() {
}() }()
} }
// stopEviction 停止定时清理 // stopEviction stops the scheduled cleanup
func (m *MemoryCache) stopEviction() { func (m *MemoryCache) stopEviction() {
close(m.quit) close(m.quit)
} }
+14 -14
View File
@@ -11,7 +11,7 @@ func TestMemorySet(t *testing.T) {
err := mc.Set("123", "44567", 0) err := mc.Set("123", "44567", 0)
if err != nil { if err != nil {
fmt.Println(err.Error()) fmt.Println(err.Error())
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
} }
@@ -22,10 +22,10 @@ func TestMemoryGet(t *testing.T) {
err := mc.Get("123", &res) err := mc.Get("123", &res)
fmt.Println("res", res) fmt.Println("res", res)
if err != nil { if err != nil {
t.Fatalf("读取失败 " + err.Error()) t.Fatalf("read failed " + err.Error())
} }
if res != "44567" { if res != "44567" {
t.Fatalf("读取错误") t.Fatalf("read error")
} }
} }
@@ -37,30 +37,30 @@ func TestMemorySetExpGet(t *testing.T) {
mc.Set("2", "5", 5) mc.Set("2", "5", 5)
err := mc.Set("3", "3", 3) err := mc.Set("3", "3", 3)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
res := "" res := ""
err = mc.Get("3", &res) err = mc.Get("3", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败" + err.Error()) t.Fatalf("read failed" + err.Error())
} }
fmt.Println("res 3", res) fmt.Println("res 3", res)
time.Sleep(4 * time.Second) time.Sleep(4 * time.Second)
//res = "" //res = ""
err = mc.Get("3", &res) err = mc.Get("3", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败" + err.Error()) t.Fatalf("read failed" + err.Error())
} }
fmt.Println("res 3", res) fmt.Println("res 3", res)
err = mc.Get("2", &res) err = mc.Get("2", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败" + err.Error()) t.Fatalf("read failed" + err.Error())
} }
fmt.Println("res 2", res) fmt.Println("res 2", res)
err = mc.Get("1", &res) err = mc.Get("1", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败" + err.Error()) t.Fatalf("read failed" + err.Error())
} }
fmt.Println("res 1", res) fmt.Println("res 1", res)
@@ -69,29 +69,29 @@ func TestMemoryLru(t *testing.T) {
mc := NewMemoryCache(18) mc := NewMemoryCache(18)
mc.Set("1", "1111", 10) mc.Set("1", "1111", 10)
mc.Set("2", "2222", 5) mc.Set("2", "2222", 5)
//读取一次,2就会被放到最后 // read once, so 2 will be moved to the end
mc.Get("1", nil) mc.Get("1", nil)
err := mc.Set("3", "", 3) err := mc.Set("3", "three", 3)
if err != nil { if err != nil {
//t.Fatalf("写入失败") //t.Fatalf("write failed")
} }
res := "" res := ""
err = mc.Get("3", &res) err = mc.Get("3", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败" + err.Error()) t.Fatalf("read failed" + err.Error())
} }
fmt.Println("res3", res) fmt.Println("res3", res)
res = "" res = ""
err = mc.Get("2", &res) err = mc.Get("2", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败" + err.Error()) t.Fatalf("read failed" + err.Error())
} }
fmt.Println("res2", res) fmt.Println("res2", res)
res = "" res = ""
err = mc.Get("1", &res) err = mc.Get("1", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败" + err.Error()) t.Fatalf("read failed" + err.Error())
} }
fmt.Println("res1", res) fmt.Println("res1", res)
+6 -6
View File
@@ -17,7 +17,7 @@ func TestRedisSet(t *testing.T) {
err := rc.Set("123", "ddd", 0) err := rc.Set("123", "ddd", 0)
if err != nil { if err != nil {
fmt.Println(err.Error()) fmt.Println(err.Error())
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
} }
@@ -29,12 +29,12 @@ func TestRedisGet(t *testing.T) {
}) })
err := rc.Set("123", "451156", 300) err := rc.Set("123", "451156", 300)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
res := "" res := ""
err = rc.Get("123", &res) err = rc.Get("123", &res)
if err != nil { if err != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
fmt.Println("res", res) fmt.Println("res", res)
} }
@@ -54,16 +54,16 @@ func TestRedisGetJson(t *testing.T) {
} }
err := rc.Set("1233", old, 300) err := rc.Set("1233", old, 300)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
res := &r{} res := &r{}
err2 := rc.Get("1233", res) err2 := rc.Get("1233", res)
if err2 != nil { if err2 != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
if !reflect.DeepEqual(res, old) { if !reflect.DeepEqual(res, old) {
t.Fatalf("读取错误") t.Fatalf("read error")
} }
fmt.Println(res, res.Aa) fmt.Println(res, res.Aa)
} }
+5 -5
View File
@@ -6,7 +6,7 @@ import (
"sync" "sync"
) )
// 此处实现了一个简单的缓存,用于测试 // implements a simple cache used for testing
// SimpleCache is a simple cache implementation // SimpleCache is a simple cache implementation
type SimpleCache struct { type SimpleCache struct {
data map[string]interface{} data map[string]interface{}
@@ -19,21 +19,21 @@ func (s *SimpleCache) Get(key string, value interface{}) error {
s.mu.Lock() s.mu.Lock()
defer s.mu.Unlock() defer s.mu.Unlock()
// 使用反射将存储的值设置到传入的指针变量中 // use reflection to set the stored value into the passed-in pointer variable
val := reflect.ValueOf(value) val := reflect.ValueOf(value)
if val.Kind() != reflect.Ptr { if val.Kind() != reflect.Ptr {
return errors.New("value must be a pointer") return errors.New("value must be a pointer")
} }
v, ok := s.data[key] v, ok := s.data[key]
if !ok { if !ok {
//设为空值 // set to zero value
val.Elem().Set(reflect.Zero(val.Elem().Type())) val.Elem().Set(reflect.Zero(val.Elem().Type()))
return nil return nil
} }
vval := reflect.ValueOf(v) vval := reflect.ValueOf(v)
if val.Elem().Type() != vval.Type() { if val.Elem().Type() != vval.Type() {
//设为空值 // set to zero value
val.Elem().Set(reflect.Zero(val.Elem().Type())) val.Elem().Set(reflect.Zero(val.Elem().Type()))
return nil return nil
} }
@@ -45,7 +45,7 @@ func (s *SimpleCache) Get(key string, value interface{}) error {
func (s *SimpleCache) Set(key string, value interface{}, exp int) error { func (s *SimpleCache) Set(key string, value interface{}, exp int) error {
s.mu.Lock() s.mu.Lock()
defer s.mu.Unlock() defer s.mu.Unlock()
// 检查传入的值是否是指针,如果是则取其值 // check whether the passed-in value is a pointer; if so, dereference it
val := reflect.ValueOf(value) val := reflect.ValueOf(value)
if val.Kind() == reflect.Ptr { if val.Kind() == reflect.Ptr {
val = val.Elem() val = val.Elem()
+11 -11
View File
@@ -9,11 +9,11 @@ func TestSimpleCache_Set(t *testing.T) {
s := NewSimpleCache() s := NewSimpleCache()
err := s.Set("key", "value", 0) err := s.Set("key", "value", 0)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
err = s.Set("key", 111, 0) err = s.Set("key", 111, 0)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
} }
@@ -24,7 +24,7 @@ func TestSimpleCache_Get(t *testing.T) {
err = s.Get("key", &value) err = s.Get("key", &value)
fmt.Println("value", value) fmt.Println("value", value)
if err != nil { if err != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
err = s.Set("key1", 11, 0) err = s.Set("key1", 11, 0)
@@ -32,7 +32,7 @@ func TestSimpleCache_Get(t *testing.T) {
err = s.Get("key1", &value1) err = s.Get("key1", &value1)
fmt.Println("value1", value1) fmt.Println("value1", value1)
if err != nil { if err != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
err = s.Set("key2", []byte{'a', 'b'}, 0) err = s.Set("key2", []byte{'a', 'b'}, 0)
@@ -40,7 +40,7 @@ func TestSimpleCache_Get(t *testing.T) {
err = s.Get("key2", &value2) err = s.Get("key2", &value2)
fmt.Println("value2", string(value2)) fmt.Println("value2", string(value2))
if err != nil { if err != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
err = s.Set("key3", 33.33, 0) err = s.Set("key3", 33.33, 0)
@@ -48,7 +48,7 @@ func TestSimpleCache_Get(t *testing.T) {
err = s.Get("key3", &value3) err = s.Get("key3", &value3)
fmt.Println("value3", value3) fmt.Println("value3", value3)
if err != nil { if err != nil {
t.Fatalf("读取失败") t.Fatalf("read failed")
} }
} }
@@ -80,18 +80,18 @@ func TestSimpleCache_GetStruct(t *testing.T) {
} }
err := s.Set("key", old, 300) err := s.Set("key", old, 300)
if err != nil { if err != nil {
t.Fatalf("写入失败") t.Fatalf("write failed")
} }
res := &r{} res := &r{}
err2 := s.Get("key", res) err2 := s.Get("key", res)
fmt.Println("res", res) fmt.Println("res", res)
if err2 != nil { if err2 != nil {
t.Fatalf("读取失败" + err2.Error()) t.Fatalf("read failed" + err2.Error())
} }
//修改原始值,看后面是否会变化 // modify the original value to see whether it changes afterward
old.A = "aa" old.A = "aa"
old_rr.AA = "aaa" old_rr.AA = "aaa"
fmt.Println("old", old) fmt.Println("old", old)
@@ -99,10 +99,10 @@ func TestSimpleCache_GetStruct(t *testing.T) {
err3 := s.Get("key", res2) err3 := s.Get("key", res2)
fmt.Println("res2", res2, res2.R.AA, res2.R.BB) fmt.Println("res2", res2, res2.R.AA, res2.R.BB)
if err3 != nil { if err3 != nil {
t.Fatalf("读取失败" + err3.Error()) t.Fatalf("read failed" + err3.Error())
} }
//if reflect.DeepEqual(res, old) { //if reflect.DeepEqual(res, old) {
// t.Fatalf("读取错误") // t.Fatalf("read error")
//} //}
} }
+6 -6
View File
@@ -34,30 +34,30 @@ Hj4yO4j5LOWDMTgDcLsZTxbGiTzkNc/HghrNIevDAQdgjJQNl84zDjyyCA4r/MA7
bYJTtYj8q6J0EDbRdT9b6hMclyzjNXdx2loJxR0R8WUeL1lDEPq8 bYJTtYj8q6J0EDbRdT9b6hMclyzjNXdx2loJxR0R8WUeL1lDEPq8
-----END RSA PRIVATE KEY-----` -----END RSA PRIVATE KEY-----`
// 测试token生成 // test token generation
func TestGenerateToken(t *testing.T) { func TestGenerateToken(t *testing.T) {
jwtService := NewJwt(pk, time.Second*1000) jwtService := NewJwt(pk, time.Second*1000)
token := jwtService.GenerateToken(1) token := jwtService.GenerateToken(1)
if token == "" { if token == "" {
t.Fatal("token生成失败") t.Fatal("token generation failed")
} }
fmt.Println(pk, token) fmt.Println(pk, token)
} }
// 测试token解析 // test token parsing
func TestParseToken(t *testing.T) { func TestParseToken(t *testing.T) {
jwtService := NewJwt(pk, time.Second*1000) jwtService := NewJwt(pk, time.Second*1000)
token := jwtService.GenerateToken(999) token := jwtService.GenerateToken(999)
if token == "" { if token == "" {
t.Fatal("token生成失败") t.Fatal("token generation failed")
} }
uid, err := jwtService.ParseToken(token) uid, err := jwtService.ParseToken(token)
if err != nil { if err != nil {
t.Fatal("token解析失败", err) t.Fatal("token parsing failed", err)
} }
if uid != 999 { if uid != 999 {
t.Fatal("token解析失败") t.Fatal("token parsing failed")
} }
} }
+1 -1
View File
@@ -27,7 +27,7 @@ func New(c *Config) *log.Logger {
//FieldsOrder: []string{"name", "age"}, //FieldsOrder: []string{"name", "age"},
}) })
// 日志文件 // log file
f := c.Path f := c.Path
var write io.Writer var write io.Writer
if f != "" { if f != "" {
+7 -7
View File
@@ -17,11 +17,11 @@ type MysqlConfig struct {
func NewMysql(mysqlConf *MysqlConfig, logwriter logger.Writer) *gorm.DB { func NewMysql(mysqlConf *MysqlConfig, logwriter logger.Writer) *gorm.DB {
db, err := gorm.Open(mysql.New(mysql.Config{ db, err := gorm.Open(mysql.New(mysql.Config{
DSN: mysqlConf.Dsn, // DSN data source name DSN: mysqlConf.Dsn, // DSN data source name
DefaultStringSize: 256, // string 类型字段的默认长度 DefaultStringSize: 256, // default length for string type fields
//DisableDatetimePrecision: true, // 禁用 datetime 精度,MySQL 5.6 之前的数据库不支持 //DisableDatetimePrecision: true, // disable datetime precision; not supported by databases before MySQL 5.6
//DontSupportRenameIndex: true, // 重命名索引时采用删除并新建的方式,MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引 //DontSupportRenameIndex: true, // rename indexes by dropping and recreating them; databases before MySQL 5.7 and MariaDB do not support renaming indexes
//DontSupportRenameColumn: true, // 用 `change` 重命名列,MySQL 8 之前的数据库和 MariaDB 不支持重命名列 //DontSupportRenameColumn: true, // rename columns using `change`; databases before MySQL 8 and MariaDB do not support renaming columns
//SkipInitializeWithVersion: false, // 根据当前 MySQL 版本自动配置 //SkipInitializeWithVersion: false, // auto-configure based on the current MySQL version
}), &gorm.Config{ }), &gorm.Config{
DisableForeignKeyConstraintWhenMigrating: true, DisableForeignKeyConstraintWhenMigrating: true,
Logger: logger.New( Logger: logger.New(
@@ -42,10 +42,10 @@ func NewMysql(mysqlConf *MysqlConfig, logwriter logger.Writer) *gorm.DB {
if err2 != nil { if err2 != nil {
fmt.Println(err2) fmt.Println(err2)
} }
// SetMaxIdleConns 设置空闲连接池中连接的最大数量 // SetMaxIdleConns sets the maximum number of connections in the idle connection pool
sqlDB.SetMaxIdleConns(mysqlConf.MaxIdleConns) sqlDB.SetMaxIdleConns(mysqlConf.MaxIdleConns)
// SetMaxOpenConns 设置打开数据库连接的最大数量。 // SetMaxOpenConns sets the maximum number of open database connections.
sqlDB.SetMaxOpenConns(mysqlConf.MaxOpenConns) sqlDB.SetMaxOpenConns(mysqlConf.MaxOpenConns)
return db return db
+2 -2
View File
@@ -35,10 +35,10 @@ func NewPostgresql(conf *PostgresqlConfig, logwriter logger.Writer) *gorm.DB {
if err2 != nil { if err2 != nil {
fmt.Println(err2) fmt.Println(err2)
} }
// SetMaxIdleConns 设置空闲连接池中连接的最大数量 // SetMaxIdleConns sets the maximum number of connections in the idle connection pool
sqlDB.SetMaxIdleConns(conf.MaxIdleConns) sqlDB.SetMaxIdleConns(conf.MaxIdleConns)
// SetMaxOpenConns 设置打开数据库连接的最大数量。 // SetMaxOpenConns sets the maximum number of open database connections.
sqlDB.SetMaxOpenConns(conf.MaxOpenConns) sqlDB.SetMaxOpenConns(conf.MaxOpenConns)
return db return db
+2 -2
View File
@@ -34,10 +34,10 @@ func NewSqlite(sqliteConf *SqliteConfig, logwriter logger.Writer) *gorm.DB {
if err2 != nil { if err2 != nil {
fmt.Println(err2) fmt.Println(err2)
} }
// SetMaxIdleConns 设置空闲连接池中连接的最大数量 // SetMaxIdleConns sets the maximum number of connections in the idle connection pool
sqlDB.SetMaxIdleConns(sqliteConf.MaxIdleConns) sqlDB.SetMaxIdleConns(sqliteConf.MaxIdleConns)
// SetMaxOpenConns 设置打开数据库连接的最大数量。 // SetMaxOpenConns sets the maximum number of open database connections.
sqlDB.SetMaxOpenConns(sqliteConf.MaxOpenConns) sqlDB.SetMaxOpenConns(sqliteConf.MaxOpenConns)
return db return db
+5 -5
View File
@@ -240,11 +240,11 @@ func getMD5FromNewAuthString(r *http.Request) ([]byte, error) {
} }
/* VerifySignature /* VerifySignature
* VerifySignature需要三个重要的数据信息来进行签名验证: 1>获取公钥PublicKey; 2>生成新的MD5鉴权串; 3>解码Request携带的鉴权串; * VerifySignature needs three pieces of data to perform signature verification: 1> obtain the public key PublicKey; 2> generate a new MD5 authentication string; 3> decode the authentication string carried by the Request;
* 1>获取公钥PublicKey : 从RequestHeader的"x-oss-pub-key-url"字段中获取 URL, 读取URL链接的包含的公钥内容, 进行解码解析, 将其作为rsa.VerifyPKCS1v15的入参。 * 1> obtain the public key PublicKey: get the URL from the "x-oss-pub-key-url" field of the RequestHeader, read the public key content the URL points to, decode and parse it, and use it as the input parameter of rsa.VerifyPKCS1v15.
* 2>生成新的MD5鉴权串 : 把Request中的url中的path部分进行urldecode 加上url的query部分, 再加上body, 组合之后进行MD5编码, 得到MD5鉴权字节串。 * 2> generate a new MD5 authentication string: urldecode the path part of the url in the Request, append the query part of the url, then append the body, combine them and apply MD5 encoding to obtain the MD5 authentication byte string.
* 3>解码Request携带的鉴权串 获取RequestHeader的"authorization"字段, 对其进行Base64解码,作为签名验证的鉴权对比串。 * 3> decode the authentication string carried by the Request: get the "authorization" field of the RequestHeader and Base64-decode it to use as the comparison authentication string for signature verification.
* rsa.VerifyPKCS1v15进行签名验证,返回验证结果。 * rsa.VerifyPKCS1v15 performs the signature verification and returns the result.
* */ * */
func verifySignature(bytePublicKey []byte, byteMd5 []byte, authorization []byte) bool { func verifySignature(bytePublicKey []byte, byteMd5 []byte, authorization []byte) bool {
pubBlock, _ := pem.Decode(bytePublicKey) pubBlock, _ := pem.Decode(bytePublicKey)
+3 -3
View File
@@ -17,7 +17,7 @@ import "github.com/lejianwen/rustdesk-api/v2/model/custom_types"
// String loginName; //login username // String loginName; //login username
// bool? sameServer; // bool? sameServer;
// AddressBook 有些字段是Personal才会上传的 // AddressBook some fields are only uploaded for Personal
type AddressBook struct { type AddressBook struct {
RowId uint `gorm:"primaryKey" json:"row_id"` RowId uint `gorm:"primaryKey" json:"row_id"`
Id string `json:"id" gorm:"default:0;not null;index"` Id string `json:"id" gorm:"default:0;not null;index"`
@@ -59,8 +59,8 @@ type AddressBookCollectionRule struct {
IdModel IdModel
UserId uint `json:"user_id" gorm:"default:0;not null;"` UserId uint `json:"user_id" gorm:"default:0;not null;"`
CollectionId uint `json:"collection_id" gorm:"default:0;not null;index" validate:"required"` CollectionId uint `json:"collection_id" gorm:"default:0;not null;index" validate:"required"`
Rule int `json:"rule" gorm:"default:0;not null;" validate:"required,gte=1,lte=3"` // 0: 无 1: 读 2: 读写 3: 完全控制 Rule int `json:"rule" gorm:"default:0;not null;" validate:"required,gte=1,lte=3"` // 0: none 1: read 2: read-write 3: full control
Type int `json:"type" gorm:"default:1;not null;" validate:"required,gte=1,lte=2"` // 1: 个人 2: 群组 Type int `json:"type" gorm:"default:1;not null;" validate:"required,gte=1,lte=2"` // 1: personal 2: group
ToId uint `json:"to_id" gorm:"default:0;not null;" validate:"required,gt=0"` ToId uint `json:"to_id" gorm:"default:0;not null;" validate:"required,gt=0"`
TimeModel TimeModel
} }
+2 -2
View File
@@ -7,7 +7,7 @@ import (
"fmt" "fmt"
) )
// AutoJson 数据类型 // AutoJson data type
type AutoJson json.RawMessage type AutoJson json.RawMessage
func (j *AutoJson) Scan(value interface{}) error { func (j *AutoJson) Scan(value interface{}) error {
@@ -33,7 +33,7 @@ func (j *AutoJson) Scan(value interface{}) error {
} }
result := &json.RawMessage{} result := &json.RawMessage{}
err := json.Unmarshal(bytes, result) err := json.Unmarshal(bytes, result)
//解析json错误 返回空 // json parse error, return empty
if err != nil { if err != nil {
*j = AutoJson(json.RawMessage{'[', ']'}) *j = AutoJson(json.RawMessage{'[', ']'})
return nil return nil
+1 -1
View File
@@ -5,7 +5,7 @@ import (
"time" "time"
) )
// AutoTime 自定义时间格式 // AutoTime custom time format
type AutoTime time.Time type AutoTime time.Time
func (mt AutoTime) Value() (driver.Value, error) { func (mt AutoTime) Value() (driver.Value, error) {
+2 -2
View File
@@ -1,8 +1,8 @@
package model package model
const ( const (
GroupTypeDefault = 1 // 默认 GroupTypeDefault = 1 // default
GroupTypeShare = 2 // 共享 GroupTypeShare = 2 // shared
) )
type Group struct { type Group struct {
+2 -2
View File
@@ -7,8 +7,8 @@ import (
type StatusCode int type StatusCode int
const ( const (
COMMON_STATUS_ENABLE StatusCode = 1 //通用状态 启用 COMMON_STATUS_ENABLE StatusCode = 1 // common status: enabled
COMMON_STATUS_DISABLED StatusCode = 2 //通用状态 禁用 COMMON_STATUS_DISABLED StatusCode = 2 // common status: disabled
) )
type IdModel struct { type IdModel struct {
+2 -2
View File
@@ -119,7 +119,7 @@ type OidcUser struct {
func (ou *OidcUser) ToOauthUser() *OauthUser { func (ou *OidcUser) ToOauthUser() *OauthUser {
var username string var username string
// 使用 PreferredUsername,如果不存在,降级到 Email 前缀 // Use PreferredUsername; if not present, fall back to the Email prefix
if ou.PreferredUsername != "" { if ou.PreferredUsername != "" {
username = ou.PreferredUsername username = ou.PreferredUsername
} else { } else {
@@ -169,7 +169,7 @@ func (lu *LinuxdoUser) ToOauthUser() *OauthUser {
Name: lu.Name, Name: lu.Name,
Username: strings.ToLower(lu.Username), Username: strings.ToLower(lu.Username),
Email: lu.Email, Email: lu.Email,
VerifiedEmail: true, // linux.do 用户邮箱默认已验证 VerifiedEmail: true, // linux.do user emails are verified by default
Picture: lu.Avatar, Picture: lu.Avatar,
} }
} }
+1 -1
View File
@@ -11,7 +11,7 @@ type ShareRecord struct {
TimeModel TimeModel
} }
// ShareRecordList 分享记录列表 // ShareRecordList share record list
type ShareRecordList struct { type ShareRecordList struct {
ShareRecords []*ShareRecord `json:"list,omitempty"` ShareRecords []*ShareRecord `json:"list,omitempty"`
Pagination Pagination
+1 -1
View File
@@ -4,7 +4,7 @@ type Tag struct {
IdModel IdModel
Name string `json:"name" gorm:"default:'';not null;"` Name string `json:"name" gorm:"default:'';not null;"`
UserId uint `json:"user_id" gorm:"default:0;not null;index"` UserId uint `json:"user_id" gorm:"default:0;not null;index"`
Color uint `json:"color" gorm:"default:0;not null;"` //color flutter的颜色值,从0x00000000 0xFFFFFFFF; 前两位表示透明度,后面6位表示颜色, 可以转成rgba Color uint `json:"color" gorm:"default:0;not null;"` //color is a flutter color value, from 0x00000000 to 0xFFFFFFFF; the first two digits represent the alpha (transparency), the remaining 6 digits represent the color, can be converted to rgba
CollectionId uint `json:"collection_id" gorm:"default:0;not null;index"` CollectionId uint `json:"collection_id" gorm:"default:0;not null;index"`
Collection *AddressBookCollection `json:"collection,omitempty"` Collection *AddressBookCollection `json:"collection,omitempty"`
TimeModel TimeModel
+2 -2
View File
@@ -15,9 +15,9 @@ type User struct {
TimeModel TimeModel
} }
// BeforeSave 钩子用于确保 email 字段有合理的默认值 // BeforeSave hook ensures the email field has a sensible default value
//func (u *User) BeforeSave(tx *gorm.DB) (err error) { //func (u *User) BeforeSave(tx *gorm.DB) (err error) {
// // 如果 email 为空,设置为默认值 // // If email is empty, set it to a default value
// if u.Email == "" { // if u.Email == "" {
// u.Email = fmt.Sprintf("%s@example.com", u.Username) // u.Email = fmt.Sprintf("%s@example.com", u.Username)
// } // }
+17 -17
View File
@@ -53,29 +53,29 @@ func (s *AddressBookService) AddAddressBook(ab *model.AddressBook) error {
// UpdateAddressBook // UpdateAddressBook
func (s *AddressBookService) UpdateAddressBook(abs []*model.AddressBook, userId uint) error { func (s *AddressBookService) UpdateAddressBook(abs []*model.AddressBook, userId uint) error {
//比较peers和数据库中的数据,如果peers中的数据在数据库中不存在,则添加,如果存在则更新,如果数据库中的数据在peers中不存在,则删除 // compare peers with the data in the database: if a peer does not exist in the database, add it; if it exists, update it; if data in the database does not exist in peers, delete it
// 开始事务 // begin transaction
tx := DB.Begin() tx := DB.Begin()
//1. 获取数据库中的数据 // 1. get the data in the database
var dbABs []*model.AddressBook var dbABs []*model.AddressBook
tx.Where("user_id = ?", userId).Find(&dbABs) tx.Where("user_id = ?", userId).Find(&dbABs)
//2. 比较peers和数据库中的数据 // 2. compare peers with the data in the database
//2.1 获取peers中的id // 2.1 get the ids in peers
aBIds := make(map[string]*model.AddressBook) aBIds := make(map[string]*model.AddressBook)
for _, ab := range abs { for _, ab := range abs {
aBIds[ab.Id] = ab aBIds[ab.Id] = ab
} }
//2.2 获取数据库中的id // 2.2 get the ids from the database
dbABIds := make(map[string]*model.AddressBook) dbABIds := make(map[string]*model.AddressBook)
for _, dbAb := range dbABs { for _, dbAb := range dbABs {
dbABIds[dbAb.Id] = dbAb dbABIds[dbAb.Id] = dbAb
} }
//2.3 比较peers和数据库中的数据 // 2.3 compare peers with the data in the database
for id, ab := range aBIds { for id, ab := range aBIds {
dbAB, ok := dbABIds[id] dbAB, ok := dbABIds[id]
ab.UserId = userId ab.UserId = userId
if !ok { if !ok {
//添加 //add
if ab.Platform == "" || ab.Username == "" || ab.Hostname == "" { if ab.Platform == "" || ab.Username == "" || ab.Hostname == "" {
peer := AllService.PeerService.FindById(ab.Id) peer := AllService.PeerService.FindById(ab.Id)
if peer.RowId != 0 { if peer.RowId != 0 {
@@ -86,11 +86,11 @@ func (s *AddressBookService) UpdateAddressBook(abs []*model.AddressBook, userId
} }
tx.Create(ab) tx.Create(ab)
} else { } else {
//更新 //update
tx.Model(&model.AddressBook{}).Where("row_id = ?", dbAB.RowId).Updates(ab) tx.Model(&model.AddressBook{}).Where("row_id = ?", dbAB.RowId).Updates(ab)
} }
} }
//2.4 删除 // 2.4 delete
for id, dbAB := range dbABIds { for id, dbAB := range dbABIds {
_, ok := aBIds[id] _, ok := aBIds[id]
if !ok { if !ok {
@@ -126,7 +126,7 @@ func (s *AddressBookService) FromPeer(peer *model.Peer) (a *model.AddressBook) {
return a return a
} }
// Create 创建 // Create create
func (s *AddressBookService) Create(u *model.AddressBook) error { func (s *AddressBookService) Create(u *model.AddressBook) error {
res := DB.Create(u).Error res := DB.Create(u).Error
return res return res
@@ -135,22 +135,22 @@ func (s *AddressBookService) Delete(u *model.AddressBook) error {
return DB.Delete(u).Error return DB.Delete(u).Error
} }
// Update 更新 // Update update
func (s *AddressBookService) Update(u *model.AddressBook) error { func (s *AddressBookService) Update(u *model.AddressBook) error {
return DB.Model(u).Updates(u).Error return DB.Model(u).Updates(u).Error
} }
// UpdateByMap 更新 // UpdateByMap update
func (s *AddressBookService) UpdateByMap(u *model.AddressBook, data map[string]interface{}) error { func (s *AddressBookService) UpdateByMap(u *model.AddressBook, data map[string]interface{}) error {
return DB.Model(u).Updates(data).Error return DB.Model(u).Updates(data).Error
} }
// UpdateAll 更新 // UpdateAll update
func (s *AddressBookService) UpdateAll(u *model.AddressBook) error { func (s *AddressBookService) UpdateAll(u *model.AddressBook) error {
return DB.Model(u).Select("*").Omit("created_at").Updates(u).Error return DB.Model(u).Select("*").Omit("created_at").Updates(u).Error
} }
// ShareByWebClient 分享 // ShareByWebClient share
func (s *AddressBookService) ShareByWebClient(m *model.ShareRecord) error { func (s *AddressBookService) ShareByWebClient(m *model.ShareRecord) error {
m.ShareToken = uuid.New().String() m.ShareToken = uuid.New().String()
return DB.Create(m).Error return DB.Create(m).Error
@@ -279,7 +279,7 @@ func (s *AddressBookService) UpdateCollection(t *model.AddressBookCollection) er
} }
func (s *AddressBookService) DeleteCollection(t *model.AddressBookCollection) error { func (s *AddressBookService) DeleteCollection(t *model.AddressBookCollection) error {
//删除集合下的所有规则、地址簿,再删除集合 //delete all rules and address books under the collection, then delete the collection
tx := DB.Begin() tx := DB.Begin()
tx.Where("collection_id = ?", t.Id).Delete(&model.AddressBookCollectionRule{}) tx.Where("collection_id = ?", t.Id).Delete(&model.AddressBookCollectionRule{})
tx.Where("collection_id = ?", t.Id).Delete(&model.AddressBook{}) tx.Where("collection_id = ?", t.Id).Delete(&model.AddressBook{})
@@ -326,7 +326,7 @@ func (s *AddressBookService) DeleteRule(t *model.AddressBookCollectionRule) erro
return DB.Delete(t).Error return DB.Delete(t).Error
} }
// CheckCollectionOwner 检查Collection的所有者 // CheckCollectionOwner checkCollection's owner
func (s *AddressBookService) CheckCollectionOwner(uid uint, cid uint) bool { func (s *AddressBookService) CheckCollectionOwner(uid uint, cid uint) bool {
p := s.CollectionInfoById(cid) p := s.CollectionInfoById(cid)
return p.UserId == uid return p.UserId == uid
+8 -8
View File
@@ -9,25 +9,25 @@ import (
func TestGetAppVersion(t *testing.T) { func TestGetAppVersion(t *testing.T) {
s := &AppService{} s := &AppService{}
v := s.GetAppVersion() v := s.GetAppVersion()
// 打印结果 // print result
t.Logf("App Version: %s", v) t.Logf("App Version: %s", v)
} }
func TestMultipleGetAppVersion(t *testing.T) { func TestMultipleGetAppVersion(t *testing.T) {
s := &AppService{} s := &AppService{}
//并发测试 //concurrency test
// 使用 WaitGroup 等待所有 goroutine 完成 // use a WaitGroup to wait for all goroutines to finish
wg := sync.WaitGroup{} wg := sync.WaitGroup{}
wg.Add(10) // 启动 10 goroutine wg.Add(10) // start 10 goroutine
// 启动 10 goroutine // start 10 goroutine
for i := 0; i < 10; i++ { for i := 0; i < 10; i++ {
go func() { go func() {
defer wg.Done() // 完成后减少计数 defer wg.Done() // decrement the count when done
v := s.GetAppVersion() v := s.GetAppVersion()
// 打印结果 // print result
t.Logf("App Version: %s", v) t.Logf("App Version: %s", v)
}() }()
} }
// 等待所有 goroutine 完成 // wait for all goroutine done
wg.Wait() wg.Wait()
} }
+3 -3
View File
@@ -22,7 +22,7 @@ func (as *AuditService) AuditConnList(page, pageSize uint, where func(tx *gorm.D
return return
} }
// Create 创建 // Create create
func (as *AuditService) CreateAuditConn(u *model.AuditConn) error { func (as *AuditService) CreateAuditConn(u *model.AuditConn) error {
res := DB.Create(u).Error res := DB.Create(u).Error
return res return res
@@ -31,7 +31,7 @@ func (as *AuditService) DeleteAuditConn(u *model.AuditConn) error {
return DB.Delete(u).Error return DB.Delete(u).Error
} }
// Update 更新 // Update update
func (as *AuditService) UpdateAuditConn(u *model.AuditConn) error { func (as *AuditService) UpdateAuditConn(u *model.AuditConn) error {
return DB.Model(u).Updates(u).Error return DB.Model(u).Updates(u).Error
} }
@@ -80,7 +80,7 @@ func (as *AuditService) DeleteAuditFile(u *model.AuditFile) error {
return DB.Delete(u).Error return DB.Delete(u).Error
} }
// Update 更新 // Update update
func (as *AuditService) UpdateAuditFile(u *model.AuditFile) error { func (as *AuditService) UpdateAuditFile(u *model.AuditFile) error {
return DB.Model(u).Updates(u).Error return DB.Model(u).Updates(u).Error
} }
+4 -4
View File
@@ -8,7 +8,7 @@ import (
type GroupService struct { type GroupService struct {
} }
// InfoById 根据用户id取用户信息 // InfoById gets the group info by id
func (us *GroupService) InfoById(id uint) *model.Group { func (us *GroupService) InfoById(id uint) *model.Group {
u := &model.Group{} u := &model.Group{}
DB.Where("id = ?", id).First(u) DB.Where("id = ?", id).First(u)
@@ -29,7 +29,7 @@ func (us *GroupService) List(page, pageSize uint, where func(tx *gorm.DB)) (res
return return
} }
// Create 创建 // Create create
func (us *GroupService) Create(u *model.Group) error { func (us *GroupService) Create(u *model.Group) error {
res := DB.Create(u).Error res := DB.Create(u).Error
return res return res
@@ -38,12 +38,12 @@ func (us *GroupService) Delete(u *model.Group) error {
return DB.Delete(u).Error return DB.Delete(u).Error
} }
// Update 更新 // Update update
func (us *GroupService) Update(u *model.Group) error { func (us *GroupService) Update(u *model.Group) error {
return DB.Model(u).Updates(u).Error return DB.Model(u).Updates(u).Error
} }
// DeviceGroupInfoById 根据用户id取用户信息 // DeviceGroupInfoById gets the device group info by id
func (us *GroupService) DeviceGroupInfoById(id uint) *model.DeviceGroup { func (us *GroupService) DeviceGroupInfoById(id uint) *model.DeviceGroup {
u := &model.DeviceGroup{} u := &model.DeviceGroup{}
DB.Where("id = ?", id).First(u) DB.Where("id = ?", id).First(u)
+3 -3
View File
@@ -8,7 +8,7 @@ import (
type LoginLogService struct { type LoginLogService struct {
} }
// InfoById 根据用户id取用户信息 // InfoById gets the login log info by id
func (us *LoginLogService) InfoById(id uint) *model.LoginLog { func (us *LoginLogService) InfoById(id uint) *model.LoginLog {
u := &model.LoginLog{} u := &model.LoginLog{}
DB.Where("id = ?", id).First(u) DB.Where("id = ?", id).First(u)
@@ -29,7 +29,7 @@ func (us *LoginLogService) List(page, pageSize uint, where func(tx *gorm.DB)) (r
return return
} }
// Create 创建 // Create create
func (us *LoginLogService) Create(u *model.LoginLog) error { func (us *LoginLogService) Create(u *model.LoginLog) error {
res := DB.Create(u).Error res := DB.Create(u).Error
return res return res
@@ -38,7 +38,7 @@ func (us *LoginLogService) Delete(u *model.LoginLog) error {
return DB.Delete(u).Error return DB.Delete(u).Error
} }
// Update 更新 // Update update
func (us *LoginLogService) Update(u *model.LoginLog) error { func (us *LoginLogService) Update(u *model.LoginLog) error {
return DB.Model(u).Updates(u).Error return DB.Model(u).Updates(u).Error
} }
+20 -20
View File
@@ -36,7 +36,7 @@ type OidcEndpoint struct {
type OauthCacheItem struct { type OauthCacheItem struct {
UserId uint `json:"user_id"` UserId uint `json:"user_id"`
Id string `json:"id"` //rustdesk的设备ID Id string `json:"id"` //rustdesk's devicesID
Op string `json:"op"` Op string `json:"op"`
Action string `json:"action"` Action string `json:"action"`
Uuid string `json:"uuid"` Uuid string `json:"uuid"`
@@ -196,7 +196,7 @@ func (os *OauthService) GetOauthConfig(op string) (err error, oauthInfo *model.O
provider = os.LinuxdoProvider() provider = os.LinuxdoProvider()
oauthConfig.Endpoint = provider.Endpoint() oauthConfig.Endpoint = provider.Endpoint()
oauthConfig.Scopes = []string{"profile"} oauthConfig.Scopes = []string{"profile"}
//case model.OauthTypeGoogle: //google单独出来,可以少一次FetchOidcEndpoint请求 //case model.OauthTypeGoogle: //google separately to save one FetchOidcEndpointrequest
// oauthConfig.Endpoint = google.Endpoint // oauthConfig.Endpoint = google.Endpoint
// oauthConfig.Scopes = os.constructScopes(oauthInfo.Scopes) // oauthConfig.Scopes = os.constructScopes(oauthInfo.Scopes)
case model.OauthTypeOidc, model.OauthTypeGoogle: case model.OauthTypeOidc, model.OauthTypeGoogle:
@@ -234,7 +234,7 @@ func getHTTPClientWithProxy() *http.Client {
} }
func (os *OauthService) callbackBase(oauthConfig *oauth2.Config, provider *oidc.Provider, code string, verifier string, nonce string, userData interface{}) (err error, client *http.Client) { func (os *OauthService) callbackBase(oauthConfig *oauth2.Config, provider *oidc.Provider, code string, verifier string, nonce string, userData interface{}) (err error, client *http.Client) {
// 设置代理客户端 // set proxy client
httpClient := getHTTPClientWithProxy() httpClient := getHTTPClientWithProxy()
ctx := context.WithValue(context.Background(), oauth2.HTTPClient, httpClient) ctx := context.WithValue(context.Background(), oauth2.HTTPClient, httpClient)
@@ -250,10 +250,10 @@ func (os *OauthService) callbackBase(oauthConfig *oauth2.Config, provider *oidc.
return errors.New("GetOauthTokenError"), nil return errors.New("GetOauthTokenError"), nil
} }
// 获取 ID Token github没有id_token // get the ID Token; github has no id_token
rawIDToken, ok := token.Extra("id_token").(string) rawIDToken, ok := token.Extra("id_token").(string)
if ok && rawIDToken != "" { if ok && rawIDToken != "" {
// 验证 ID Token // verify ID Token
v := provider.Verifier(&oidc.Config{ClientID: oauthConfig.ClientID}) v := provider.Verifier(&oidc.Config{ClientID: oauthConfig.ClientID})
idToken, err2 := v.Verify(ctx, rawIDToken) idToken, err2 := v.Verify(ctx, rawIDToken)
if err2 != nil { if err2 != nil {
@@ -261,7 +261,7 @@ func (os *OauthService) callbackBase(oauthConfig *oauth2.Config, provider *oidc.
return errors.New("IdTokenVerifyError"), nil return errors.New("IdTokenVerifyError"), nil
} }
if nonce != "" { if nonce != "" {
// 验证 nonce // verify nonce
var claims struct { var claims struct {
Nonce string `json:"nonce"` Nonce string `json:"nonce"`
} }
@@ -277,7 +277,7 @@ func (os *OauthService) callbackBase(oauthConfig *oauth2.Config, provider *oidc.
} }
} }
// 获取用户信息 // get user info
client = oauthConfig.Client(ctx, token) client = oauthConfig.Client(ctx, token)
resp, err := client.Get(provider.UserInfoEndpoint()) resp, err := client.Get(provider.UserInfoEndpoint())
if err != nil { if err != nil {
@@ -290,7 +290,7 @@ func (os *OauthService) callbackBase(oauthConfig *oauth2.Config, provider *oidc.
} }
}() }()
// 解析用户信息 // parse user info
if err = json.NewDecoder(resp.Body).Decode(userData); err != nil { if err = json.NewDecoder(resp.Body).Decode(userData); err != nil {
Logger.Warn("failed decoding user info: ", err) Logger.Warn("failed decoding user info: ", err)
return errors.New("DecodeOauthUserInfoError"), nil return errors.New("DecodeOauthUserInfoError"), nil
@@ -299,7 +299,7 @@ func (os *OauthService) callbackBase(oauthConfig *oauth2.Config, provider *oidc.
return nil, client return nil, client
} }
// githubCallback github回调 // githubCallback handles the github callback
func (os *OauthService) githubCallback(oauthConfig *oauth2.Config, provider *oidc.Provider, code, verifier, nonce string) (error, *model.OauthUser) { func (os *OauthService) githubCallback(oauthConfig *oauth2.Config, provider *oidc.Provider, code, verifier, nonce string) (error, *model.OauthUser) {
var user = &model.GithubUser{} var user = &model.GithubUser{}
err, client := os.callbackBase(oauthConfig, provider, code, verifier, nonce, user) err, client := os.callbackBase(oauthConfig, provider, code, verifier, nonce, user)
@@ -313,7 +313,7 @@ func (os *OauthService) githubCallback(oauthConfig *oauth2.Config, provider *oid
return nil, user.ToOauthUser() return nil, user.ToOauthUser()
} }
// linuxdoCallback linux.do回调 // linuxdoCallback handles the linux.do callback
func (os *OauthService) linuxdoCallback(oauthConfig *oauth2.Config, provider *oidc.Provider, code, verifier, nonce string) (error, *model.OauthUser) { func (os *OauthService) linuxdoCallback(oauthConfig *oauth2.Config, provider *oidc.Provider, code, verifier, nonce string) (error, *model.OauthUser) {
var user = &model.LinuxdoUser{} var user = &model.LinuxdoUser{}
err, _ := os.callbackBase(oauthConfig, provider, code, verifier, nonce, user) err, _ := os.callbackBase(oauthConfig, provider, code, verifier, nonce, user)
@@ -323,7 +323,7 @@ func (os *OauthService) linuxdoCallback(oauthConfig *oauth2.Config, provider *oi
return nil, user.ToOauthUser() return nil, user.ToOauthUser()
} }
// oidcCallback oidc回调, 通过code获取用户信息 // oidcCallback handles the oidc callback, getting user info via the code
func (os *OauthService) oidcCallback(oauthConfig *oauth2.Config, provider *oidc.Provider, code, verifier, nonce string) (error, *model.OauthUser) { func (os *OauthService) oidcCallback(oauthConfig *oauth2.Config, provider *oidc.Provider, code, verifier, nonce string) (error, *model.OauthUser) {
var user = &model.OidcUser{} var user = &model.OidcUser{}
if err, _ := os.callbackBase(oauthConfig, provider, code, verifier, nonce, user); err != nil { if err, _ := os.callbackBase(oauthConfig, provider, code, verifier, nonce, user); err != nil {
@@ -385,14 +385,14 @@ func (os *OauthService) DeleteUserByUserId(userId uint) error {
return DB.Where("user_id = ?", userId).Delete(&model.UserThird{}).Error return DB.Where("user_id = ?", userId).Delete(&model.UserThird{}).Error
} }
// InfoById 根据id获取Oauth信息 // InfoById gets the oauth info by id
func (os *OauthService) InfoById(id uint) *model.Oauth { func (os *OauthService) InfoById(id uint) *model.Oauth {
oauthInfo := &model.Oauth{} oauthInfo := &model.Oauth{}
DB.Where("id = ?", id).First(oauthInfo) DB.Where("id = ?", id).First(oauthInfo)
return oauthInfo return oauthInfo
} }
// InfoByOp 根据op获取Oauth信息 // InfoByOp gets the oauth info by op
func (os *OauthService) InfoByOp(op string) *model.Oauth { func (os *OauthService) InfoByOp(op string) *model.Oauth {
oauthInfo := &model.Oauth{} oauthInfo := &model.Oauth{}
DB.Where("op = ?", op).First(oauthInfo) DB.Where("op = ?", op).First(oauthInfo)
@@ -428,7 +428,7 @@ func (os *OauthService) List(page, pageSize uint, where func(tx *gorm.DB)) (res
return return
} }
// GetTypeByOp 根据op获取OauthType // GetTypeByOp gets the oauth type by op
func (os *OauthService) GetTypeByOp(op string) (error, string) { func (os *OauthService) GetTypeByOp(op string) (error, string) {
oauthInfo := &model.Oauth{} oauthInfo := &model.Oauth{}
if DB.Where("op = ?", op).First(oauthInfo).Error != nil { if DB.Where("op = ?", op).First(oauthInfo).Error != nil {
@@ -437,7 +437,7 @@ func (os *OauthService) GetTypeByOp(op string) (error, string) {
return nil, oauthInfo.OauthType return nil, oauthInfo.OauthType
} }
// ValidateOauthProvider 验证Oauth提供者是否正确 // ValidateOauthProvider verifies whether the Oauth provider is correct
func (os *OauthService) ValidateOauthProvider(op string) error { func (os *OauthService) ValidateOauthProvider(op string) error {
if !os.IsOauthProviderExist(op) { if !os.IsOauthProviderExist(op) {
return fmt.Errorf("OAuth provider with op '%s' not found", op) return fmt.Errorf("OAuth provider with op '%s' not found", op)
@@ -445,17 +445,17 @@ func (os *OauthService) ValidateOauthProvider(op string) error {
return nil return nil
} }
// IsOauthProviderExist 验证Oauth提供者是否存在 // IsOauthProviderExist verifies whether the Oauth provider exists
func (os *OauthService) IsOauthProviderExist(op string) bool { func (os *OauthService) IsOauthProviderExist(op string) bool {
oauthInfo := &model.Oauth{} oauthInfo := &model.Oauth{}
// 使用 Gorm Take 方法查找符合条件的记录 // use Gorm's Take method to find records matching the conditions
if err := DB.Where("op = ?", op).Take(oauthInfo).Error; err != nil { if err := DB.Where("op = ?", op).Take(oauthInfo).Error; err != nil {
return false return false
} }
return true return true
} }
// Create 创建 // Create create
func (os *OauthService) Create(oauthInfo *model.Oauth) error { func (os *OauthService) Create(oauthInfo *model.Oauth) error {
err := oauthInfo.FormatOauthInfo() err := oauthInfo.FormatOauthInfo()
if err != nil { if err != nil {
@@ -468,7 +468,7 @@ func (os *OauthService) Delete(oauthInfo *model.Oauth) error {
return DB.Delete(oauthInfo).Error return DB.Delete(oauthInfo).Error
} }
// Update 更新 // Update update
func (os *OauthService) Update(oauthInfo *model.Oauth) error { func (os *OauthService) Update(oauthInfo *model.Oauth) error {
err := oauthInfo.FormatOauthInfo() err := oauthInfo.FormatOauthInfo()
if err != nil { if err != nil {
@@ -477,7 +477,7 @@ func (os *OauthService) Update(oauthInfo *model.Oauth) error {
return DB.Model(oauthInfo).Updates(oauthInfo).Error return DB.Model(oauthInfo).Updates(oauthInfo).Error
} }
// GetOauthProviders 获取所有的provider // GetOauthProviders get all of the provider
func (os *OauthService) GetOauthProviders() []string { func (os *OauthService) GetOauthProviders() []string {
var res []string var res []string
DB.Model(&model.Oauth{}).Pluck("op", &res) DB.Model(&model.Oauth{}).Pluck("op", &res)
+18 -18
View File
@@ -8,7 +8,7 @@ import (
type PeerService struct { type PeerService struct {
} }
// FindById 根据id查找 // FindById finds a peer by id
func (ps *PeerService) FindById(id string) *model.Peer { func (ps *PeerService) FindById(id string) *model.Peer {
p := &model.Peer{} p := &model.Peer{}
DB.Where("id = ?", id).First(p) DB.Where("id = ?", id).First(p)
@@ -25,22 +25,22 @@ func (ps *PeerService) InfoByRowId(id uint) *model.Peer {
return p return p
} }
// FindByUserIdAndUuid 根据用户id和uuid查找peer // FindByUserIdAndUuid finds a peer by user id and uuid
func (ps *PeerService) FindByUserIdAndUuid(uuid string, userId uint) *model.Peer { func (ps *PeerService) FindByUserIdAndUuid(uuid string, userId uint) *model.Peer {
p := &model.Peer{} p := &model.Peer{}
DB.Where("uuid = ? and user_id = ?", uuid, userId).First(p) DB.Where("uuid = ? and user_id = ?", uuid, userId).First(p)
return p return p
} }
// UuidBindUserId 绑定用户id // UuidBindUserId binds a user id
func (ps *PeerService) UuidBindUserId(deviceId string, uuid string, userId uint) { func (ps *PeerService) UuidBindUserId(deviceId string, uuid string, userId uint) {
peer := ps.FindByUuid(uuid) peer := ps.FindByUuid(uuid)
// 如果存在则更新 // if it exists, update it
if peer.RowId > 0 { if peer.RowId > 0 {
peer.UserId = userId peer.UserId = userId
ps.Update(peer) ps.Update(peer)
} else { } else {
// 不存在则创建 // create if it does not exist
/*if deviceId != "" { /*if deviceId != "" {
DB.Create(&model.Peer{ DB.Create(&model.Peer{
Id: deviceId, Id: deviceId,
@@ -51,7 +51,7 @@ func (ps *PeerService) UuidBindUserId(deviceId string, uuid string, userId uint)
} }
} }
// UuidUnbindUserId 解绑用户id, 用于用户注销 // UuidUnbindUserId unbinds the user id, used for user logout
func (ps *PeerService) UuidUnbindUserId(uuid string, userId uint) { func (ps *PeerService) UuidUnbindUserId(uuid string, userId uint) {
peer := ps.FindByUserIdAndUuid(uuid, userId) peer := ps.FindByUserIdAndUuid(uuid, userId)
if peer.RowId > 0 { if peer.RowId > 0 {
@@ -59,12 +59,12 @@ func (ps *PeerService) UuidUnbindUserId(uuid string, userId uint) {
} }
} }
// EraseUserId 清除用户id, 用于用户删除 // EraseUserId clears the user id, used for user deletion
func (ps *PeerService) EraseUserId(userId uint) error { func (ps *PeerService) EraseUserId(userId uint) error {
return DB.Model(&model.Peer{}).Where("user_id = ?", userId).Update("user_id", 0).Error return DB.Model(&model.Peer{}).Where("user_id = ?", userId).Update("user_id", 0).Error
} }
// ListByUserIds 根据用户id取列表 // ListByUserIds gets the list by user ids
func (ps *PeerService) ListByUserIds(userIds []uint, page, pageSize uint) (res *model.PeerList) { func (ps *PeerService) ListByUserIds(userIds []uint, page, pageSize uint) (res *model.PeerList) {
res = &model.PeerList{} res = &model.PeerList{}
res.Page = int64(page) res.Page = int64(page)
@@ -91,11 +91,11 @@ func (ps *PeerService) List(page, pageSize uint, where func(tx *gorm.DB)) (res *
return return
} }
// ListFilterByUserId 根据用户id过滤Peer列表 // ListFilterByUserId filters the peer list by user id
func (ps *PeerService) ListFilterByUserId(page, pageSize uint, where func(tx *gorm.DB), userId uint) (res *model.PeerList) { func (ps *PeerService) ListFilterByUserId(page, pageSize uint, where func(tx *gorm.DB), userId uint) (res *model.PeerList) {
userWhere := func(tx *gorm.DB) { userWhere := func(tx *gorm.DB) {
tx.Where("user_id = ?", userId) tx.Where("user_id = ?", userId)
// 如果还有额外的筛选条件,执行它 // if there are additional filter conditions, apply them
if where != nil { if where != nil {
where(tx) where(tx)
} }
@@ -103,30 +103,30 @@ func (ps *PeerService) ListFilterByUserId(page, pageSize uint, where func(tx *go
return ps.List(page, pageSize, userWhere) return ps.List(page, pageSize, userWhere)
} }
// Create 创建 // Create create
func (ps *PeerService) Create(u *model.Peer) error { func (ps *PeerService) Create(u *model.Peer) error {
res := DB.Create(u).Error res := DB.Create(u).Error
return res return res
} }
// Delete 删除, 同时也应该删除token // Delete deletes a peer; the associated token should also be deleted
func (ps *PeerService) Delete(u *model.Peer) error { func (ps *PeerService) Delete(u *model.Peer) error {
uuid := u.Uuid uuid := u.Uuid
err := DB.Delete(u).Error err := DB.Delete(u).Error
if err != nil { if err != nil {
return err return err
} }
// 删除token // delete the token
return AllService.UserService.FlushTokenByUuid(uuid) return AllService.UserService.FlushTokenByUuid(uuid)
} }
// GetUuidListByIDs 根据ids获取uuid列表 // GetUuidListByIDs gets the uuid list by ids
func (ps *PeerService) GetUuidListByIDs(ids []uint) ([]string, error) { func (ps *PeerService) GetUuidListByIDs(ids []uint) ([]string, error) {
var uuids []string var uuids []string
err := DB.Model(&model.Peer{}). err := DB.Model(&model.Peer{}).
Where("row_id in (?)", ids). Where("row_id in (?)", ids).
Pluck("uuid", &uuids).Error Pluck("uuid", &uuids).Error
//过滤uuids中的空字符串 // filter out empty strings in uuids
var newUuids []string var newUuids []string
for _, uuid := range uuids { for _, uuid := range uuids {
if uuid != "" { if uuid != "" {
@@ -136,18 +136,18 @@ func (ps *PeerService) GetUuidListByIDs(ids []uint) ([]string, error) {
return newUuids, err return newUuids, err
} }
// BatchDelete 批量删除, 同时也应该删除token // BatchDelete batch deletes peers; the associated tokens should also be deleted
func (ps *PeerService) BatchDelete(ids []uint) error { func (ps *PeerService) BatchDelete(ids []uint) error {
uuids, err := ps.GetUuidListByIDs(ids) uuids, err := ps.GetUuidListByIDs(ids)
err = DB.Where("row_id in (?)", ids).Delete(&model.Peer{}).Error err = DB.Where("row_id in (?)", ids).Delete(&model.Peer{}).Error
if err != nil { if err != nil {
return err return err
} }
// 删除token // delete the token
return AllService.UserService.FlushTokenByUuids(uuids) return AllService.UserService.FlushTokenByUuids(uuids)
} }
// Update 更新 // Update update
func (ps *PeerService) Update(u *model.Peer) error { func (ps *PeerService) Update(u *model.Peer) error {
return DB.Model(u).Updates(u).Error return DB.Model(u).Updates(u).Error
} }
+5 -5
View File
@@ -39,15 +39,15 @@ func (is *ServerCmdService) Create(u *model.ServerCmd) error {
return res return res
} }
// SendCmd 发送命令 // SendCmd send command
func (is *ServerCmdService) SendCmd(port int, cmd string, arg string) (string, error) { func (is *ServerCmdService) SendCmd(port int, cmd string, arg string) (string, error) {
//组装命令 //assemble command
cmd = cmd + " " + arg cmd = cmd + " " + arg
res, err := is.SendSocketCmd("v6", port, cmd) res, err := is.SendSocketCmd("v6", port, cmd)
if err == nil { if err == nil {
return res, nil return res, nil
} }
//v6连接失败,尝试v4 //v6connection failed, trying v4
res, err = is.SendSocketCmd("v4", port, cmd) res, err = is.SendSocketCmd("v4", port, cmd)
if err == nil { if err == nil {
return res, nil return res, nil
@@ -69,14 +69,14 @@ func (is *ServerCmdService) SendSocketCmd(ty string, port int, cmd string) (stri
return "", err return "", err
} }
defer conn.Close() defer conn.Close()
//发送命令 //send command
_, err = conn.Write([]byte(cmd)) _, err = conn.Write([]byte(cmd))
if err != nil { if err != nil {
Logger.Debugf("%s send cmd failed: %v", ty, err) Logger.Debugf("%s send cmd failed: %v", ty, err)
return "", err return "", err
} }
time.Sleep(100 * time.Millisecond) time.Sleep(100 * time.Millisecond)
//读取返回 //read response
buf := make([]byte, 1024) buf := make([]byte, 1024)
n, err := conn.Read(buf) n, err := conn.Read(buf)
if err != nil && err.Error() != "EOF" { if err != nil && err.Error() != "EOF" {

Some files were not shown because too many files have changed in this diff Show More