wechat-selkies/README_en.md

WeChat Selkies

English | 中文

Docker-based WeChat Linux client with browser access support using Selkies WebRTC technology.

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.

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).

Features

• 🌐 Browser Access: Use WeChat directly through web browsers without local installation
• 🐳 Dockerized Deployment: Simple containerized deployment with environment isolation
• 🔒 Data Persistence: Supports persistent storage of configurations and chat records
• 🎨 Chinese Support: Complete Chinese fonts and localization support, including local Chinese input methods
• 🖼️ Image Copy: Support image copying through sidebar panel
• 📁 File Transfer: Support file transfer through sidebar panel
• 🖥️ AMD64 and ARM64 Architecture Support: Compatible with mainstream CPU architectures
• 🔧 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

Quick Start

Requirements

• Docker
• Docker Compose
• Modern browser with WebRTC support (Chrome, Firefox, Safari, etc.)

Quick Deployment

1. Direct deployment using pre-built images GitHub Container Registry image:

docker run -it -p 3001:3001 -v ./config:/config ghcr.io/nickrunning/wechat-selkies:latest

Docker Hub image:

docker run -it -p 3001:3001 -v ./config:/config nickrunning/wechat-selkies:latest

2. Access WeChat

   Open in browser: https://localhost:3001 or https://<server-ip>:3001

Custom Deployment (Source Code Deployment)

1. Clone the repository

   git clone https://github.com/nickrunning/wechat-selkies.git
   cd wechat-selkies
   

2. Start the service

   docker-compose up -d
   

3. Access WeChat

   Open in browser: https://localhost:3001 or https://<server-ip>:3001

Configuration

For more custom configurations, please refer to Selkies Base Images from LinuxServer.

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:

Required Environment Secrets:

• DOCKERHUB_USERNAME: Your Docker Hub username
• DOCKERHUB_TOKEN: Your Docker Hub Access Token

Required Environment Variables:

• ENABLE_DOCKERHUB: Set to true to enable Docker Hub push

Environment Variables

Configure the following environment variables in docker-compose.yml:

Variable	Default	Description
TITLE	WeChat Selkies	Web UI title
PUID	1000	User ID
PGID	100	Group ID
TZ	Asia/Shanghai	Timezone setting
LC_ALL	zh_CN.UTF-8	Locale setting
CUSTOM_USER	-	Custom username (recommended)
PASSWORD	-	Web UI access password (recommended)

Port Configuration

• 3001: Web UI access port

Volume Mounts

• ./config:/config: WeChat configuration and data persistence directory

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).

Advanced Configuration

Hardware Acceleration

If your system supports GPU hardware acceleration, the Docker Compose configuration includes relevant device mapping:

devices:
  - /dev/dri:/dev/dri

Directory Structure

wechat-selkies/
├── docker-compose.yml          # Docker Compose configuration file
├── Dockerfile                  # Docker image build file
├── LICENSE                     # License
├── README.md                   # Project documentation (Chinese)
├── README_en.md                # Project documentation (English)
├── config/                     # Configuration and data persistence directory
└── root/                       # Container initialization files
    ├── defaults/
    │   └── autostart           # Auto-start configuration
    └── wechat.png              # WeChat icon

Troubleshooting

Common Issues

1. Unable to access Web UI
   • Check if port 3001 is occupied
   • Confirm Docker container is running normally: docker ps

Log Viewing

View container runtime logs:

docker-compose logs -f wechat-selkies

Technical Architecture

• Base Image: ghcr.io/linuxserver/baseimage-selkies:ubuntunoble
• WeChat Client: Official WeChat Linux version
• Web Technology: Selkies WebRTC
• Containerization: Docker + Docker Compose

Contributing

Issues and Pull Requests are welcome!

1. Fork this project
2. Create feature branch: git checkout -b feature/your-feature
3. Commit changes: git commit -am 'Add some feature'
4. Push branch: git push origin feature/your-feature
5. Submit Pull Request

License

This project is licensed under GNU General Public License v3.0. See the LICENSE file for details.

Important Note: This project depends on LinuxServer.io baseimage-selkies (GPL-3.0 license), therefore the entire project must comply with GPL-3.0 copyleft requirements.

📜 License Compliance Statement

This project strictly follows open source license requirements:

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

🚨 Important Statement

This project has no affiliation with Tencent and is an independent third-party open source project.

📋 Copyright Notice

• WeChat® is a registered trademark and copyrighted work of Tencent
• The copyright of WeChat-related icons, logos and other visual elements used in this project belongs to Tencent
• This project is for technical demonstration and learning purposes only, not for commercial use
• In case of copyright disputes, relevant content will be removed immediately

⚖️ Legal Compliance

• This project strictly complies with relevant laws, regulations and user agreements
• Users should comply with local laws and regulations when using this project
• This project assumes no legal responsibility for users' actions
• If Tencent believes there is infringement, please contact us for immediate resolution

🎯 Terms of Use

• This project is for learning, research and personal use only
• Prohibited for any commercial purposes or profit-making activities
• Users should bear the risks and legal responsibilities of use
• Please comply with WeChat user agreements and related terms of service

Related Links

• WeChat Official Website
• Selkies WebRTC
• LinuxServer.io
• xiaoheiCat/docker-wechat-sogou-pinyin

Star History