Skip to content

Commit 9ed5cb9

Browse files
docs: Update Docker configuration and entrypoint for improved database handling
1 parent 75d8636 commit 9ed5cb9

5 files changed

Lines changed: 47 additions & 53 deletions

File tree

‎docker-compose.sqlite.yml‎

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,8 @@ services:
2323
postgres:
2424
condition: service_healthy
2525
environment:
26-
NODEGET_PORT: "2211"
27-
NODEGET_LOG_FILTER: info
2826
NODEGET_DATABASE_URL: postgres://nodeget:nodeget@postgres:5432/nodeget
2927
ports:
3028
- "2211:2211"
3129
volumes:
32-
- ./data/config:/etc/nodeget
30+
- ./data/nodeget:/nodeget

‎docker/docker-compose.sqlite.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: nodeget-sqlite
2+
3+
services:
4+
nodeget:
5+
image: genshinmc/nodeget:latest
6+
restart: unless-stopped
7+
environment:
8+
NODEGET_DATABASE_URL: sqlite:///nodeget/nodeget.db?mode=rwc
9+
ports:
10+
- "2211:2211"
11+
volumes:
12+
- ./data:/nodeget

‎docker/entrypoint.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ if [ ! -f "${CONFIG}" ]; then
77
db_url="${NODEGET_DATABASE_URL:-sqlite:///nodeget/nodeget.db?mode=rwc}"
88
cat > "${CONFIG}" <<EOF
99
ws_listener = "0.0.0.0:2211"
10-
server_uuid = "c56aa660-190f-498c-92ba-86fccd566673"
10+
server_uuid = "auto_gen"
1111
1212
[logging]
1313
log_filter = "info"

‎docs/guide/install/docker.md‎

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,56 +15,55 @@ docker run -d \
1515
genshinmc/nodeget:latest
1616
```
1717

18-
该命令默认使用
18+
该命令默认使用 `sqlite:///nodeget/nodeget.db?mode=rwc` 为数据库
1919

20-
## PostgreSQL + NodeGet
20+
自动生成的配置文件如下:
2121

22-
先进入一个用于存放 NodeGet Server 配置和数据的目录,然后执行:
22+
```toml
23+
ws_listener = "0.0.0.0:2211"
24+
server_uuid = "auto_gen"
2325

24-
```shell
25-
curl -fsSL https://raw.githubusercontent.com/NodeSeekDev/NodeGet/main/docker-compose.postgres.yml -o docker-compose.yml
26-
docker compose up -d
26+
[logging]
27+
log_filter = "info"
28+
29+
[database]
30+
database_url = "sqlite:///nodeget/nodeget.db?mode=rwc"
2731
```
2832

29-
## SQLite + NodeGet
33+
同时也可传入 `NODEGET_DATABASE_URL` 环境变量覆盖默认数据库配置:
3034

31-
同样先进入一个用于存放 NodeGet Server 配置和数据的目录,然后执行:
35+
```bash
36+
docker run -d \
37+
--name nodeget \
38+
-p 2211:2211 \
39+
-v /your/host/path:/nodeget \
40+
-e NODEGET_DATABASE_URL="postgresql://user:password@host:port/dbname" \
41+
genshinmc/nodeget:latest
42+
```
3243

33-
```shell
34-
curl -fsSL https://raw.githubusercontent.com/NodeSeekDev/NodeGet/main/docker-compose.sqlite.yml -o docker-compose.yml
44+
## Docker Compose
45+
46+
### SQLite
47+
48+
```bash
49+
curl -o docker-compose.yml https://raw.githubusercontent.com/NodeSeekDev/NodeGet/refs/heads/main/docker/docker-compose.sqlite.yml
3550
docker compose up -d
3651
```
3752

38-
数据会保存在当前目录的 `./data` 下:
53+
### PostgreSQL
3954

40-
```text
41-
data/
42-
config/
43-
config.toml
44-
sqlite/
45-
nodeget.db
46-
postgres/
55+
```bash
56+
curl -o docker-compose.yml https://raw.githubusercontent.com/NodeSeekDev/NodeGet/refs/heads/main/docker/docker-compose.postgres.yml
57+
docker compose up -d
4758
```
4859

49-
`./data/config/config.toml` 是 NodeGet 配置文件。SQLite 部署使用 `./data/sqlite`,PostgreSQL 部署使用 `./data/postgres`
50-
。删除容器不会删除这些目录;如需清空数据,请停止服务后手动删除对应目录。
60+
> 生产环境请务必修改 `POSTGRES_PASSWORD` 与 `NODEGET_DATABASE_URL` 中的密码。
5161
52-
默认暴露 `2211` 端口。
53-
54-
服务**首次启动**时会生成 Super Token。可在 `docker-compose.yml` 所在目录执行下面的命令查看:
62+
## 获取 Super Token
5563

5664
```shell
57-
docker compose logs nodeget | grep -E 'Super Token'
65+
docker logs nodeget | grep -E 'Super Token'
5866
```
5967

6068
获取 Super Token 后,可前往 [NodeGet Dashboard 的 Server 管理页面](https://dash.nodeget.com/#/dashboard/node-manage?tab=servers) 添加
61-
Server。
62-
63-
如需修改镜像 tag、端口映射、数据库账号等 Docker 部署参数,请编辑下载下来的 `docker-compose.yml`。
64-
65-
`./data/config/config.toml` 生成后,NodeGet 的运行配置以这个文件为准。修改监听地址、日志级别、数据库地址等 NodeGet 配置时,请编辑
66-
`./data/config/config.toml`;只改 `docker-compose.yml` 不会覆盖已有配置文件。
67-
68-
## 安装 Agent
69-
70-
待支持
69+
Server。

0 commit comments

Comments
 (0)