更新文档

This commit is contained in:
admin8800
2026-05-10 16:59:36 +08:00
parent 5f1f9375d7
commit 80d8339861
3 changed files with 22 additions and 26 deletions
+19 -13
View File
@@ -49,9 +49,6 @@ bash <(curl -Ls https://raw.githubusercontent.com/admin8800/s-ui/main/install.sh
**步骤 1** 如果要安装指定旧版本,请在安装命令末尾追加带 `v` 的版本标签。例如版本 `v1.0.0` **步骤 1** 如果要安装指定旧版本,请在安装命令末尾追加带 `v` 的版本标签。例如版本 `v1.0.0`
```sh
VERSION=v1.0.0 && bash <(curl -Ls https://raw.githubusercontent.com/admin8800/s-ui/$VERSION/install.sh) $VERSION
```
## 手动安装 ## 手动安装
@@ -104,28 +101,39 @@ curl -fsSL https://get.docker.com | sh
> Docker compose 方式 > Docker compose 方式
```shell ```shell
mkdir s-ui && cd s-ui services:
wget -q https://raw.githubusercontent.com/admin8800/s-ui/main/docker-compose.yml s-ui:
docker compose up -d image: ghcr.io/admin8800/s-ui
container_name: s-ui
hostname: "s-ui"
network_mode: host
volumes:
- "./db:/app/db"
- "./cert:/app/cert"
tty: true
restart: unless-stopped
entrypoint: "./entrypoint.sh"
``` ```
`docker compose up -d`
> 直接使用 docker > 直接使用 docker
```shell ```shell
mkdir s-ui && cd s-ui mkdir s-ui && cd s-ui
docker run -itd \ docker run -itd \
-p 2095:2095 -p 2096:2096 -p 443:443 -p 80:80 \ --network host \
-v $PWD/db/:/app/db/ \ -v $PWD/db/:/app/db/ \
-v $PWD/cert/:/root/cert/ \ -v $PWD/cert/:/root/cert/ \
--name s-ui --restart=unless-stopped \ --name s-ui \
ghcr.io/admin8800/s-ui:latest --restart=unless-stopped \
ghcr.io/admin8800/s-ui
``` ```
> 自行构建镜像 > 自行构建镜像
```shell ```shell
git clone https://github.com/admin8800/s-ui git clone https://github.com/admin8800/s-ui
git submodule update --init --recursive
docker build -t s-ui . docker build -t s-ui .
``` ```
@@ -145,13 +153,11 @@ docker build -t s-ui .
```shell ```shell
# 克隆仓库 # 克隆仓库
git clone https://github.com/admin8800/s-ui git clone https://github.com/admin8800/s-ui
# 克隆子模块
git submodule update --init --recursive
``` ```
### - 前端 ### - 前端
前端代码请查看 [s-ui-frontend](https://github.com/admin8800/s-ui-frontend)。 前端代码请查看 [frontend](frontend)
### - 后端 ### - 后端
> 请先至少构建一次前端。 > 请先至少构建一次前端。
+2 -6
View File
@@ -1,16 +1,12 @@
services: services:
s-ui: s-ui:
image: ghcr.io/admin8800/s-ui:latest image: ghcr.io/admin8800/s-ui
container_name: s-ui container_name: s-ui
hostname: "s-ui" hostname: "s-ui"
network_mode: host
volumes: volumes:
- "./db:/app/db" - "./db:/app/db"
- "./cert:/app/cert" - "./cert:/app/cert"
tty: true tty: true
restart: unless-stopped restart: unless-stopped
ports:
- "2095:2095"
- "2096:2096"
networks:
- s-ui
entrypoint: "./entrypoint.sh" entrypoint: "./entrypoint.sh"
-6
View File
@@ -5,8 +5,6 @@
> **Disclaimer:** This project is only for personal learning and communication, please do not use it for illegal purposes, please do not use it in a production environment > **Disclaimer:** This project is only for personal learning and communication, please do not use it for illegal purposes, please do not use it in a production environment
## [Screenshots](./screenshots.md)
## Project setup ## Project setup
``` ```
@@ -70,7 +68,3 @@ pnpm lint
# bun # bun
pnpm run lint pnpm run lint
``` ```
### Customize configuration
See [Configuration Reference](https://vitejs.dev/config/).