d2ray/README.md

[![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.

## 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. Note the `docker compose` instead of `docker-compose` commands. d2ray is only tested with the newer docker-compose-plugin (install with your distribution's package manager) as opposed to legacy docker-compose.
Update 'README.md' 2021-08-13 07:42:11 +00:00			`[![Build Status](https://ci.quacker.org/api/badges/d/d2ray/status.svg)](https://ci.quacker.org/d/d2ray)`
Update 'README.md' 2022-12-02 13:12:46 +00:00			`# 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.`
Update 'README.md' 2021-11-25 05:59:39 +00:00
Update 'README.md' 2022-12-02 13:12:46 +00:00			`## Features`
Update 'README.md' 2022-12-02 13:25:14 +00:00			`- Easy 5-minutes setup.`
			`- Automatic generation and renewal of Let's Encrypt SSL certificates.`
Update 'README.md' 2022-12-02 13:12:46 +00:00			`- 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.`
Update 'README.md' 2022-12-02 13:15:04 +00:00			2. Note the `docker compose` instead of `docker-compose` commands. d2ray is only tested with the newer docker-compose-plugin (install with your distribution's package manager) as opposed to legacy docker-compose.