https://github.com/morazow/docker-outline-shadowsocks-server
🐋 Outline Shadowsocks Server docker based on Distroless static image
https://github.com/morazow/docker-outline-shadowsocks-server
distroless docker shadowsocks
Last synced: about 1 year ago
JSON representation
🐋 Outline Shadowsocks Server docker based on Distroless static image
- Host: GitHub
- URL: https://github.com/morazow/docker-outline-shadowsocks-server
- Owner: morazow
- License: mit
- Created: 2021-02-14T21:36:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-14T21:55:53.000Z (about 5 years ago)
- Last Synced: 2025-05-07T05:49:17.957Z (about 1 year ago)
- Topics: distroless, docker, shadowsocks
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/morazow/outline-shadowsocks-server
- Size: 5.86 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Outline Shadowsocks Server 🐳
[![Docker Image Version][version-badge]][hub-link]
[![Docker Image Size][size-badge]][hub-link]
[![Docker Pulls][pulls-badge]][hub-link]
The standalone [outline-ss-server][outline-ss-server] that runs inside the
[Google Distroless][distroless] static image.
The `outline-ss-server` is a Shadowsocks implementation used by the [Outline
Server][outline-server].
## Features
- Supports multiple users on a single port
- Supports multiple ports
- Supports whitebox monitoring using [Prometheus][prometheus]
- Prohibits non [AEAD ciphers][aead-ciphers]
## Usage
### Docker Compose
Create a `docker-compose.yml` file:
```yml
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:
```yml
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:
```sh
docker-compose up -d
docker-compose logs -f
```
### Upgrade
To upgrade the image and recreate the container:
```sh
docker-compose pull
docker-compose up -d
```
## Building
Build with a version:
```sh
VERSION="1.3.5" && \
docker build --build-arg OUTLINE_SHADOWSOCKS_VERSION="$VERSION" \
-f Dockerfile \
-t "morazow/outline-shadowsocks-server:$VERSION" \
.
```
## License
[MIT License](LICENSE)
[distroless]: https://github.com/GoogleContainerTools/distroless
[outline-server]: https://github.com/Jigsaw-Code/outline-server
[outline-ss-server]: https://github.com/Jigsaw-Code/outline-ss-server
[prometheus]: https://prometheus.io/
[aead-ciphers]: https://shadowsocks.org/en/wiki/AEAD-Ciphers.html
[pulls-badge]: https://img.shields.io/docker/pulls/morazow/outline-shadowsocks-server.svg?style=flat-square&logo=docker
[size-badge]: https://img.shields.io/docker/image-size/morazow/outline-shadowsocks-server.svg?style=flat-square&logo=docker
[version-badge]: https://img.shields.io/docker/v/morazow/outline-shadowsocks-server.svg?style=flat-square&logo=docker
[hub-link]: https://hub.docker.com/r/morazow/outline-shadowsocks-server