29 Commits

Author SHA1 Message Date
Nick007
0ab51c11b0 Merge pull request #114 from f841705799/master
Update QQ download URLs in Dockerfile for newer version
2026-05-06 11:05:39 +08:00
weiwudi
179f50f45f Update QQ download URLs in Dockerfile for newer version 2026-04-27 17:02:26 +08:00
github-actions[bot]
35791ff5d3 chore: update upstream package state 2026-04-07 12:45:40 +00:00
Nick007
a5f832dd09 feat: automate upstream wechat version detection 2026-04-07 17:35:47 +08:00
Nick007
77edc4b33e fix: add curl retry for WeChat/QQ download to handle transient network failures 2026-03-23 21:06:24 +08:00
Nick007
680ee6dd4a feat: support minimal image variant with WeChat only (#92)
Add INSTALL_QQ and INSTALL_PCMANFM build args to conditionally skip QQ
and file manager installation. CI builds both :latest (full) and :minimal
(WeChat only) tags for each release.
2026-03-23 19:54:35 +08:00
Nick007
63b3f34527 feat: extract docker-compose config to .env and update commands to docker compose 2026-03-23 19:39:28 +08:00
Nick007
c2b6106fff docs: add WeChat/QQ version update guide and file manager feature docs (#100) 2026-03-23 18:56:51 +08:00
Nick007
e42a8e861d feat: add PCManFM file manager with right-click menu entry (#86) 2026-03-23 18:56:44 +08:00
Nick007
d87cb16fb9 feat: open WeChat/QQ as normal windows instead of maximized (#69) 2026-03-23 18:55:55 +08:00
Nick007
7c13e87a69 fix: clean up stale dbus pid file on startup (#81) 2026-03-23 18:55:36 +08:00
Nick007
ecc68281c3 fix: use start scripts instead of restart in menu to support multi-instance (#102) 2026-03-23 14:00:27 +08:00
Nick007
6d039cf06e docs: add AGENTS.md project knowledge base 2026-03-23 13:52:38 +08:00
Nick007
e18821f917 feat: auto-refresh menu on app install/uninstall and add third-party app docs
- Extract menu generation logic into standalone refresh-menu.sh script
- Use inotifywait to watch ~/Desktop/ for .desktop file changes and
  auto-refresh the openbox right-click menu on app install/uninstall
- Add inotify-tools to Dockerfile dependencies
- Add 'Installing Third-Party Applications' section to both READMEs
  documenting how to install apps like Telegram via sidebar panel
2026-02-28 10:06:08 +08:00
Nick007
c7fd1ec6d2 feat: auto-integrate desktop shortcuts into openbox right-click menu
- Scan .desktop files from ~/Desktop/ on startup and dynamically add
  them to the openbox menu (/config/.config/openbox/menu.xml)
- Resolve icon names to actual paths under /config/proot-apps/ with
  fallback to system icons, preferring 256x256 resolution
- Escape XML entities in name, exec command, and icon path
- Only reconfigure openbox when menu content actually changes
- Update README.md and README_en.md with new feature description
2026-02-28 10:00:07 +08:00
Nick007
10b676bdad Update QQ download URLs 2025-12-10 09:34:23 +08:00
Nick007
64f774377a Clarify env vars and add shm size recommendation 2025-12-10 09:28:23 +08:00
Nick007
3444018947 Merge pull request #52 from wray-lee/patch-1
Update QQ download URLs for newer versions
2025-11-09 21:00:22 +08:00
Wray
13695c11d4 Update QQ download URLs for newer versions 2025-11-07 17:01:09 +08:00
Nick007
6cc4267762 ci: update issue templates 2025-10-29 12:59:16 +08:00
Nick007
2dca2294eb Update issue templates 2025-10-27 13:40:33 +08:00
Nick007
de4205ec35 docs: update README and minor fix 2025-10-26 20:30:16 +08:00
Nick007
b312ab863c docs: update README 2025-10-25 12:09:45 +08:00
Nick007
25c0819dbd feat: introduce qq 2025-10-24 21:04:25 +08:00
Nick007
fe33010597 upd: Update LICENSE file 2025-10-22 13:57:34 +08:00
Nick007
dff3b147fa docs: update LICENSE 2025-10-22 13:51:27 +08:00
Nick007
de1bc4140e add: Implement release publishing feature. 2025-10-22 11:32:54 +08:00
Nick007
43c039087c docs: update README 2025-10-22 11:32:26 +08:00
Nick007
4101ec8eb5 docs: Update the README document to add support for Docker Hub images. 2025-10-22 10:06:03 +08:00
26 changed files with 1477 additions and 743 deletions

14
.env.example Normal file
View File

@@ -0,0 +1,14 @@
# Ports
HTTP_PORT=3000
HTTPS_PORT=3001
# User/Group
PUID=1000
PGID=100
# Selkies Web UI
# CUSTOM_USER=
# PASSWORD=
# Shared Memory
SHM_SIZE=1gb

138
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,138 @@
name: 🐛 Bug Report
description: 创建一个错误报告来帮助我们改进项目
title: "[Bug]: "
labels: ["bug", "triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
感谢您花时间填写错误报告!请提供详细信息以帮助我们诊断问题。
> **注意**: 请确保标题和描述足够详细,以便我们能够理解和重现问题。
**标题要求**: 请在页面顶部的标题框中填写简洁明了的问题描述最少10个字符例如"微信无法启动显示黑屏"
- type: textarea
id: bug-description
attributes:
label: 错误描述
description: 清晰简洁地描述遇到的错误最少30个字符
placeholder: 详细描述您遇到的问题...
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: 重现步骤
description: 详细说明重现该错误的步骤最少50个字符
placeholder: |
1. 执行 '...'
2. 点击 '...'
3. 滚动到 '...'
4. 看到错误
value: |
1.
2.
3.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: 预期行为
description: 清楚简洁地描述您期望发生的情况
placeholder: 描述应该发生什么...
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: 截图
description: 如果适用,请添加截图来帮助解释问题
placeholder: 拖放图片或粘贴图片链接
- type: dropdown
id: os
attributes:
label: 操作系统
description: 您使用的操作系统
options:
- Ubuntu 20.04
- Ubuntu 22.04
- Ubuntu 24.04
- Debian 11
- Debian 12
- CentOS 7
- CentOS 8
- Rocky Linux 8
- Rocky Linux 9
- Windows 10
- Windows 11
- macOS
- 其他(请在附加信息中说明)
validations:
required: true
- type: dropdown
id: browser
attributes:
label: 浏览器
description: 您使用的浏览器
options:
- Chrome
- Firefox
- Safari
- Edge
- 其他(请在附加信息中说明)
validations:
required: true
- type: input
id: docker-version
attributes:
label: Docker版本
description: 运行 `docker --version` 的输出
placeholder: 例如Docker version 24.0.6
validations:
required: true
- type: input
id: compose-version
attributes:
label: Docker Compose版本
description: 运行 `docker-compose --version` 的输出
placeholder: 例如docker-compose version 2.21.0
validations:
required: true
- type: textarea
id: logs
attributes:
label: 相关日志
description: 请提供相关的容器日志或错误信息
placeholder: 粘贴 `docker logs <container-name>` 的输出
render: shell
- type: textarea
id: additional-context
attributes:
label: 附加信息
description: 添加关于该问题的任何其他相关信息
placeholder: 任何可能有助于解决问题的额外信息...
- type: checkboxes
id: terms
attributes:
label: 检查清单
description: 请确认以下事项
options:
- label: 我已经搜索了现有的issues确认这不是重复问题
required: true
- label: 我已经阅读了README和相关文档
required: true
- label: 我提供的信息足够详细,可以帮助重现问题
required: true

14
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 📖 项目文档
url: https://github.com/nickrunning/wechat-selkies/blob/master/README.md
about: 请先查看项目文档和常见问题解答
- name: 💬 讨论区 - 问答交流
url: https://github.com/nickrunning/wechat-selkies/discussions
about: 一般性问题、经验分享、想法讨论请使用讨论区
- name: 📋 讨论区使用指南
url: https://github.com/nickrunning/wechat-selkies/blob/master/.github/discussions-guide.md
about: 了解讨论区表单使用方法和最佳实践
- name: 🔍 搜索现有内容
url: https://github.com/nickrunning/wechat-selkies/search?type=discussions
about: 搜索现有的讨论和问题,避免重复提交

View File

@@ -0,0 +1,112 @@
name: 🚀 Feature Request
description: 为这个项目建议一个新想法或功能
title: "[Feature]: "
labels: ["enhancement", "triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
感谢您提出功能建议!请提供详细信息以帮助我们理解您的需求。
> **注意**: 请确保标题和描述足够详细,以便我们能够理解您的功能需求。
**标题要求**: 请在页面顶部的标题框中填写简洁明了的功能描述最少10个字符例如"添加微信多开功能支持"
- type: textarea
id: problem-description
attributes:
label: 问题描述
description: 清楚简洁地描述您遇到的问题或需求最少30个字符
placeholder: 例如:我希望能够同时运行多个微信实例...
validations:
required: true
- type: textarea
id: solution-description
attributes:
label: 解决方案描述
description: 清楚简洁地描述您希望实现的功能最少50个字符
placeholder: 详细描述您期望的功能如何工作...
validations:
required: true
- type: textarea
id: alternatives-considered
attributes:
label: 考虑的替代方案
description: 清楚简洁地描述您考虑过的任何替代解决方案或功能
placeholder: 描述您考虑过的其他方法...
validations:
required: true
- type: dropdown
id: feature-type
attributes:
label: 功能类型
description: 这个功能请求属于哪个类别?
options:
- 用户界面改进
- 性能优化
- 新功能
- 配置选项
- 文档改进
- 安全性增强
- 兼容性改进
- 其他
validations:
required: true
- type: dropdown
id: priority
attributes:
label: 优先级
description: 您认为这个功能的优先级如何?
options:
- 低 - 很有用,但不紧急
- 中 - 对工作流程有帮助
- 高 - 重要的功能缺失
- 紧急 - 阻塞性问题
validations:
required: true
- type: textarea
id: use-cases
attributes:
label: 使用场景
description: 描述这个功能的具体使用场景和用户故事
placeholder: |
作为用户,我希望能够...
这样我就可以...
例如:...
validations:
required: true
- type: textarea
id: mockups
attributes:
label: 模拟图或截图
description: 如果适用,请添加模拟图、线框图或参考截图
placeholder: 拖放图片或粘贴图片链接
- type: textarea
id: additional-context
attributes:
label: 附加信息
description: 添加关于功能请求的任何其他相关信息、链接或参考资料
placeholder: 任何可能有助于实现这个功能的额外信息...
- type: checkboxes
id: terms
attributes:
label: 检查清单
description: 请确认以下事项
options:
- label: 我已经搜索了现有的issues确认这不是重复的功能请求
required: true
- label: 我已经阅读了README和相关文档
required: true
- label: 这个功能请求与项目的目标和范围相符
required: true
- label: 我提供的描述足够详细,可以帮助理解功能需求
required: true

82
.github/ISSUE_TEMPLATE/general.yml vendored Normal file
View File

@@ -0,0 +1,82 @@
name: 📝 General Issue
description: 其他类型的问题或讨论
title: "[General]: "
labels: ["question", "triage"]
assignees: []
body:
- type: markdown
attributes:
value: |
如果您的问题不符合Bug报告或功能请求的类别请使用此模板。
> **提示**: 对于一般性讨论,考虑使用[讨论区](https://github.com/nickrunning/wechat-selkies/discussions)。
**标题要求**: 请在页面顶部的标题框中填写简洁明了的问题描述最少10个字符例如"关于项目配置的问题"
- type: dropdown
id: issue-type
attributes:
label: 问题类型
description: 请选择最符合您问题的类型
options:
- 使用问题/疑问
- 配置相关
- 安装/部署问题
- 文档问题
- 兼容性问题
- 建议/反馈
- 其他
validations:
required: true
- type: textarea
id: description
attributes:
label: 详细描述
description: 详细描述您的问题或情况最少30个字符
placeholder: 请详细描述您遇到的情况、需要的帮助或想要讨论的内容...
validations:
required: true
- type: textarea
id: context
attributes:
label: 相关背景
description: 提供相关的背景信息或上下文
placeholder: |
- 您在尝试做什么?
- 您的使用场景是什么?
- 是否有相关的配置或设置?
validations:
required: true
- type: textarea
id: environment
attributes:
label: 环境信息
description: 如果相关,请提供环境信息
placeholder: |
- 操作系统:
- Docker版本
- 浏览器:
- 其他相关信息:
- type: textarea
id: additional-info
attributes:
label: 附加信息
description: 任何其他可能相关的信息、链接或截图
placeholder: 包括日志、配置文件、截图等...
- type: checkboxes
id: checklist
attributes:
label: 检查清单
description: 请确认以下事项
options:
- label: 我已经搜索了现有的issues和讨论
required: true
- label: 我已经阅读了相关文档
required: true
- label: 我提供的信息足够详细
required: true

125
.github/scripts/detect-upstream.sh vendored Executable file
View File

@@ -0,0 +1,125 @@
#!/usr/bin/env bash
set -euo pipefail
STATE_FILE="${STATE_FILE:-versions/upstream.env}"
TMP_DIR="$(mktemp -d)"
CHANGE_DETECTED="false"
ENV_WECHAT_AMD64_URL="${WECHAT_AMD64_URL-__UNSET__}"
ENV_WECHAT_ARM64_URL="${WECHAT_ARM64_URL-__UNSET__}"
cleanup() {
rm -rf "$TMP_DIR"
}
trap cleanup EXIT
if [[ -f "$STATE_FILE" ]]; then
# shellcheck disable=SC1090
source "$STATE_FILE"
fi
if [[ "$ENV_WECHAT_AMD64_URL" != "__UNSET__" ]]; then
WECHAT_AMD64_URL="$ENV_WECHAT_AMD64_URL"
fi
if [[ "$ENV_WECHAT_ARM64_URL" != "__UNSET__" ]]; then
WECHAT_ARM64_URL="$ENV_WECHAT_ARM64_URL"
fi
WECHAT_AMD64_URL="${WECHAT_AMD64_URL:-https://dldir1v6.qq.com/weixin/Universal/Linux/WeChatLinux_x86_64.deb}"
WECHAT_ARM64_URL="${WECHAT_ARM64_URL:-https://dldir1v6.qq.com/weixin/Universal/Linux/WeChatLinux_arm64.deb}"
download_package() {
local source_path="$1"
local destination="$2"
case "$source_path" in
http://*|https://*)
curl --fail --silent --show-error --location \
--retry 3 --retry-delay 5 --retry-all-errors \
-o "$destination" "$source_path"
;;
*)
cp "$source_path" "$destination"
;;
esac
}
read_metadata() {
local package_name="$1"
local arch="$2"
local source_path="$3"
local package_path="$TMP_DIR/${package_name}-${arch}.deb"
local version_var="${package_name}_${arch}_VERSION"
local sha_var="${package_name}_${arch}_SHA256"
local current_version="${!version_var:-}"
local current_sha="${!sha_var:-}"
local detected_version
local detected_sha
echo "Checking ${package_name} ${arch} from ${source_path}"
download_package "$source_path" "$package_path"
detected_version="$(dpkg-deb -f "$package_path" Version)"
detected_sha="$(sha256sum "$package_path" | awk '{print $1}')"
printf -v "$version_var" '%s' "$detected_version"
printf -v "$sha_var" '%s' "$detected_sha"
if [[ "$current_version" != "$detected_version" || "$current_sha" != "$detected_sha" ]]; then
CHANGE_DETECTED="true"
fi
}
read_metadata "WECHAT" "AMD64" "$WECHAT_AMD64_URL"
read_metadata "WECHAT" "ARM64" "$WECHAT_ARM64_URL"
if [[ "$CHANGE_DETECTED" == "true" || ! -f "$STATE_FILE" ]]; then
WECHAT_LAST_CHECKED_AT="$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
fi
NEW_STATE_FILE="$TMP_DIR/upstream.env"
cat > "$NEW_STATE_FILE" <<EOF
# Upstream package state tracked by automation.
WECHAT_AMD64_URL="$WECHAT_AMD64_URL"
WECHAT_ARM64_URL="$WECHAT_ARM64_URL"
WECHAT_AMD64_VERSION="$WECHAT_AMD64_VERSION"
WECHAT_ARM64_VERSION="$WECHAT_ARM64_VERSION"
WECHAT_AMD64_SHA256="$WECHAT_AMD64_SHA256"
WECHAT_ARM64_SHA256="$WECHAT_ARM64_SHA256"
WECHAT_LAST_CHECKED_AT="$WECHAT_LAST_CHECKED_AT"
EOF
mkdir -p "$(dirname "$STATE_FILE")"
if [[ ! -f "$STATE_FILE" ]] || ! cmp -s "$NEW_STATE_FILE" "$STATE_FILE"; then
cp "$NEW_STATE_FILE" "$STATE_FILE"
fi
echo "Change detected: $CHANGE_DETECTED"
echo "WECHAT_AMD64_VERSION=$WECHAT_AMD64_VERSION"
echo "WECHAT_ARM64_VERSION=$WECHAT_ARM64_VERSION"
if [[ -n "${GITHUB_OUTPUT:-}" ]]; then
{
echo "changed=$CHANGE_DETECTED"
echo "wechat_amd64_version=$WECHAT_AMD64_VERSION"
echo "wechat_arm64_version=$WECHAT_ARM64_VERSION"
echo "state_file=$STATE_FILE"
} >> "$GITHUB_OUTPUT"
fi
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
{
echo "## Upstream Detection"
echo ""
echo "- Changed: \`$CHANGE_DETECTED\`"
echo "- WeChat amd64: \`$WECHAT_AMD64_VERSION\`"
echo "- WeChat arm64: \`$WECHAT_ARM64_VERSION\`"
echo "- State file: \`$STATE_FILE\`"
} >> "$GITHUB_STEP_SUMMARY"
fi

98
.github/workflows/cleanup-issues.yml vendored Normal file
View File

@@ -0,0 +1,98 @@
name: Close Invalid Issues
on:
schedule:
# 每天运行一次清理无效issues
- cron: '0 2 * * *'
workflow_dispatch: # 允许手动触发
jobs:
close-invalid-issues:
runs-on: ubuntu-latest
steps:
- name: Close stale issues with needs-more-info label
uses: actions/github-script@v6
with:
script: |
const { data: issues } = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
state: 'open',
labels: 'needs-more-info',
sort: 'updated',
direction: 'asc'
});
const now = new Date();
const staleThreshold = 7 * 24 * 60 * 60 * 1000; // 7天
for (const issue of issues) {
const updatedAt = new Date(issue.updated_at);
const daysSinceUpdate = Math.floor((now - updatedAt) / (24 * 60 * 60 * 1000));
if (now - updatedAt > staleThreshold) {
console.log(`Closing stale issue #${issue.number} (${daysSinceUpdate} days old)`);
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `🤖 **自动关闭通知**\n\n这个issue已经标记为需要更多信息超过7天且没有收到回复。为了保持issue列表的整洁现在自动关闭此issue。\n\n如果您仍然遇到问题\n1. 提供我们之前请求的信息\n2. 重新开启此issue或创建新的issue\n\n我们随时欢迎您提供更多详细信息`
});
await github.rest.issues.update({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
state: 'closed',
state_reason: 'not_planned'
});
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
labels: ['auto-closed']
});
}
}
- name: Add warning to old issues without labels
uses: actions/github-script@v6
with:
script: |
const { data: issues } = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
state: 'open',
sort: 'created',
direction: 'asc'
});
const now = new Date();
const oldThreshold = 3 * 24 * 60 * 60 * 1000; // 3天
for (const issue of issues) {
const createdAt = new Date(issue.created_at);
const isOld = now - createdAt > oldThreshold;
const hasTriageLabel = issue.labels.some(label => label.name === 'triage');
const hasNeedsInfoLabel = issue.labels.some(label => label.name === 'needs-more-info');
if (isOld && hasTriageLabel && !hasNeedsInfoLabel) {
console.log(`Adding reminder to issue #${issue.number}`);
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `⏰ **提醒**\n\n这个issue已经开放3天了但还没有被标记或分类。\n\n**维护者请注意:**\n- 请审查此issue并添加适当的标签\n- 如果需要更多信息,请添加 \`needs-more-info\` 标签\n- 如果是有效的bug或功能请求请移除 \`triage\` 标签并添加适当的优先级标签\n\n**提交者请注意:**\n- 如果您有更多信息可以补充,请随时添加\n- 确保您已经提供了足够的详细信息来重现问题或理解功能需求`
});
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
labels: ['stale']
});
}
}

