d
/
d2ray
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Easy Xray + xtls-vision + reality in Docker
47 Commits 3 Branches 0 Tags 436 KiB
Python 88.4%
Dockerfile 7.8%
Shell 3.8%
Go to file
quackerd 844872bb0b Update 'README.md' 2021-02-01 07:53:48 +00:00
.gitignore Initial commit 2020-05-04 09:13:58 +00:00
LICENSE new format 2021-01-16 17:53:44 -05:00
README.md Update 'README.md' 2021-02-01 07:53:48 +00:00
client_conf.in fix 2021-02-01 01:30:13 -05:00
client_obj.in xray support 2021-02-01 01:07:23 -05:00
config.yml fix 2021-02-01 02:30:45 -05:00
configure.py fix 2021-02-01 02:06:02 -05:00
docker-compose.in fix 2021-02-01 01:16:01 -05:00
nginx.in fix 2021-02-01 02:40:21 -05:00
server.in fix 2021-02-01 01:33:57 -05:00
watchtower.in fix 2021-02-01 01:16:01 -05:00

README.md

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. Run docker-compose up -d within that directory to start the stack.
  • To start over or to update the existing configuration. Simply change config.yml, rerun configure.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:

  1. Pull the latest change with git pull
  2. If there are conflicts, stash your local changes with git stash
  3. Run git pull again
  4. Run git stash pop to pop your local changes
  5. Manually merge the conflicting files
  6. 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 in nginx/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.