Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hirbodbehnam/v2ray-installer

A simple script to install v2fly/xray on servers
https://github.com/hirbodbehnam/v2ray-installer

installer script v2fly v2ray xray

Last synced: 3 months ago
JSON representation

A simple script to install v2fly/xray on servers

Awesome Lists containing this project

README

        

# V2Ray Installer
A simple script to install v2fly or xray on Ubuntu or Debian servers.

## Features

* Automatically install service for v2fly or xray
* Support for VMess, VLess, Shadowsocks, Socks5 as protocols
* Support for TCP, TLS, websocket, gRPC as transports
* User management for VMess and VLess
* Generate config files for VMess and VLess
* Generate self signed certificates or use existing certificates
* Ability to manually add rules to config file

## Drawbacks

* This script cannot configure reverse proxies like Nginx or Caddy to work with v2ray. You need to configure them yourself.
* This script will not install firewall; But it will use it if it's installed. For Debian it uses iptables and for Ubuntu it uses ufw.

## Install

On your server run the following command:

```bash
curl -o v2ray.sh https://raw.githubusercontent.com/HirbodBehnam/V2Ray-Installer/master/v2ray.sh && bash v2ray.sh
```
At first, it installs v2fly/xray as service and then it shows you options to manage it.

### Installed Service and Files

The service is installed as `v2ray.service`. The executable itself is installed in `/usr/local/bin/`. The config file is also available in `/usr/local/etc/v2ray/config.json`.

The config file can be freely edited. You can add protocol/transports which are not supported by script to it. Script will not delete them however it's unable to create client configs for them.

### Installed v2ray Version

Script always installs the latest [v2fly release](https://github.com/v2fly/v2ray-core/releases/latest) or [Xray release](https://github.com/XTLS/Xray-core/releases/latest) from GitHub.

## Guides

There are some guides to do some stuff which script is not capable of (for example using a CDN). You can read them from [guides folder](https://github.com/HirbodBehnam/V2Ray-Installer/tree/master/Guides).