32
.github/workflows/detect-upstream.yml vendored Normal file
View File

@@ -0,0 +1,32 @@
name: Detect Upstream Package Updates
on:
workflow_dispatch:
schedule:
- cron: '23 */6 * * *'
permissions:
contents: write
jobs:
detect-wechat-updates:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Detect upstream package changes
id: detect
run: ./.github/scripts/detect-upstream.sh
- name: Commit updated version state
if: steps.detect.outputs.changed == 'true'
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add versions/upstream.env
git commit -m "chore: update upstream package state"
git push

View File

@@ -3,6 +3,10 @@ name: Build and Publish Docker Image
on: on:
workflow_dispatch: workflow_dispatch:
push: push:
branches:
- master
paths:
- 'versions/upstream.env'
tags: tags:
- 'v*' - 'v*'
@@ -16,7 +20,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
environment: DOCKERHUB environment: DOCKERHUB
permissions: permissions:
contents: read contents: write
packages: write packages: write
id-token: write id-token: write
attestations: write attestations: write
@@ -70,6 +74,37 @@ jobs:
cache-from: type=gha cache-from: type=gha
cache-to: type=gha,mode=max cache-to: type=gha,mode=max
- name: Extract metadata for minimal image
id: meta-minimal
uses: docker/metadata-action@v5
with:
images: |
ghcr.io/${{ github.repository }}
${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }},enable=${{ vars.ENABLE_DOCKERHUB == 'true' }}
flavor: |
latest=false
suffix=-minimal
tags: |
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=raw,value=minimal,enable=${{ github.ref == format('refs/heads/{0}', 'master') || startsWith(github.ref, 'refs/tags/') }}
- name: Build and push minimal Docker image
id: build-minimal
uses: docker/build-push-action@v5
with:
context: .
platforms: linux/amd64,linux/arm64
push: true
tags: ${{ steps.meta-minimal.outputs.tags }}
labels: ${{ steps.meta-minimal.outputs.labels }}
build-args: |
INSTALL_QQ=false
INSTALL_PCMANFM=false
cache-from: type=gha
cache-to: type=gha,mode=max
- name: Generate artifact attestation - name: Generate artifact attestation
if: github.event_name != 'workflow_dispatch' if: github.event_name != 'workflow_dispatch'
uses: actions/attest-build-provenance@v1 uses: actions/attest-build-provenance@v1
@@ -84,11 +119,16 @@ jobs:
echo "### GitHub Container Registry" >> $GITHUB_STEP_SUMMARY echo "### GitHub Container Registry" >> $GITHUB_STEP_SUMMARY
echo "**Registry:** ${{ env.REGISTRY }}" >> $GITHUB_STEP_SUMMARY echo "**Registry:** ${{ env.REGISTRY }}" >> $GITHUB_STEP_SUMMARY
echo "**Repository:** ${{ env.IMAGE_NAME }}" >> $GITHUB_STEP_SUMMARY echo "**Repository:** ${{ env.IMAGE_NAME }}" >> $GITHUB_STEP_SUMMARY
echo "**Digest:** \`${{ steps.build-image.outputs.digest }}\`" >> $GITHUB_STEP_SUMMARY echo "**Full image digest:** \`${{ steps.build-image.outputs.digest }}\`" >> $GITHUB_STEP_SUMMARY
echo "**Tags:**" >> $GITHUB_STEP_SUMMARY echo "**Minimal image digest:** \`${{ steps.build-minimal.outputs.digest }}\`" >> $GITHUB_STEP_SUMMARY
echo "**Tags (full):**" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
echo "${{ steps.meta.outputs.tags }}" >> $GITHUB_STEP_SUMMARY echo "${{ steps.meta.outputs.tags }}" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
echo "**Tags (minimal):**" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
echo "${{ steps.meta-minimal.outputs.tags }}" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
if [ "${{ vars.ENABLE_DOCKERHUB }}" == "true" ]; then if [ "${{ vars.ENABLE_DOCKERHUB }}" == "true" ]; then
echo "" >> $GITHUB_STEP_SUMMARY echo "" >> $GITHUB_STEP_SUMMARY
@@ -104,4 +144,44 @@ jobs:
echo "" >> $GITHUB_STEP_SUMMARY echo "" >> $GITHUB_STEP_SUMMARY
echo "### Docker Hub" >> $GITHUB_STEP_SUMMARY echo "### Docker Hub" >> $GITHUB_STEP_SUMMARY
echo "⚠️ **Skipped** - Docker Hub push disabled (set ENABLE_DOCKERHUB=true to enable)" >> $GITHUB_STEP_SUMMARY echo "⚠️ **Skipped** - Docker Hub push disabled (set ENABLE_DOCKERHUB=true to enable)" >> $GITHUB_STEP_SUMMARY
fi fi
- name: Create GitHub Release
if: startsWith(github.ref, 'refs/tags/v')
uses: softprops/action-gh-release@v2
with:
generate_release_notes: true
make_latest: true
body: |
## 🐳 Docker Images
### Full (WeChat + QQ + File Manager)
**GitHub Container Registry:**
```bash
docker pull ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.meta.outputs.version }}
docker pull ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
```
**Docker Hub** (if enabled):
```bash
docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:${{ steps.meta.outputs.version }}
docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ github.event.repository.name }}:latest
```
### Minimal (WeChat only)
```bash
docker pull ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:minimal
```
## 🚀 Quick Start
**Full:**
```bash
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
```
**Minimal:**
```bash
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:minimal
```
Then visit: https://localhost:3001

