.gitignore | ||
client_conf.in | ||
client_obj.in | ||
config.yml | ||
configure.py | ||
docker-compose.in | ||
LICENSE | ||
nginx.in | ||
README.md | ||
server.in | ||
watchtower.in |
d2ray
Clean, dockerized xray(TCP + XTLS) + Nginx + Let's Encrypt with official and well-maintained docker containers. No private containers.
Supports:
- xray with TCP + XTLS protocol using teddysun/xray.
- Nginx frontend and auto-renewing Let's Encrypt certificate using the popular linuxserver/swag.
- watchtower for automatic docker image updates (can be disabled) from containrrr/watchtower
- Easy multiuser configuration and user conf file generation.
Usage:
Required packages
- python3.
- docker-ce.
- docker-compose.
- python-jinja2. A popular python template processor. Just search for jinja2 with your distro's package manager.
Building
- Clone this repo.
- Modify
config.yml
to your liking. Please see the comments in the file for documentation. - Run
configure.py
with python 3. - Generated files are located in the
build
directory. Rundocker-compose up -d
within that directory to start the stack. - To start over or to update the existing configuration. Simply change
config.yml
, rerunconfigure.py
and restart the stack.
Client connections
Client conf files are generated in build/clients/[name]_[uuid]/config.json
. Clients simply need to download the most recent xray release and replace config.json
with the ones generated. The config file by default directly connects to CN mainland websites and proxies foreign websites. The same goes for DNS lookups.
You can customize the template file client_conf.in
to generate custom client conf files.
Updating
Currently you need to merge conflict yourself. Most likely only config.yml
unless you customized other template files too. An auto script is WIP and for now please do the following:
- Pull the latest change with
git pull
- If there are conflicts, stash your local changes with
git stash
- Run
git pull
again - Run
git stash pop
to pop your local changes - Manually merge the conflicting files
- Run
git add <merged files>
to mark them as conflict resolved
Troubleshooting
Basics
- Make sure your subdomain.domain.tld points to the server.
- Use
docker logs d2ray_nginx
to check for nginx init errors. Detailed nginx logs and be found innginx/logs/nginx
- Use
docker logs d2ray_xray
to check for v2ray init errors. - Use
docker logs d2ray_watchtower
to check for watchtower errors. - xray log files can be found in
build/xray
Q: The nginx container is stuck?
A: Nginx needs to obtain certificate on its first launch so this is sort of expected. If it takes an unusual amount of time (>60 seconds), kindly Ctrl-C to interrupt docker-compose and check the nginx log. Most likely something is misconfigured.