From 64f774377ad82e6573f935ca8d041fd2089f5b17 Mon Sep 17 00:00:00 2001 From: Nick007 Date: Wed, 10 Dec 2025 09:28:23 +0800 Subject: [PATCH] Clarify env vars and add shm size recommendation --- README.md | 9 +++++---- README_en.md | 9 +++++---- docker-compose.yml | 5 +++-- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7d6aa6c..a94ed9d 100644 --- a/README.md +++ b/README.md @@ -87,14 +87,15 @@ docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri nickr devices: - /dev/dri:/dev/dri # optional, for hardware acceleration environment: - - PUID=1000 # user ID - - PGID=100 # group ID - - TZ=Asia/Shanghai # timezone - - LC_ALL=zh_CN.UTF-8 # locale + - PUID=1000 # user ID, set according to your system + - PGID=100 # group ID, set according to your system + - TZ=Asia/Shanghai # timezone, set according to your timezone + - LC_ALL=zh_CN.UTF-8 # locale, set according to your needs - AUTO_START_WECHAT=true # default is true - AUTO_START_QQ=false # default is false # - CUSTOM_USER= # recommended to set a custom user name # - PASSWORD= # recommended to set a password for selkies web ui + shm_size: "1gb" # recommended, will improve performance ``` 3. **启动服务** ```bash diff --git a/README_en.md b/README_en.md index 971f98b..039e6f4 100644 --- a/README_en.md +++ b/README_en.md @@ -84,14 +84,15 @@ docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri nickr devices: - /dev/dri:/dev/dri # optional, for hardware acceleration environment: - - PUID=1000 # user ID - - PGID=100 # group ID - - TZ=Asia/Shanghai # timezone - - LC_ALL=zh_CN.UTF-8 # locale + - PUID=1000 # user ID, set according to your system + - PGID=100 # group ID, set according to your system + - TZ=Asia/Shanghai # timezone, set according to your timezone + - LC_ALL=zh_CN.UTF-8 # locale, set according to your needs - AUTO_START_WECHAT=true # default is true - AUTO_START_QQ=false # default is false # - CUSTOM_USER= # recommended to set a custom user name # - PASSWORD= # recommended to set a password for selkies web ui + shm_size: "1gb" # recommended, will improve performance ``` 3. **Start the service** ```bash diff --git a/docker-compose.yml b/docker-compose.yml index df83939..1a57eb3 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -14,7 +14,8 @@ services: - "3001:3001" # https port restart: unless-stopped environment: - - PUID=1000 - - PGID=100 + - PUID=1000 # set user id according to your system + - PGID=100 # set group id according to your system # - CUSTOM_USER= # recommended to set a custom user name # - PASSWORD= # recommended to set a password for selkies web ui + shm_size: "1gb" # recommended, will improve performance \ No newline at end of file