Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 2.35 KB

README.md

File metadata and controls

98 lines (73 loc) · 2.35 KB
Raw

Outline Shadowsocks Server 🐳

Docker Image Version Docker Image Size Docker Pulls

The standalone outline-ss-server that runs inside the Google Distroless static image.

The outline-ss-server is a Shadowsocks implementation used by the Outline Server.

Features

  • Supports multiple users on a single port
  • Supports multiple ports
  • Supports whitebox monitoring using Prometheus
  • Prohibits non AEAD ciphers

Usage

Docker Compose

Create a docker-compose.yml file:

version: '3.8'

services:
  outline-shadowsocks-server:
    image: morazow/outline-shadowsocks-server:latest
    container_name: outline-shadowsocks-server
    ports:
      - "8081:8081/tcp"
      - "8081:8081/udp"
    volumes:
      - "./config.yml:/outline/config.yml:ro"
    restart: unless-stopped

Configuration

An example configuration config.yml file:

keys:
  - id: user01
    port: 8081
    cipher: chacha20-ietf-poly1305
    secret: secret1

  - id: user02
    port: 8081
    cipher: chacha20-ietf-poly1305
    secret: secret2

To run the container:

docker-compose up -d
docker-compose logs -f

Upgrade

To upgrade the image and recreate the container:

docker-compose pull
docker-compose up -d

Building

Build with a version:

VERSION="1.3.5" && \
docker build --build-arg OUTLINE_SHADOWSOCKS_VERSION="$VERSION" \
    -f Dockerfile \
    -t "morazow/outline-shadowsocks-server:$VERSION" \
    .

License

MIT License