Outline Bridge Server

This repository contains Docker Compose files designed to deploy V2Ray as a bridge (relay) server for the Outline proxy. The primary goal is to enhance the functionality of the Outline in highly restricted networks where direct connections to the Outline server is not possible.

Documentation

What's Outline?

Outline is a set of proxy tools developed by Google based on the shadowsocks protocol. It includes Outline Manager, a desktop application for setting up servers, managing users, and tracking traffic, and Outline Manager, a user-friendly app compatible with various mobile and desktop platforms.

It originally works as below.

[Outline Client] <-> [Outline Server] <-> (Internet)

Read the Outline official documentation to set up an Outline server.

What's V2Ray?

V2Ray is a proxy tool that supports multiple protocols, including the dokodemo-door protocol. This specific protocol forwards incoming traffic (TCP and UDP) from a specified port to a designated destination port.

What's a Bridge Server?

A bridge (relay) server connects clients to Outline servers by forwarding their traffic.

It changes the Outline flow as below.

[Outline Client] <-> [Bridge Server] <-> [Outline Server] <-> (Internet)

Setup Bridge Server using V2Ray

To set up a bridge (relay) server using V2Ray, follow these steps:

1. Install Docker and Docker-compose on the bridge (relay) server.
2. Clone this repository into the bridge server.
3. Run ./setup.py. It prompts the following items:
   1. Number of Outline servers: Please provide the number of servers, typically just 1
   2. Outline server i host: Find it in $\color{green}{\textsf{Outline Manager}}$ > Settings > Hostname
   3. Outline server i port: Find it in $\color{green}{\textsf{Outline Manager}}$ > Settings > Port for new access keys
   4. If you are using a firewall such as ufw, add the port to the whitelist.
4. Run docker-compose up -d or docker compose up -d.
5. Change $\color{green}{\textsf{Outline Manager}}$ > Settings > Hostname field to the bridge server IP address.
6. Delete old access keys in the $\color{green}{\textsf{Outline Manager}}$ and generate new ones.
7. Download Outline Client and import a generated access key.
8. Press $\color{green}{\textsf{CONNECT}}$ and enjoy the freedom!

More

• V2Ray Docker Compose