From 9e6efb96436d98d8eab19ca567a5a9bf013ff4af Mon Sep 17 00:00:00 2001 From: quackerd Date: Fri, 2 Dec 2022 13:12:46 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 617f219..b309a73 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ [![Build Status](https://ci.quacker.org/api/badges/d/d2ray/status.svg)](https://ci.quacker.org/d/d2ray) +# Xray + VLESS + XTLS + Nginx fallback in Docker! +## What is d2ray? +d2ray is a single Docker container that provides easy and braindead configuration for Xray + XTLS + Nginx fallback. d2ray also offers currently hardcoded setup instructions and Xray binary packages for various OSes and architectures. -reload3 \ No newline at end of file +## Features +- Easy 5-minutes setup +- Automatic generation and renewal of Let's Encrypt SSL certificates +- Packaged Xray binary on the fallback website. + +## How to use? +1. Download the `docker-compose.yml` from this repo. +2. Create a `.env` file in the same directory and configure the instance to your liking. + - See `.env` in the current repo. + - `PORT`: the port to run Xray on. + - `FQDN`: the domain name of your server, used to generate SSL certificates. + - `USERS`: comma separated list of users allowed access to both Xray and resource downloads. + - `LOGDIR`: the directory to store logs, currently required. +3. `docker compose up -d` +4. You can access the Xray service using an Xray client. You can access the resource downloads by accessing `https://your-domain:your-port` and clicking the `Download` button near the bottom of the page. Use one of the `USERS` as the username and password. + +## How to update? +- `docker compose down` +- `docker compose pull` +- `docker compose up -d` + +## Notes +1. Port 80 must be available on the host as it is required to obtain SSL certificates. +2. Only tested with the newer docker-compose-plugin (install with your distribution's package manager) as opposed to legacy docker-compose. \ No newline at end of file