TrueChartsClone/charts/incubator/shadowsocks

shadowsocks

A secure SOCKS5 proxy. Shadowsocks is a free and open-source encryption protocol project, widely used in China to circumvent Internet censorship. It was created in 2012 by a Chinese programmer named "clowwindy", and multiple implementations of the protocol have been made available since. Can be used with any SOCKS or Shadowsocks client.

TrueCharts can be installed as both normal Helm Charts or as Apps on TrueNAS SCALE.

This readme is just an automatically generated general guide on installing our Helm Charts and Apps. For more information, please click here: shadowsocks

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Source Code

• https://github.com/shadowsocks/shadowsocks-libev/blob/master/docker/alpine/README.md
• https://hub.docker.com/r/shadowsocks/shadowsocks-libev

Requirements

Kubernetes: >=1.16.0-0

Dependencies

Repository	Name	Version
https://library-charts.truecharts.org	common	10.4.7

Installing the Chart

TrueNAS SCALE

To install this App on TrueNAS SCALE check our Quick-Start Guide.

Helm

To install the chart with the release name shadowsocks

helm repo add TrueCharts https://helm.truecharts.org
helm repo update
helm install shadowsocks TrueCharts/shadowsocks

Uninstall

TrueNAS SCALE

Upgrading, Rolling Back and Uninstalling the Chart

To upgrade, rollback or delete this App from TrueNAS SCALE check our Quick-Start Guide.

Helm

To uninstall the shadowsocks deployment

helm uninstall shadowsocks

Configuration

Helm

Available Settings

Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.

Configure using the Commandline

Specify each parameter using the --set key=value[,key=value] argument to helm install.

helm install shadowsocks \
  --set env.TZ="America/New York" \
    TrueCharts/shadowsocks

Configure using a yaml file

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

helm install shadowsocks TrueCharts/shadowsocks -f values.yaml

Connecting to other apps

If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our Linking Apps Internally quick-start guide.

Support

• Please check our quick-start guides for TrueNAS SCALE.
• See the Website
• Check our Discord
• Open a issue

---

Sponsor TrueCharts

TrueCharts can only exist due to the incredible effort of our staff. Please consider making a donation or contributing back to the project any way you can!

---

All Rights Reserved - The TrueCharts Project