/outline-bridge-server

Docker Compose files to run an Outline bridge server.

Primary LanguagePython

Outline Bridge Server

This repository contains V2Ray Docker Compose files to run a bridge server for the Outline proxy. It helps Outline proxy to work in highly restricted networks.

Documentation

Outline

Outline is a Shadowsocks-based proxy created by Google. It lets you create and manage Shadowsocks servers easily. Outline clients are well-designed applications available for all platforms.

It usually works as below.

[Outline client] <-> [Outline server] <-> (Internet)

Read the Outline official documentation to set up an Outline server using the Outline Manager application.

The Bridge Server

The bridge server will be inserted between clients and a server to connect the clients to the server in networks where this connection is not possible directly. It runs a V2Ray proxy to pass the incoming Shadowsocks traffic from clients to the Outline server.

The bridge server changes the flow as below.

[Outline client] <-> [V2Ray server] <-> [Outline server] <-> (Internet)

Setup the bridge server

Follow these steps to run the V2Ray proxy on the bridge server.

  1. Install Docker and Docker-compose.
  2. Clone this repository into the bridge server.
  3. Run ./setup.py script. It gets the following inputs:
    1. Outline Server Hostname: Find it in Outline Manager > {Server} > Settings > Hostname
    2. Outline Server Port: Find it in Outline Manager > {Server} > Settings > Port
    3. Allow the port for incoming/outcoming traffic if you have a firewall.
  4. Run docker-compose up -d.
  5. Edit Outline Manager > {Server} > Settings > Hostname to the bridge server IP address.

After updating the hostname in the Outline Manager, delete old keys and generate them again.

Docker images

More