189
.github/workflows/issue-validation.yml vendored Normal file
View File

@@ -0,0 +1,189 @@
name: Issue Validation
on:
issues:
types: [opened, edited]
jobs:
validate-issue:
runs-on: ubuntu-latest
steps:
- name: Check Issue Title Length
uses: actions/github-script@v6
with:
script: |
const issue = context.payload.issue;
const title = issue.title.trim();
const minTitleLength = 10;
const maxTitleLength = 120;
console.log(`Issue title: "${title}"`);
console.log(`Title length: ${title.length}`);
// 去除模板前缀进行长度检查
const cleanTitle = title.replace(/^\[(Bug|Feature|General)\]:\s*/i, '').trim();
if (cleanTitle.length < minTitleLength) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `⚠️ **标题过短**\n\n您的issue标题内容太短了当前有效内容${cleanTitle.length}个字符,最少需要${minTitleLength}个字符)。请提供一个更具描述性的标题,以便我们更好地理解问题。\n\n**示例:**\n- ✅ "[Bug]: 微信无法启动显示黑屏"\n- ❌ "[Bug]: 有问题"\n\n请编辑issue标题提供更多详细信息。`
});
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
labels: ['needs-more-info']
});
} else if (title.length > maxTitleLength) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `⚠️ **标题过长**\n\n您的issue标题太长了当前${title.length}个字符,建议不超过${maxTitleLength}个字符)。请简化标题,将详细信息移至描述部分。`
});
}
- name: Check Issue Body Length
uses: actions/github-script@v6
with:
script: |
const issue = context.payload.issue;
const body = issue.body ? issue.body.trim() : '';
const minBodyLength = 50;
console.log(`Issue body length: ${body.length}`);
if (body.length < minBodyLength) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `⚠️ **描述过短**\n\n您的issue描述太简短了当前${body.length}个字符,最少需要${minBodyLength}个字符)。为了帮助我们更好地理解和解决问题,请提供以下信息:\n\n- 详细的问题描述\n- 重现步骤\n- 预期行为\n- 实际行为\n- 环境信息操作系统、浏览器、Docker版本等\n- 相关日志或错误信息\n\n请编辑issue描述添加更多详细信息。`
});
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
labels: ['needs-more-info']
});
}
- name: Check for Template Usage
uses: actions/github-script@v6
with:
script: |
const issue = context.payload.issue;
const body = issue.body || '';
// 检查是否包含模板中的占位符文本(表明用户没有填写完整)
const templatePlaceholders = [
'例如:',
'placeholder',
'...',
'请描述',
'请填写',
'请提供'
];
const hasPlaceholders = templatePlaceholders.some(placeholder =>
body.toLowerCase().includes(placeholder)
);
if (hasPlaceholders) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `⚠️ **模板未完整填写**\n\n看起来您可能没有完全填写issue模板。请确保\n\n- 删除所有占位符文本和示例\n- 填写所有必需的字段\n- 提供真实的、具体的信息\n\n这将帮助我们更快地理解和解决您的问题。`
});
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
labels: ['needs-more-info']
});
}
- name: Auto-assign Labels Based on Content
uses: actions/github-script@v6
with:
script: |
const issue = context.payload.issue;
const title = issue.title.toLowerCase();
const body = (issue.body || '').toLowerCase();
const content = title + ' ' + body;
const labelRules = [
{
keywords: ['docker', 'dockerfile', 'compose', '容器'],
label: 'docker'
},
{
keywords: ['微信', 'wechat', '登录', 'login'],
label: 'wechat'
},
{
keywords: ['网络', 'network', 'proxy', '代理', 'ssl', 'https'],
label: 'network'
},
{
keywords: ['性能', 'performance', 'slow', '慢', 'memory', '内存'],
label: 'performance'
},
{
keywords: ['音频', 'audio', '声音', 'sound'],
label: 'audio'
},
{
keywords: ['视频', 'video', '显示', 'display'],
label: 'video'
},
{
keywords: ['文档', 'documentation', 'readme', 'doc'],
label: 'documentation'
}
];
const labelsToAdd = [];
for (const rule of labelRules) {
if (rule.keywords.some(keyword => content.includes(keyword))) {
labelsToAdd.push(rule.label);
}
}
if (labelsToAdd.length > 0) {
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
labels: labelsToAdd
});
}
- name: Welcome First Time Contributors
uses: actions/github-script@v6
with:
script: |
const issue = context.payload.issue;
// 检查是否是首次提交issue的用户
const { data: issues } = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
creator: issue.user.login,
state: 'all'
});
if (issues.length === 1) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue.number,
body: `🎉 **欢迎首次贡献!**\n\n感谢您提交第一个issue我们很高兴您选择使用并改进这个项目。\n\n**接下来会发生什么:**\n- 维护者将审查您的issue\n- 如果需要更多信息,我们会在评论中询问\n- 我们会尽快回复并提供帮助\n\n**有用的资源:**\n- [项目文档](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/master/README.md)\n- [讨论区](https://github.com/${context.repo.owner}/${context.repo.repo}/discussions)\n\n再次感谢您的贡献 🙏`
});
}

3
.gitignore vendored
View File

@@ -1 +1,2 @@
/config/ /config/
.env

94
AGENTS.md Normal file
View File

