Skip to content

Commit

Permalink
Create V2RAY_SINGLE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
miladrahimi committed Jun 14, 2024
1 parent c13a1db commit fb45139
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/V2RAY_SINGLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# V2Ray Docker Compose for Single Server

V2Ray is a proxy tool equipped with advanced functionalities and supports protocols such as Shadowsocks, VMess, and Trojan.

Currently, [V2Fly](https://www.v2fly.org/) maintains V2Ray.

## Setup

The easiest way to get V2Ray up and running is by using Docker and Docker Compose.
To install V2ray using Docker Compose you can follow the steps below.

1. Install Docker and Docker-compose ([Official Documanetation](https://docs.docker.com/engine/install/#supported-platforms)).
1. Run `git clone https://github.com/miladrahimi/v2ray-docker-compose.git` to download this repository.
1. Run `cd v2ray-docker-compose/v2ray-single-server` to change the directory.
1. Replace `<UPSTREAM-PASSWORD>` in `v2ray.json` with a Shadowsocks password like `FR33DoM`.
1. Run `docker compose up -d`.
1. Run `./clients.py` to generate client configurations and links.
1. (Optional) Run `./../utils/bbr.sh` to setup BBR and speed up the server network.

Currently, this setup supports only the Shadowsocks protocol.
You can modify the configuration file to add other protocols, as detailed in the official documentation.

## Advanced Solutions

Using V2Ray on a single server might not always be efficient,
especially in networks with more restrictions where protocols like Shadowsocks directly may not work as expected.
To set up V2Ray effectively in such environments, check the main documentation in this repository for advanced solutions:

https://github.com/miladrahimi/v2ray-docker-compose

0 comments on commit fb45139

Please sign in to comment.