@@ -0,0 +1,94 @@
# PROJECT KNOWLEDGE BASE
**Generated:** 2026-03-23
**Commit:** e18821f
**Branch:** master
## OVERVIEW
Docker 容器化微信/QQ Linux 客户端,基于 LinuxServer Selkies WebRTC 基础镜像,通过浏览器远程访问桌面应用。支持 AMD64/ARM64 双架构。
## STRUCTURE
```
wechat-selkies/
├── Dockerfile # 单阶段构建,基于 selkies:ubuntunoble
├── docker-compose.yml # 单服务编排
├── root/ # COPY /root / → 容器内脚本和配置
│ ├── defaults/
│ │ ├── autostart # 容器启动入口,仅一行: /scripts/start.sh
│ │ └── menu.xml # Openbox 右键菜单模板(静态基础项)
│ └── scripts/
│ ├── start.sh # 主启动脚本openbox配置 → 菜单刷新 → 监听桌面 → 启动应用
│ ├── refresh-menu.sh # 合并 menu.xml + ~/Desktop/*.desktop → 生成最终菜单
│ ├── window_switcher.py # ⚠️ 已废弃,仅保留
│ ├── wechat/ # wechat-start.sh / wechat-restart.sh / wechat-unminimize.sh
│ └── qq/ # qq-restart.sh
├── .github/workflows/ # CI: 多架构构建 + Issue 自动化
├── docs/images/ # README 截图
└── config/ # ⚠️ gitignored 运行时数据挂载点
```
## WHERE TO LOOK
| 任务 | 位置 | 备注 |
|------|------|------|
| 添加新应用 | `Dockerfile` (安装) + `root/defaults/menu.xml` (菜单) | 参考 QQ 安装段落的 case 模式 |
| 修改启动行为 | `root/scripts/start.sh` | 入口脚本,由 `root/defaults/autostart` 触发 |
| 修改右键菜单 | `root/defaults/menu.xml` + `root/scripts/refresh-menu.sh` | menu.xml 是模板refresh-menu.sh 动态合并 ~/Desktop/*.desktop |
| 修改菜单动态生成逻辑 | `root/scripts/refresh-menu.sh` | 解析 .desktop 文件的 Name/Exec/Icon 字段,处理图标搜索 |
| 添加新应用启动/重启脚本 | `root/scripts/<app>/` | 遵循 wechat/ 目录模式: start.sh + restart.sh |
| 修改环境变量 | `Dockerfile` (ENV) + `docker-compose.yml` (environment) | 两处需同步 |
| CI/CD | `.github/workflows/docker.yml` | tag v* 触发,多架构 buildx可选推送 Docker Hub |
| Issue 自动化 | `.github/workflows/issue-validation.yml` + `cleanup-issues.yml` | 标题/描述校验 + 7天自动关闭 |
## CONVENTIONS
- **语言**: 脚本用 Bash (#!/bin/bash),窗口切换器用 Python3 + Xlib + tkinter
- **容器路径约定**: `COPY /root /``root/` 目录内容映射到容器根 `/`,因此 `root/scripts/start.sh` → 容器内 `/scripts/start.sh`
- **自启动机制**: Selkies 基础镜像读取 `/defaults/autostart` 文件执行启动脚本
- **菜单刷新**: inotifywait 监听 `~/Desktop/` 变更自动刷新 Openbox 菜单
- **进程管理**: 应用通过 `nohup ... &` 后台启动restart 脚本先 `pkill -9` 再启动
- **restart 脚本模式**: `pkill -9 -f /usr/bin/<app>``nohup /usr/bin/<app> >/dev/null 2>&1 &`QQ 需额外 `--no-sandbox`
- **菜单模板 vs 运行时**: `root/defaults/menu.xml` 是源码模板,`/config/.config/openbox/menu.xml` 是运行时生成的,不要混淆
- **refresh-menu.sh**: 仅在内容变更时才写入 + reconfigure避免无意义刷新
- **图标搜索优先级**: proot-apps icons (256→512→128→64→48→scalable) → system icons → fallback xterm icon
- **多架构**: Dockerfile 使用 `$TARGETPLATFORM` 条件分支安装不同架构 deb 包
## ANTI-PATTERNS (THIS PROJECT)
- **不要直接修改 `config/` 目录下的文件** — 这是运行时挂载数据gitignored
- **不要修改 `config/.config/openbox/` 下文件作为"源码"** — 这些由 `root/defaults/` 模板生成
- **不要在 `root/` 下放非容器必需文件** — `COPY /root /` 会将所有内容复制到容器根目录
- **不要在 menu.xml 中添加 .desktop 动态条目** — 由 refresh-menu.sh 自动处理
- **不要在 start.sh 中用 `exec` 替代 `nohup ... &`** — 需要多进程并行运行
- **升级后功能缺失** → 清空 `./config/.config/openbox/` 目录(已知 gotcha见 README
- **window_switcher.py 已废弃** — `start.sh` 中已注释掉,但文件保留,不要删除
## COMMANDS
```bash
# 本地构建并启动
docker-compose up -d --build
# 仅启动(使用已有镜像)
docker-compose up -d
# 查看日志
docker-compose logs -f wechat-selkies
# 进入容器调试
docker exec -it wechat-selkies bash
# 清理升级问题
rm -rf ./config/.config/openbox
```
## NOTES
- 端口 3000=HTTP, 3001=HTTPS推荐 HTTPS
- `shm_size: "1gb"` 影响 WebRTC 性能,建议保留
- `/dev/dri` 映射为可选 GPU 加速
- `AUTO_START_WECHAT` / `AUTO_START_QQ` 控制容器启动时是否自动拉起应用
- 第三方应用通过 proot-apps 安装,快捷方式自动出现在右键菜单
- Docker Hub 推送需在 GitHub 仓库 Environment 中配置 `ENABLE_DOCKERHUB=true`

View File

@@ -13,9 +13,10 @@ LABEL org.opencontainers.image.licenses="GPL-3.0-only"
# Build arguments for multi-arch support # Build arguments for multi-arch support
ARG TARGETPLATFORM ARG TARGETPLATFORM
ARG BUILDPLATFORM ARG BUILDPLATFORM
ARG INSTALL_QQ=true
ARG INSTALL_PCMANFM=true
RUN echo "🏗️ Building WeChat-Selkies on $BUILDPLATFORM, targeting $TARGETPLATFORM" RUN echo "🏗️ Building WeChat-Selkies on $BUILDPLATFORM, targeting $TARGETPLATFORM"
# set environment variables
RUN apt-get update && \ RUN apt-get update && \
apt-get install -y fonts-noto-cjk libxcb-icccm4 libxcb-image0 libxcb-keysyms1 \ apt-get install -y fonts-noto-cjk libxcb-icccm4 libxcb-image0 libxcb-keysyms1 \
libxcb-render-util0 libxcb-xkb1 libxkbcommon-x11-0 \ libxcb-render-util0 libxcb-xkb1 libxkbcommon-x11-0 \
@@ -27,7 +28,12 @@ RUN apt-get update && \
libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 \ libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 \
libxcomposite1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 \ libxcomposite1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 \
libxss1 libxtst6 libatomic1 libxcomposite1 libxrender1 libxrandr2 libxkbcommon-x11-0 \ libxss1 libxtst6 libatomic1 libxcomposite1 libxrender1 libxrandr2 libxkbcommon-x11-0 \
libfontconfig1 libdbus-1-3 libnss3 libx11-xcb1 python3-tk libfontconfig1 libdbus-1-3 libnss3 libx11-xcb1 stalonetray inotify-tools
ARG INSTALL_PCMANFM
RUN if [ "$INSTALL_PCMANFM" = "true" ]; then \
apt-get install -y --no-install-recommends pcmanfm; \
fi
RUN pip install --no-cache-dir python-xlib RUN pip install --no-cache-dir python-xlib
@@ -45,12 +51,36 @@ RUN case "$TARGETPLATFORM" in \
exit 1 ;; \ exit 1 ;; \
esac && \ esac && \
echo "📦 Downloading WeChat for $WECHAT_ARCH architecture..." && \ echo "📦 Downloading WeChat for $WECHAT_ARCH architecture..." && \
curl -fsSL -o wechat.deb "$WECHAT_URL" && \ curl -fsSL --retry 3 --retry-delay 10 --retry-all-errors -o wechat.deb "$WECHAT_URL" && \
echo "🔧 Installing WeChat..." && \ echo "🔧 Installing WeChat..." && \
(dpkg -i wechat.deb || (apt-get update && apt-get install -f -y && dpkg -i wechat.deb)) && \ (dpkg -i wechat.deb || (apt-get update && apt-get install -f -y && dpkg -i wechat.deb)) && \
rm -f wechat.deb && \ rm -f wechat.deb && \
echo "✅ WeChat installation completed for $WECHAT_ARCH" echo "✅ WeChat installation completed for $WECHAT_ARCH"
# Install QQ based on target architecture (optional)
ARG INSTALL_QQ
RUN if [ "$INSTALL_QQ" = "true" ]; then \
case "$TARGETPLATFORM" in \
"linux/amd64") \
QQ_URL="https://dldir1v6.qq.com/qqfile/qq/QQNT/Linux/QQ_3.2.27_260401_amd64_01.deb"; \
QQ_ARCH="x86_64" ;; \
"linux/arm64") \
QQ_URL="https://dldir1v6.qq.com/qqfile/qq/QQNT/Linux/QQ_3.2.27_260401_arm64_01.deb"; \
QQ_ARCH="arm64" ;; \
*) \
echo "❌ Unsupported platform: $TARGETPLATFORM" >&2; \
exit 1 ;; \
esac && \
echo "📦 Downloading QQ for $QQ_ARCH architecture..." && \
curl -fsSL --retry 3 --retry-delay 10 --retry-all-errors -o qq.deb "$QQ_URL" && \
echo "🔧 Installing QQ..." && \
(dpkg -i qq.deb || (apt-get update && apt-get install -f -y && dpkg -i qq.deb)) && \
rm -f qq.deb && \
echo "✅ QQ installation completed for $QQ_ARCH"; \
else \
echo "⏭️ Skipping QQ installation (INSTALL_QQ=$INSTALL_QQ)"; \
fi
# Clean up # Clean up
RUN apt-get purge -y --autoremove RUN apt-get purge -y --autoremove
RUN apt-get autoclean && \ RUN apt-get autoclean && \
@@ -61,13 +91,18 @@ RUN apt-get autoclean && \
/var/tmp/* \ /var/tmp/* \
/tmp/* /tmp/*
# configure openbox dock mode for stalonetray
RUN sed -i '/<dock>/,/<\/dock>/s/<noStrut>no<\/noStrut>/<noStrut>yes<\/noStrut>/' /etc/xdg/openbox/rc.xml
# set app name # set app name
ENV TITLE="WeChat-Selkies" ENV TITLE="WeChat-Selkies"
ENV TZ="Asia/Shanghai" ENV TZ="Asia/Shanghai"
ENV LC_ALL="zh_CN.UTF-8" ENV LC_ALL="zh_CN.UTF-8"
ENV AUTO_START_WECHAT="true"
ENV AUTO_START_QQ="false"
# update favicon # update favicon
COPY /root/wechat.png /usr/share/selkies/www/icon.png RUN cp /usr/share/icons/hicolor/128x128/apps/wechat.png /usr/share/selkies/www/icon.png
# add local files # add local files
COPY /root / COPY /root /

695
LICENSE
View File

@@ -1,674 +1,21 @@
GNU GENERAL PUBLIC LICENSE MIT License
Version 3, 29 June 2007
Copyright (c) 2025 Nick007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies Permission is hereby granted, free of charge, to any person obtaining a copy
of this license document, but changing it is not allowed. of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
Preamble to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
The GNU General Public License is a free, copyleft license for furnished to do so, subject to the following conditions:
software and other kinds of works.
The above copyright notice and this permission notice shall be included in all
The licenses for most software and other practical works are designed copies or substantial portions of the Software.
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
share and change all versions of a program--to make sure it remains free IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
software for all its users. We, the Free Software Foundation, use the FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
GNU General Public License for most of our software; it applies also to AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
any other work released this way by its authors. You can apply it to LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
your programs, too. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

174
README.md
View File

@@ -1,17 +1,29 @@
# WeChat Selkies # WeChat Selkies
[![GitHub Stars](https://img.shields.io/github/stars/nickrunning/wechat-selkies?style=flat-square&logo=github&color=yellow)](https://github.com/nickrunning/wechat-selkies/stargazers)
[![GitHub Forks](https://img.shields.io/github/forks/nickrunning/wechat-selkies?style=flat-square&logo=github&color=blue)](https://github.com/nickrunning/wechat-selkies/network/members)
[![GitHub Issues](https://img.shields.io/github/issues/nickrunning/wechat-selkies?style=flat-square&logo=github&color=red)](https://github.com/nickrunning/wechat-selkies/issues)
[![GitHub License](https://img.shields.io/github/license/nickrunning/wechat-selkies?style=flat-square&color=green)](https://github.com/nickrunning/wechat-selkies/blob/master/LICENSE)
[![Docker Pulls](https://img.shields.io/docker/pulls/nickrunning/wechat-selkies?style=flat-square&logo=docker&color=blue)](https://hub.docker.com/r/nickrunning/wechat-selkies)
[![Docker Image Size](https://img.shields.io/docker/image-size/nickrunning/wechat-selkies?style=flat-square&logo=docker&color=orange)](https://hub.docker.com/r/nickrunning/wechat-selkies)
[![GitHub Release](https://img.shields.io/github/v/release/nickrunning/wechat-selkies?style=flat-square&logo=github&include_prereleases)](https://github.com/nickrunning/wechat-selkies/releases)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nickrunning/wechat-selkies/docker.yml?style=flat-square&logo=github-actions&label=build)](https://github.com/nickrunning/wechat-selkies/actions)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/nickrunning/wechat-selkies?style=flat-square&logo=github&color=purple)](https://github.com/nickrunning/wechat-selkies/commits)
中文 | [English](README_en.md) 中文 | [English](README_en.md)
基于 Docker 的微信 Linux 客户端,使用 Selkies WebRTC 技术提供浏览器访问支持。 基于 Docker 的微信/QQ Linux 客户端,使用 Selkies WebRTC 技术提供浏览器访问支持。
## 项目简介 ## 项目简介
本项目将官方微信 Linux 客户端封装在 Docker 容器中,通过 Selkies 技术实现在浏览器中直接使用微信,无需在本地安装微信客户端。适用于服务器部署、远程办公等场景。 本项目将官方微信/QQ Linux 客户端封装在 Docker 容器中,通过 Selkies 技术实现在浏览器中直接使用微信/QQ,无需在本地安装微信/QQ 客户端。适用于服务器部署、远程办公等场景。
## 升级注意事项 ## 升级注意事项
> 如果升级后部分功能缺失请先清空本地挂载目录下的openbox目录(如`./config/.config/openbox`)。 > 如果升级后部分功能缺失请先清空本地挂载目录下的openbox目录(如`./config/.config/openbox`)。
> 仓库内置了上游微信版本自动检测机制GitHub Actions 会定时检查官方 `.deb` 包版本,检测到变化后自动更新 `versions/upstream.env` 并触发镜像构建。
## 功能特性 ## 功能特性
- 🌐 **浏览器访问**:通过 Web 浏览器直接使用微信,无需本地安装 - 🌐 **浏览器访问**:通过 Web 浏览器直接使用微信,无需本地安装
@@ -23,6 +35,13 @@
- 🖥️ **AMD64和ARM64架构支持**兼容主流CPU架构 - 🖥️ **AMD64和ARM64架构支持**兼容主流CPU架构
- 🔧 **硬件加速**:可选的 GPU 硬件加速支持 - 🔧 **硬件加速**:可选的 GPU 硬件加速支持
- 🪟 **窗口切换器**:左上角增加切换悬浮窗,方便切换到后台窗口,为后续添加其它功能做基础 - 🪟 **窗口切换器**:左上角增加切换悬浮窗,方便切换到后台窗口,为后续添加其它功能做基础
- 🤖 **自动启动**可配置自动启动微信和QQ客户端可选
- 📋 **桌面快捷方式集成**:自动扫描 `~/Desktop/` 下的 `.desktop` 文件并添加到右键菜单,方便启动第三方应用(如通过 proot-apps 安装的应用)
- 📂 **文件管理器**:内置 PCManFM 轻量文件管理器,右键菜单即可启动,方便管理容器内文件
## 截图展示
![微信截图](./docs/images/wechat-selkies-1.jpg)
![QQ截图](./docs/images/wechat-selkies-2.jpg)
## 快速开始 ## 快速开始
@@ -35,15 +54,81 @@
### 快速部署 ### 快速部署
1. **直接使用已构建的镜像进行快速部署** 1. **直接使用已构建的镜像进行快速部署**
GitHub Container Registry镜像
```bash ```bash
docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selkies:latest docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ghcr.io/nickrunning/wechat-selkies:latest
``` ```
Docker Hub镜像
```bash
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri nickrunning/wechat-selkies:latest
```
> **精简版镜像**:如果只需要微信(不含 QQ 和文件管理器),可使用 `minimal` 标签,镜像体积更小:
> ```bash
> docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ghcr.io/nickrunning/wechat-selkies:minimal
> ```
> 精简版也支持版本号标签,如 `:1.2.3-minimal`、`:1.2-minimal`,方便锁定特定版本。
2. **访问微信** 2. **访问微信**
在浏览器中访问:`https://localhost:3001``https://<服务器IP>:3001` 在浏览器中访问:`https://localhost:3001``https://<服务器IP>:3001`
> **注意:** 映射3000端口用于HTTP访问3001端口用于HTTPS访问建议使用HTTPS。
### 自定义部署步骤(源码部署 ### Docker Compose 部署
1. **创建项目目录并进入**
```bash
mkdir wechat-selkies
cd wechat-selkies
```
2. **创建 docker-compose.yml 文件**
```yaml
services:
wechat-selkies:
image: nickrunning/wechat-selkies:latest # or ghcr.io/nickrunning/wechat-selkies:latest
container_name: wechat-selkies
ports:
- "${HTTP_PORT:-3000}:3000"
- "${HTTPS_PORT:-3001}:3001"
restart: unless-stopped
volumes:
- ./config:/config
devices:
- /dev/dri:/dev/dri
environment:
- PUID=${PUID:-1000}
- PGID=${PGID:-100}
- TZ=Asia/Shanghai
- LC_ALL=zh_CN.UTF-8
- AUTO_START_WECHAT=true
- AUTO_START_QQ=false
- CUSTOM_USER=${CUSTOM_USER:-}
- PASSWORD=${PASSWORD:-}
shm_size: "${SHM_SIZE:-1gb}"
```
3. **创建 `.env` 文件(可选)**
复制 `.env.example` 并按需修改,未设置的变量将使用默认值:
```bash
cp .env.example .env
```
`.env` 文件示例:
```env
HTTP_PORT=3000
HTTPS_PORT=3001
PUID=1000
PGID=100
# CUSTOM_USER=
# PASSWORD=
SHM_SIZE=1gb
```
4. **启动服务**
```bash
docker compose up -d
```
### 源码部署
1. **克隆项目** 1. **克隆项目**
```bash ```bash
@@ -53,13 +138,18 @@ docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selki
2. **启动服务** 2. **启动服务**
```bash ```bash
docker-compose up -d docker compose up -d
``` ```
3. **访问微信** 3. **访问微信**
在浏览器中访问:`https://localhost:3001` 或 `https://<服务器IP>:3001` 在浏览器中访问:`https://localhost:3001` 或 `https://<服务器IP>:3001`
> **构建精简版**:源码部署时可通过 build-arg 构建仅含微信的精简镜像:
> ```bash
> docker build --build-arg INSTALL_QQ=false --build-arg INSTALL_PCMANFM=false -t wechat-selkies:minimal .
> ```
### 配置说明 ### 配置说明
更多自定义配置请参考 [Selkies Base Images from LinuxServer](https://github.com/linuxserver/docker-baseimage-selkies)。 更多自定义配置请参考 [Selkies Base Images from LinuxServer](https://github.com/linuxserver/docker-baseimage-selkies)。
@@ -68,15 +158,15 @@ docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selki
本项目支持同时推送到 GitHub Container Registry 和 Docker Hub。如需启用 Docker Hub 推送功能请在仓库下添加Environment Secrets和Environment Variables: 本项目支持同时推送到 GitHub Container Registry 和 Docker Hub。如需启用 Docker Hub 推送功能请在仓库下添加Environment Secrets和Environment Variables:
**必需的Environment Secrets:** **Environment Secrets:**
* DOCKERHUB_USERNAME: 你的 Docker Hub 用户名 * DOCKERHUB_USERNAME: 你的 Docker Hub 用户名
* DOCKERHUB_TOKEN: 你的 Docker Hub Access Token * DOCKERHUB_TOKEN: 你的 Docker Hub Access Token
**必需的Environment Variables:** **Environment Variables:**
* ENABLE_DOCKERHUB: 设置为 `true` 来启用 Docker Hub 推送 * ENABLE_DOCKERHUB: 设置为 `true` 来启用 Docker Hub 推送
#### 环境变量配置 #### 环境变量配置
在 `docker-compose.yml` 中可以配置以下环境变量: 在 `docker-compose.yml` 中可以配置以下环境变量,支持通过 `.env` 文件覆盖带有 `${VAR:-default}` 的配置项
| 变量名 | 默认值 | 说明 | | 变量名 | 默认值 | 说明 |
|--------|--------|------| |--------|--------|------|
@@ -87,6 +177,8 @@ docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selki
| `LC_ALL` | `zh_CN.UTF-8` | 语言环境 | | `LC_ALL` | `zh_CN.UTF-8` | 语言环境 |
| `CUSTOM_USER` | - | 自定义用户名(推荐设置) | | `CUSTOM_USER` | - | 自定义用户名(推荐设置) |
| `PASSWORD` | - | Web UI 访问密码(推荐设置) | | `PASSWORD` | - | Web UI 访问密码(推荐设置) |
| `AUTO_START_WECHAT` | `true` | 是否自动启动微信客户端 |
| `AUTO_START_QQ` | `false` | 是否自动启动 QQ 客户端 |
#### 端口配置 #### 端口配置
@@ -98,6 +190,19 @@ docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selki
> **注意:** 如果升级后右键菜单缺少 `WeChat` 相关选项请先清空本地挂载目录下的openbox目录(如`./config/.config/openbox`)。 > **注意:** 如果升级后右键菜单缺少 `WeChat` 相关选项请先清空本地挂载目录下的openbox目录(如`./config/.config/openbox`)。
## 安装第三方应用(如 Telegram
本项目支持通过 [proot-apps](https://github.com/linuxserver/proot-apps) 安装第三方 Linux 应用。以 Telegram 为例:
1. 在浏览器中打开容器桌面
2. 点击左侧 **侧边栏** → **应用程序**Applications
3. 在应用列表中找到 **Telegram**
4. 点击 **安装**Install按钮等待安装完成
安装完成后,应用快捷方式会自动出现在 `~/Desktop/` 目录下,**右键菜单会自动刷新**,无需重启容器即可从菜单中启动该应用。
> **提示:** 如需卸载应用,同样通过侧边栏 → 应用程序,选中对应应用后点击 **卸载**Uninstall即可右键菜单会自动更新。
## 高级配置 ## 高级配置
### 硬件加速 ### 硬件加速
@@ -114,6 +219,7 @@ devices:
``` ```
wechat-selkies/ wechat-selkies/
├── docker-compose.yml # Docker Compose 配置文件 ├── docker-compose.yml # Docker Compose 配置文件
├── .env.example # 环境变量示例文件
├── Dockerfile # Docker 镜像构建文件 ├── Dockerfile # Docker 镜像构建文件
├── LICENSE # License ├── LICENSE # License
├── README.md # 项目说明文档 ├── README.md # 项目说明文档
@@ -126,6 +232,33 @@ wechat-selkies/
## 故障排除 ## 故障排除
### 更新微信/QQ版本
当微信或QQ提示"版本过期"时,只需重新拉取最新镜像并重建容器即可,聊天记录和配置不受影响:
```bash
# 使用预构建镜像
docker compose pull && docker compose up -d
# 使用源码构建
git pull && docker compose up -d --build
```
> **注意:** 微信和QQ的安装包 URL 指向官方最新版本,重新构建镜像时会自动下载最新版。
对于仓库维护者,当前自动化流程如下:
1. `Detect Upstream Package Updates` 每 6 小时检查一次微信官方安装包版本,也支持手动触发
2. 如果检测到版本号或安装包哈希变化,工作流会更新 `versions/upstream.env`
3. 该文件变更提交到 `master` 后,会自动触发 `Build and Publish Docker Image`
版本状态文件位于 `versions/upstream.env`,当前记录了:
- 微信 amd64/arm64 下载地址
- 微信 amd64/arm64 解析出的版本号
- 微信 amd64/arm64 安装包 SHA256
- 最近一次发生变更的检测时间
### 常见问题 ### 常见问题
1. **无法访问 Web UI** 1. **无法访问 Web UI**
@@ -136,7 +269,7 @@ wechat-selkies/
查看容器运行日志: 查看容器运行日志:
```bash ```bash
docker-compose logs -f wechat-selkies docker compose logs -f wechat-selkies
``` ```
## 技术架构 ## 技术架构
@@ -158,23 +291,14 @@ docker-compose logs -f wechat-selkies
## 许可证 ## 许可证
本项目采用 **GNU General Public License v3.0** 开源协议。详见 [LICENSE](LICENSE) 文件。 本项目采用 **MIT License** 开源协议。详见 [LICENSE](LICENSE) 文件。
**重要说明**:本项目依赖 [LinuxServer.io baseimage-selkies](https://github.com/linuxserver/docker-baseimage-selkies)GPL-3.0 许可证),因此整个项目需要遵循 GPL-3.0 的传染性要求。 ### 📜 许可证说明
### 📜 许可证合规说明 - **项目许可证**: MIT License - 宽松的开源许可证
- **依赖项说明**: 本项目使用 [LinuxServer.io baseimage-selkies](https://github.com/linuxserver/docker-baseimage-selkies) 作为基础镜像
本项目严格遵循开源许可证要求: - **许可证兼容性**: 由于本项目仅使用基础镜像而未修改其源码根据容器化软件的许可证实践可以采用MIT许可证
- **源码开放**: 完整项目源代码在 GitHub 上公开https://github.com/nickrunning/wechat-selkies
1. **依赖项许可证**: 使用了 GPL-3.0 许可证的 `linuxserver/docker-baseimage-selkies` 基础镜像
2. **传染性影响**: 根据 GPL-3.0 第5条衍生作品必须采用相同许可证
3. **源码提供**: 完整项目源代码已在 GitHub 上公开https://github.com/nickrunning/wechat-selkies
4. **分发要求**: 任何分发本项目的个人或组织都必须:
- 保持 GPL-3.0 许可证
- 提供完整源代码访问
- 保留所有版权声明和许可证通知
如需了解更多关于 GPL-3.0 许可证的信息请访问https://www.gnu.org/licenses/gpl-3.0.html
## 免责声明与版权声明 ## 免责声明与版权声明
@@ -212,4 +336,4 @@ docker-compose logs -f wechat-selkies
## Star History ## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=nickrunning/wechat-selkies&type=Date)](https://www.star-history.com/#nickrunning/wechat-selkies&Date) [![Star History Chart](https://api.star-history.com/svg?repos=nickrunning/wechat-selkies&type=Date)](https://www.star-history.com/#nickrunning/wechat-selkies&Date)

View File

@@ -1,17 +1,29 @@
# WeChat Selkies # WeChat Selkies
[![GitHub Stars](https://img.shields.io/github/stars/nickrunning/wechat-selkies?style=flat-square&logo=github&color=yellow)](https://github.com/nickrunning/wechat-selkies/stargazers)
[![GitHub Forks](https://img.shields.io/github/forks/nickrunning/wechat-selkies?style=flat-square&logo=github&color=blue)](https://github.com/nickrunning/wechat-selkies/network/members)
[![GitHub Issues](https://img.shields.io/github/issues/nickrunning/wechat-selkies?style=flat-square&logo=github&color=red)](https://github.com/nickrunning/wechat-selkies/issues)
[![GitHub License](https://img.shields.io/github/license/nickrunning/wechat-selkies?style=flat-square&color=green)](https://github.com/nickrunning/wechat-selkies/blob/master/LICENSE)
[![Docker Pulls](https://img.shields.io/docker/pulls/nickrunning/wechat-selkies?style=flat-square&logo=docker&color=blue)](https://hub.docker.com/r/nickrunning/wechat-selkies)
[![Docker Image Size](https://img.shields.io/docker/image-size/nickrunning/wechat-selkies?style=flat-square&logo=docker&color=orange)](https://hub.docker.com/r/nickrunning/wechat-selkies)
[![GitHub Release](https://img.shields.io/github/v/release/nickrunning/wechat-selkies?style=flat-square&logo=github&include_prereleases)](https://github.com/nickrunning/wechat-selkies/releases)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nickrunning/wechat-selkies/docker.yml?style=flat-square&logo=github-actions&label=build)](https://github.com/nickrunning/wechat-selkies/actions)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/nickrunning/wechat-selkies?style=flat-square&logo=github&color=purple)](https://github.com/nickrunning/wechat-selkies/commits)
English | [中文](README.md) English | [中文](README.md)
Docker-based WeChat Linux client with browser access support using Selkies WebRTC technology. Docker-based WeChat/QQ Linux client with browser access support using Selkies WebRTC technology.
## Project Overview ## Project Overview
This project packages the official WeChat Linux client in a Docker container, enabling direct WeChat usage in browsers through Selkies technology without local installation. Suitable for server deployment, remote work, and other scenarios. This project packages the official WeChat/QQ Linux client in a Docker container, enabling direct WeChat/QQ usage in browsers through Selkies technology without local installation. Suitable for server deployment, remote work, and other scenarios.
## Upgrade Notes ## Upgrade Notes
> If some features are missing after an upgrade, please clear the `openbox` directory in the local mounted directory (e.g., `./config/.config/openbox`). > If some features are missing after an upgrade, please clear the `openbox` directory in the local mounted directory (e.g., `./config/.config/openbox`).
> This repository includes automatic upstream WeChat version detection: GitHub Actions periodically checks the official `.deb` packages, updates `versions/upstream.env` when changes are detected, and then triggers the image build workflow.
## Features ## Features
- 🌐 **Browser Access**: Use WeChat directly through web browsers without local installation - 🌐 **Browser Access**: Use WeChat directly through web browsers without local installation
@@ -23,6 +35,13 @@ This project packages the official WeChat Linux client in a Docker container, en
- 🖥️ **AMD64 and ARM64 Architecture Support**: Compatible with mainstream CPU architectures - 🖥️ **AMD64 and ARM64 Architecture Support**: Compatible with mainstream CPU architectures
- 🔧 **Hardware Acceleration**: Optional GPU hardware acceleration support - 🔧 **Hardware Acceleration**: Optional GPU hardware acceleration support
- 🪟 **Window Switcher**: Added a floating window switcher in the top left corner for easy switching to background windows, laying the foundation for adding other features in the future - 🪟 **Window Switcher**: Added a floating window switcher in the top left corner for easy switching to background windows, laying the foundation for adding other features in the future
- 🤖 **Auto Start**: Configurable auto-start for WeChat and QQ clients (optional)
- 📋 **Desktop Shortcut Integration**: Automatically scans `.desktop` files in `~/Desktop/` and adds them to the right-click menu, making it easy to launch third-party applications (e.g., apps installed via proot-apps)
- 📂 **File Manager**: Built-in PCManFM lightweight file manager, accessible from the right-click menu for easy file management inside the container
## Screenshots
![WeChat Screenshot](./docs/images/wechat-selkies-1.jpg)
![QQ Screenshot](./docs/images/wechat-selkies-2.jpg)
## Quick Start ## Quick Start
@@ -35,15 +54,79 @@ This project packages the official WeChat Linux client in a Docker container, en
### Quick Deployment ### Quick Deployment
1. **Direct deployment using pre-built images** 1. **Direct deployment using pre-built images**
GitHub Container Registry image:
```bash ```bash
docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selkies:latest docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ghcr.io/nickrunning/wechat-selkies:latest
``` ```
Docker Hub image:
```bash
docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri nickrunning/wechat-selkies:latest
```
> **Minimal image**: If you only need WeChat (without QQ and file manager), use the `minimal` tag for a smaller image:
> ```bash
> docker run -it -p 3001:3001 -v ./config:/config --device /dev/dri:/dev/dri ghcr.io/nickrunning/wechat-selkies:minimal
> ```
> Versioned minimal tags are also available, e.g. `:1.2.3-minimal`, `:1.2-minimal`, for pinning to a specific release.
2. **Access WeChat** 2. **Access WeChat**
Open in browser: `https://localhost:3001` or `https://<server-ip>:3001` Open in browser: `https://localhost:3001` or `https://<server-ip>:3001`
> **Note**: 3001 port is for HTTPS access. If you need HTTP access, please map port 3000 as well.
### Custom Deployment (Source Code Deployment) ### Docker Compose Deployment
1. **Create project directory and navigate into it**
```bash
mkdir wechat-selkies
cd wechat-selkies
```
2. **Create `docker-compose.yml` file with the following content**
```yaml
services:
wechat-selkies:
image: nickrunning/wechat-selkies:latest # or ghcr.io/nickrunning/wechat-selkies:latest
container_name: wechat-selkies
ports:
- "${HTTP_PORT:-3000}:3000"
- "${HTTPS_PORT:-3001}:3001"
restart: unless-stopped
volumes:
- ./config:/config
devices:
- /dev/dri:/dev/dri
environment:
- PUID=${PUID:-1000}
- PGID=${PGID:-100}
- TZ=Asia/Shanghai
- LC_ALL=zh_CN.UTF-8
- AUTO_START_WECHAT=true
- AUTO_START_QQ=false
- CUSTOM_USER=${CUSTOM_USER:-}
- PASSWORD=${PASSWORD:-}
shm_size: "${SHM_SIZE:-1gb}"
```
3. **Create `.env` file (optional)**
Copy `.env.example` and modify as needed. Variables not set will use default values:
```bash
cp .env.example .env
```
`.env` file example:
```env
HTTP_PORT=3000
HTTPS_PORT=3001
PUID=1000
PGID=100
# CUSTOM_USER=
# PASSWORD=
SHM_SIZE=1gb
```
4. **Start the service**
```bash
docker compose up -d
```
### Source Code Deployment
1. **Clone the repository** 1. **Clone the repository**
```bash ```bash
@@ -53,13 +136,18 @@ docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selki
2. **Start the service** 2. **Start the service**
```bash ```bash
docker-compose up -d docker compose up -d
``` ```
3. **Access WeChat** 3. **Access WeChat**
Open in browser: `https://localhost:3001` or `https://<server-ip>:3001` Open in browser: `https://localhost:3001` or `https://<server-ip>:3001`
> **Build minimal version**: When building from source, use build-arg to create a WeChat-only image:
> ```bash
> docker build --build-arg INSTALL_QQ=false --build-arg INSTALL_PCMANFM=false -t wechat-selkies:minimal .
> ```
### Configuration ### Configuration
For more custom configurations, please refer to [Selkies Base Images from LinuxServer](https://github.com/linuxserver/docker-baseimage-selkies). For more custom configurations, please refer to [Selkies Base Images from LinuxServer](https://github.com/linuxserver/docker-baseimage-selkies).
@@ -67,16 +155,16 @@ For more custom configurations, please refer to [Selkies Base Images from LinuxS
#### Docker Hub Push Configuration #### Docker Hub Push Configuration
This project supports pushing to both GitHub Container Registry and Docker Hub. Docker Hub push is optional and requires manual configuration. Please add the following Environment Secrets and Environment Variables in your repository to enable Docker Hub push functionality: This project supports pushing to both GitHub Container Registry and Docker Hub. Docker Hub push is optional and requires manual configuration. Please add the following Environment Secrets and Environment Variables in your repository to enable Docker Hub push functionality:
**Required Environment Secrets:** **Environment Secrets:**
* `DOCKERHUB_USERNAME`: Your Docker Hub username * `DOCKERHUB_USERNAME`: Your Docker Hub username
* `DOCKERHUB_TOKEN`: Your Docker Hub Access Token * `DOCKERHUB_TOKEN`: Your Docker Hub Access Token
**Required Environment Variables:** **Environment Variables:**
* `ENABLE_DOCKERHUB`: Set to `true` to enable Docker Hub push * `ENABLE_DOCKERHUB`: Set to `true` to enable Docker Hub push
#### Environment Variables #### Environment Variables
Configure the following environment variables in `docker-compose.yml`: Configure the following environment variables in `docker-compose.yml`. Variables with `${VAR:-default}` syntax can be overridden via a `.env` file:
| Variable | Default | Description | | Variable | Default | Description |
|----------|---------|-------------| |----------|---------|-------------|
@@ -87,6 +175,8 @@ Configure the following environment variables in `docker-compose.yml`:
| `LC_ALL` | `zh_CN.UTF-8` | Locale setting | | `LC_ALL` | `zh_CN.UTF-8` | Locale setting |
| `CUSTOM_USER` | - | Custom username (recommended) | | `CUSTOM_USER` | - | Custom username (recommended) |
| `PASSWORD` | - | Web UI access password (recommended) | | `PASSWORD` | - | Web UI access password (recommended) |
| `AUTO_START_WECHAT` | `true` | Whether to automatically start the WeChat client |
| `AUTO_START_QQ` | `false` | Whether to automatically start the QQ client |
#### Port Configuration #### Port Configuration
@@ -98,6 +188,19 @@ Configure the following environment variables in `docker-compose.yml`:
> **Note:** If the right-click menu lacks `WeChat` related options after an upgrade, please clear the `openbox` directory in the local mounted directory (e.g., `./config/.config/openbox`). > **Note:** If the right-click menu lacks `WeChat` related options after an upgrade, please clear the `openbox` directory in the local mounted directory (e.g., `./config/.config/openbox`).
## Installing Third-Party Applications (e.g., Telegram)
This project supports installing third-party Linux applications via [proot-apps](https://github.com/linuxserver/proot-apps). Here's how to install Telegram as an example:
1. Open the container desktop in your browser
2. Click the **Sidebar** on the left → **Applications**
3. Find **Telegram** in the application list
4. Click the **Install** button and wait for the installation to complete
Once installed, the application shortcut will automatically appear in the `~/Desktop/` directory, and the **right-click menu will auto-refresh** — no container restart needed to launch the app from the menu.
> **Tip:** To uninstall an application, go to Sidebar → Applications, select the app, and click **Uninstall**. The right-click menu will update automatically.
## Advanced Configuration ## Advanced Configuration
### Hardware Acceleration ### Hardware Acceleration
@@ -114,6 +217,7 @@ devices:
``` ```
wechat-selkies/ wechat-selkies/
├── docker-compose.yml # Docker Compose configuration file ├── docker-compose.yml # Docker Compose configuration file
├── .env.example # Environment variables example file
├── Dockerfile # Docker image build file ├── Dockerfile # Docker image build file
├── LICENSE # License ├── LICENSE # License
├── README.md # Project documentation (Chinese) ├── README.md # Project documentation (Chinese)
@@ -127,6 +231,33 @@ wechat-selkies/
## Troubleshooting ## Troubleshooting
### Updating WeChat/QQ Version
When WeChat or QQ displays a "version outdated" message, simply pull the latest image and recreate the container. Your chat history and configurations will be preserved:
```bash
# Using pre-built images
docker compose pull && docker compose up -d
# Using source code build
git pull && docker compose up -d --build
```
> **Note:** The WeChat and QQ download URLs point to the latest official versions. Rebuilding the image will automatically download the newest version.
For maintainers, the current automation flow is:
1. `Detect Upstream Package Updates` checks the official WeChat packages every 6 hours and can also be triggered manually
2. If the version or package hash changes, the workflow updates `versions/upstream.env`
3. Once that file is committed to `master`, it automatically triggers `Build and Publish Docker Image`
The version state file is stored at `versions/upstream.env` and currently records:
- WeChat amd64/arm64 download URLs
- Parsed WeChat amd64/arm64 package versions
- WeChat amd64/arm64 package SHA256 hashes
- The last detection time that actually changed the tracked state
### Common Issues ### Common Issues
1. **Unable to access Web UI** 1. **Unable to access Web UI**
@@ -137,7 +268,7 @@ wechat-selkies/
View container runtime logs: View container runtime logs:
```bash ```bash
docker-compose logs -f wechat-selkies docker compose logs -f wechat-selkies
``` ```
## Technical Architecture ## Technical Architecture
@@ -159,23 +290,14 @@ Issues and Pull Requests are welcome!
## License ## License
This project is licensed under **GNU General Public License v3.0**. See the [LICENSE](LICENSE) file for details. This project is licensed under **MIT License**. See the [LICENSE](LICENSE) file for details.
**Important Note**: This project depends on [LinuxServer.io baseimage-selkies](https://github.com/linuxserver/docker-baseimage-selkies) (GPL-3.0 license), therefore the entire project must comply with GPL-3.0 copyleft requirements. ### 📜 License Statement
### 📜 License Compliance Statement - **Project License**: MIT License - A permissive open source license
- **Dependency Note**: This project uses [LinuxServer.io baseimage-selkies](https://github.com/linuxserver/docker-baseimage-selkies) as base image
This project strictly follows open source license requirements: - **License Compatibility**: Since this project only uses the base image without modifying its source code, following containerized software licensing practices, it can adopt the MIT license
- **Open Source**: Complete project source code is publicly available on GitHub: https://github.com/nickrunning/wechat-selkies
1. **Dependency License**: Uses GPL-3.0 licensed `linuxserver/docker-baseimage-selkies` base image
2. **Copyleft Effect**: According to GPL-3.0 Section 5, derivative works must adopt the same license
3. **Source Code Availability**: Complete project source code is publicly available on GitHub: https://github.com/nickrunning/wechat-selkies
4. **Distribution Requirements**: Any individual or organization distributing this project must:
- Maintain GPL-3.0 license
- Provide complete source code access
- Retain all copyright notices and license notices
For more information about GPL-3.0 license, please visit: https://www.gnu.org/licenses/gpl-3.0.html
## Disclaimer and Copyright Notice ## Disclaimer and Copyright Notice
@@ -213,4 +335,4 @@ For more information about GPL-3.0 license, please visit: https://www.gnu.org/li
## Star History ## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=nickrunning/wechat-selkies&type=Date)](https://www.star-history.com/#nickrunning/wechat-selkies&Date) [![Star History Chart](https://api.star-history.com/svg?repos=nickrunning/wechat-selkies&type=Date)](https://www.star-history.com/#nickrunning/wechat-selkies&Date)

View File

@@ -10,10 +10,12 @@ services:
devices: devices:
- /dev/dri:/dev/dri # optional, for hardware acceleration - /dev/dri:/dev/dri # optional, for hardware acceleration
ports: ports:
- "3001:3001" - "${HTTP_PORT:-3000}:3000" # http port
- "${HTTPS_PORT:-3001}:3001" # https port
restart: unless-stopped restart: unless-stopped
environment: environment:
- PUID=1000 - PUID=${PUID:-1000} # set user id according to your system
- PGID=100 - PGID=${PGID:-100} # set group id according to your system
# - CUSTOM_USER=<Your Name> # recommended to set a custom user name - CUSTOM_USER=${CUSTOM_USER:-} # recommended to set a custom user name
# - PASSWORD=<Your Password> # recommended to set a password for selkies web ui - PASSWORD=${PASSWORD:-} # recommended to set a password for selkies web ui
shm_size: "${SHM_SIZE:-1gb}" # recommended, will improve performance

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<openbox_menu xmlns="http://openbox.org/3.4/menu"> <openbox_menu xmlns="http://openbox.org/3.4/menu">
<menu id="root-menu" label="MENU"> <menu id="root-menu" label="MENU">
<item label="WeChat" icon="/usr/share/icons/hicolor/128x128/apps/wechat.png"><action name="Execute"><command>/scripts/wechat/wechat-start.sh</command></action></item>
<item label="QQ" icon="/usr/share/icons/hicolor/512x512/apps/qq.png"><action name="Execute"><command>/scripts/qq/qq-start.sh</command></action></item>
<separator />
<item label="File Manager" icon="/usr/share/pixmaps/xterm-color_48x48.xpm"><action name="Execute"><command>pcmanfm</command></action></item>
<item label="xterm" icon="/usr/share/pixmaps/xterm-color_48x48.xpm"><action name="Execute"><command>/usr/bin/xterm</command></action></item> <item label="xterm" icon="/usr/share/pixmaps/xterm-color_48x48.xpm"><action name="Execute"><command>/usr/bin/xterm</command></action></item>
<item label="WeChat" icon="/usr/share/icons/hicolor/48x48/apps/wechat.png"><action name="Execute"><command>/scripts/wechat/wechat-restart.sh</command></action></item>
<item label="Restore WeChat" icon="/usr/share/icons/hicolor/48x48/apps/wechat.png"><action name="Execute"><command>/scripts/wechat/wechat-unminimize.sh</command></action></item>
</menu> </menu>
</openbox_menu> </openbox_menu>

3
root/scripts/qq/qq-restart.sh Executable file
View File

@@ -0,0 +1,3 @@
#!/bin/bash
pkill -9 -f /usr/bin/qq 2>/dev/null
nohup /usr/bin/qq --no-sandbox >/dev/null 2>&1 &

3
root/scripts/qq/qq-start.sh Executable file
View File

@@ -0,0 +1,3 @@
#!/bin/bash
/usr/bin/qq --no-sandbox

57
root/scripts/refresh-menu.sh Executable file
View File

@@ -0,0 +1,57 @@
#!/bin/bash
# Regenerate openbox right-click menu from defaults + ~/Desktop/*.desktop files
MENU_DEFAULT="/defaults/menu.xml"
MENU_TARGET="/config/.config/openbox/menu.xml"
MENU_TMP="/tmp/menu.xml"
mkdir -p /config/.config/openbox
cp "$MENU_DEFAULT" "$MENU_TMP"
if ls "$HOME/Desktop/"*.desktop >/dev/null 2>&1; then
for desktop_file in "$HOME/Desktop/"*.desktop; do
name=$(grep -E "^Name=" "$desktop_file" | head -n 1 | cut -d "=" -f 2-)
exec_cmd=$(grep -E "^Exec=" "$desktop_file" | head -n 1 | cut -d "=" -f 2-)
icon=$(grep -E "^Icon=" "$desktop_file" | head -n 1 | cut -d "=" -f 2-)
# skip entries without a name or exec command
[ -z "$name" ] || [ -z "$exec_cmd" ] && continue
# strip %U, %u, %F, %f field codes
exec_cmd=$(echo "$exec_cmd" | sed 's/ %[fFuU]//g')
# resolve icon path if it's just a name (not an absolute path)
if [ -n "$icon" ] && [ "${icon#/}" = "$icon" ]; then
icon_resolved=""
# search in proot-apps icons (prefer 256x256)
for size in 256x256 512x512 128x128 64x64 48x48 scalable; do
found=$(find /config/proot-apps/*/usr/share/icons/hicolor/"$size"/apps/"$icon".* 2>/dev/null | head -n 1)
if [ -n "$found" ]; then
icon_resolved="$found"
break
fi
done
# fallback: search system icons
if [ -z "$icon_resolved" ]; then
found=$(find /usr/share/icons/hicolor/*/apps/"$icon".* 2>/dev/null | head -n 1)
[ -n "$found" ] && icon_resolved="$found"
fi
[ -n "$icon_resolved" ] && icon="$icon_resolved"
fi
# handle missing icon
[ -z "$icon" ] && icon="/usr/share/pixmaps/xterm-color_48x48.xpm"
# escape XML entities
exec_cmd=$(echo "$exec_cmd" | sed 's/&/\&amp;/g; s/</\&lt;/g; s/>/\&gt;/g')
name=$(echo "$name" | sed 's/&/\&amp;/g; s/</\&lt;/g; s/>/\&gt;/g; s/"/\&quot;/g')
icon=$(echo "$icon" | sed 's/&/\&amp;/g; s/</\&lt;/g; s/>/\&gt;/g; s/"/\&quot;/g')
sed -i "/<menu id=\"root-menu\" label=\"MENU\">/a \\<item label=\"${name}\" icon=\"${icon}\"><action name=\"Execute\"><command>${exec_cmd}</command></action></item>" "$MENU_TMP"
done
fi
if [ ! -f "$MENU_TARGET" ] || ! cmp -s "$MENU_TMP" "$MENU_TARGET"; then
cp "$MENU_TMP" "$MENU_TARGET"
openbox --reconfigure 2>/dev/null || true
fi

View File

@@ -1,7 +1,55 @@
#!/bin/bash #!/bin/bash
# start WeChat application in the background if wechat exists # clean up stale dbus pid file to prevent startup failures after container restart
if [ -f /usr/bin/wechat ]; then nohup /usr/bin/wechat > /dev/null 2>&1 & fi rm -f /run/dbus/pid
# configure openbox dock mode for stalonetray
if [ ! -f /config/.config/openbox/rc.xml ] || grep -A20 "<dock>" /config/.config/openbox/rc.xml | grep -q "<noStrut>no</noStrut>"; then
mkdir -p /config/.config/openbox
[ ! -f /config/.config/openbox/rc.xml ] && cp /etc/xdg/openbox/rc.xml /config/.config/openbox/
sed -i '/<dock>/,/<\/dock>/s/<noStrut>no<\/noStrut>/<noStrut>yes<\/noStrut>/' /config/.config/openbox/rc.xml
openbox --reconfigure
fi
# configure default window behavior: open WeChat/QQ as normal windows instead of maximized
OB_RC="/config/.config/openbox/rc.xml"
if [ -f "$OB_RC" ] && ! grep -q '<application class="wechat"' "$OB_RC"; then
sed -i '/<\/openbox_config>/i \
<applications>\
<application class="wechat">\
<maximized>no</maximized>\
</application>\
<application class="QQ">\
<maximized>no</maximized>\
</application>\
</applications>' "$OB_RC"
openbox --reconfigure 2>/dev/null || true
fi
# generate openbox menu from defaults + ~/Desktop/*.desktop files
/scripts/refresh-menu.sh
# watch ~/Desktop/ for .desktop file changes and auto-refresh menu
mkdir -p "$HOME/Desktop"
if command -v inotifywait >/dev/null 2>&1; then
(while inotifywait -q -e create -e delete -e modify "$HOME/Desktop/" --include '\.desktop$'; do
sleep 1
/scripts/refresh-menu.sh
done) >/dev/null 2>&1 &
fi
nohup stalonetray --dockapp-mode simple > /dev/null 2>&1 &
# start WeChat application in the background if exists and auto-start enabled
if [ "$AUTO_START_WECHAT" = "true" ]; then
if [ -f /usr/bin/wechat ]; then nohup /usr/bin/wechat > /dev/null 2>&1 & fi
fi
# start QQ application in the background if exists and auto-start enabled
if [ "$AUTO_START_QQ" = "true" ]; then
if [ -f /usr/bin/qq ]; then nohup /usr/bin/qq --no-sandbox > /dev/null 2>&1 & fi
fi
# !deprecated: start window switcher application in the background
# start window switcher application in the background # start window switcher application in the background
nohup sleep 2 && python /scripts/window_switcher.py > /dev/null 2>&1 & # nohup sleep 2 && python /scripts/window_switcher.py > /dev/null 2>&1 &

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

12
versions/upstream.env Normal file
View File

@@ -0,0 +1,12 @@
# Upstream package state tracked by automation.
WECHAT_AMD64_URL="https://dldir1v6.qq.com/weixin/Universal/Linux/WeChatLinux_x86_64.deb"
WECHAT_ARM64_URL="https://dldir1v6.qq.com/weixin/Universal/Linux/WeChatLinux_arm64.deb"
WECHAT_AMD64_VERSION="4.1.1.4"
WECHAT_ARM64_VERSION="4.1.1.4"
WECHAT_AMD64_SHA256="ce6a5c201839383d6ab0198c026ecec274bd62803044aec61fdca20e02c797e2"
WECHAT_ARM64_SHA256="5deb709bcb94bf368eb39d01934cc8456b3fd811d39b45e061c7348ddd8c05a4"
WECHAT_LAST_CHECKED_AT="2026-04-07T12:45:40Z"