[{"_1":2,"_183":-5,"_184":-5},"loaderData",{"_3":4,"_18":19,"_25":26,"_162":163},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16,"_17":11},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","dockerRebrandTour","routes/_layout",{"_20":-5,"_21":22,"_23":11,"_24":22},"username","isAskGordonEnabled",true,"showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":89,"_112":113,"_150":-5,"_151":11,"_152":22,"_153":11,"_154":11,"_155":-5,"_156":11,"_157":-5,"_158":159,"_160":114,"_161":-7},"canonicalUrl","https://hub.docker.com/r/nutshells/ss-obfs/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","nutshells","reponame","ss-obfs","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":22,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2017-11-20T13:17:18.488025Z","description","This image combines ss-libev and simple-obfs both with the server and client included.","is_private","last_updated","2020-01-28T09:24:22.615455Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",2740,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# SS-OBFS Docker Image\n\n[![Project Nutshells](https://img.shields.io/badge/Project-_Nutshells_🌰-orange.svg)](https://github.com/quchao/nutshells/) [![Docker Build Build Status](https://img.shields.io/docker/build/nutshells/ss-obfs.svg?maxAge=3600&label=Build%20Status)](https://hub.docker.com/r/nutshells/ss-obfs/) [![Alpine Based](https://img.shields.io/badge/Alpine-3.11-0D597F.svg)](https://alpinelinux.org/) [![MIT License](https://img.shields.io/github/license/quchao/nutshells.svg?label=License)](https://github.com/quchao/nutshells/blob/master/LICENSE) [![SS-libev](https://img.shields.io/badge/shadowsocks--libev-3.3.3-lightgrey.svg)](https://github.com/shadowsocks/shadowsocks-libev/) [![Simple-obfs](https://img.shields.io/badge/Simple--obfs-latest-lightgrey.svg)](https://github.com/shadowsocks/simple-obfs)\n\nThis image combines [ss-libev](https://github.com/shadowsocks/shadowsocks-libev) and [simple-obfs](https://github.com/shadowsocks/simple-obfs) both with the server and client included.\n\n\n## Variants:\n\n| Tag | Description | 🐳 |\n|:-- |:-- |:--:|\n| `:latest` | Shadowsocks-libev & simple-obfs on `alpine:latest`. | [![Dockerfile](https://img.shields.io/badge/Dockerfile-latest-22B8EB.svg?maxAge=2592000&style=flat-square)](https://github.com/quchao/nutshells/blob/master/ss-obfs/Dockerfile/) |\n\n\n## Usage\n\n### Synopsis\n\n```\ndocker container run [OPTIONS] nutshells/ss-obfs [COMMAND] [ARG...]\n```\n\n- Learn more about `docker container run` and its `OPTIONS` [here](https://docs.docker.com/edge/engine/reference/commandline/container_run/);\n- List all available `COMMAND`s: \n `docker container run --rm --read-only nutshells/ss-obfs help`\n- List all `ARG`s (for [configuring](#custom-configurations) the containers):\n - For *server* mode:\n `docker container run --rm --read-only nutshells/ss-obfs server --help`\n - For *client* mode:\n `docker container run --rm --read-only nutshells/ss-obfs client --help`\n\n### Getting Started\n\nLet's create a *server* container on the remote server:\n\n> Replace `` with a [strong](https://en.wikipedia.org/wiki/Password_strength) password, and assign an unused port to ``.\n\n``` bash\ndocker container run \\\n -d -p :12345/tcp -p :12345/udp \\\n --name=ss-obfs-server --restart=unless-stopped --read-only \\\n -e PASSWORD= \\\n nutshells/ss-obfs \\\n server\n```\n\nThen run a *client* container on your local machine with the same configuration:\n\n> Remove `127.0.0.1:` from the `-p` options if you want to share it with the local network.\n\n``` bash\ndocker container run \\\n -d -p 127.0.0.1:12345:12345/tcp -p 127.0.0.1:12345:12345/udp \\\n --name=ss-obfs-client --restart=unless-stopped --read-only \\\n -e PASSWORD= \\\n -e SERVER_ADDRESS= -e SERVER_PORT= \\\n nutshells/ss-obfs \\\n client\n```\n\nSee if it shows the correct IP address of your remote server.\n\n``` bash\ncurl -sSL https://ipinfo.io/ --socks5 127.0.0.1:12345\n```\n\n### Custom Configurations\n\nAs you can see from the examples of the previous sections: the container accepts original [command-line options](https://github.com/shadowsocks/shadowsocks-libev/#usage) of *ss-libev* as arguments.\n\nHere are a few more examples:\n\n#### Enabling verbose mode:\n\n``` bash\ndocker container run [OPTIONS] nutshells/ss-obfs server -v [OTHER_ARG...]\n```\n\n#### Printing the version & command-line options:\n\n``` bash\ndocker container run --rm --read-only nutshells/ss-obfs server --help\ndocker container run --rm --read-only nutshells/ss-obfs client --help\n```\n\nHowever, please be informed that **some** of the options are managed by [the entrypoint script](https://github.com/quchao/nutshells/blob/master/ss-obfs/docker-entrypoint.sh) of the container. You will encounter an error while trying to set any of them, just use the [environment variables](#environment-variables) instead; as for other exceptions, just follow the message to get rid of them.\n\n\n## Reference\n\n### Environment Variables\n\n| Name | Default | Relevant Option | Description |\n|:-- |:-- |:-- |:-- |\n| `SERVER_ADDRESS` | | `-s` | Hostname or IP address of the remote server. **Required** for `client` mode ONLY. |\n| `SERVER_PORT` | | `-p` | Port number of the remote server. **Required** for `client` mode ONLY. |\n| `PASSWORD` | | `-p` | Password of the remote server. **Required** if `KEY_IN_BASE64` is unset. |\n| `KEY_IN_BASE64` | | `--key` | Base64 encoded password of the remote server. **Required** if `PASSWORD` is unset. |\n| `ENCRYPT_METHOD` | `xchacha20-ietf-poly1305` | `-m` | Encryption Algorithms. Modern ciphers such as `chacha20` or `aes-gcm` based are always recomended; choose from the latter ones if the server is AES-NI enabled. |\n| `DNS_RESOLVERS` | `8.8.8.8,8.8.4.4` | `-d` | Name servers for internal DNS resolver. `server` mode ONLY. |\n| `TIMEOUT` | `300` | `-t` | Socket timeout in seconds. |\n| `TCP_RELAY` | `true` | `-u` & `-U` | Enable TCP relay. |\n| `UDP_RELAY` | `true` | `-u` & `-U` | Enable UDP relay. |\n| `REUSE_PORT` | `true` | `--reuse-port` | Enable port reuse. |\n| `TCP_FAST_OPEN` | `true` | `--fast-open` | Enable TCP fast open. |\n| `OBFS_PLUGIN` | `http` | `--plugin` | Traffic obscuration plugin. `http` or `tls`. |\n| `OBFS_HOST` | `bing.com` | `--plugin-opts` | Hostname for traffic obscuration. `client` mode ONLY |\n\nLearn to set an environment variable [here](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e-env-env-file), or refer to the [Getting Started](#getting-started) section for some live examples.\n\n### Build Arguments\n\n| Argument | Description | Default |\n|:-- |:-- |:--:|\n| `WITH_OBFS` | Compile with the [simple-obfs](https://github.com/shadowsocks/simple-obfs) plugin. | `true` |\n\n\n## Advanced Topics\n\n### Using Docker-compose\n\nSee [the sample file](https://github.com/quchao/nutshells/blob/master/ss-obfs/docker-compose.yml).\n\n### Better Performance\n\nAccording to the [optimization tips](https://github.com/shadowsocks/shadowsocks/wiki/Optimizing-Shadowsocks), you'd better increase the open file limit for the container:\n\n> It's NOT recommended to enable the privileged mode to this purpose.\n> The default limit for open files is `1024` in containers.\n\n``` bash\ndocker container run \\\n --ulimit nofile=51200:51200 \\\n [OTHER_OPTIONS] nutshells/ss-obfs server [OTHER_ARG...]\n```\n\nAdditionally, the `--net=host` option provides the best network performance, use it if you know it exactly.\n\n### Gaining a shell access\n\nGet an interactive shell to a **running** container:\n\n``` bash\ndocker container exec -it /bin/ash\n```\n\n### Customizing the image\n\n#### by using the `--build-arg` options\n\nYou can customize the image more easily by using the `--build-arg` option.\n\n> Check out all the **build-time** arguments in [this table](#build-arguments).\n\nLet's remove the simple-obfs plugin completely from the build: \n\n``` bash\ngit clone --depth 1 https://github.com/quchao/nutshells.git\ndocker image build -q=false --rm=true --no-cache=true \\\n -t nutshells/ss-obfs \\\n -f ./ss-obfs/Dockerfile \\\n --build-arg WITH_OBFS=false \\\n ./ss-obfs\n```\n\n#### By modifying the dockerfile\n\nYou may want to make some modifications to the image.\nPull the source code from GitHub, customize it, then build one by yourself:\n\n``` bash\ngit clone --depth 1 https://github.com/quchao/nutshells.git\ndocker image build -q=false --rm=true --no-cache=true \\\n -t nutshells/ss-obfs \\\n -f ./ss-obfs/Dockerfile \\\n ./ss-obfs\n```\n\n#### By committing the changes on a container\n\nOtherwise just pull the image from the official registry, start a container and [get a shell](#gaining-a-shell-access) to it, [commit the changes](https://docs.docker.com/engine/reference/commandline/commit/) afterwards.\n\n``` bash\ndocker container commit --change \"Commit msg\" nutshells/ss-obfs\n```\n\n\n## Contributing\n\n[![Github Starts](https://img.shields.io/github/stars/quchao/nutshells.svg?maxAge=3600&style=social&label=Star)](https://github.com/quchao/nutshells/) [![Twitter Followers](https://img.shields.io/twitter/follow/chappell.svg?maxAge=3600&style=social&label=Follow)](https://twitter.com/chappell/)\n\n> Follow GitHub's [*How-to*](https://opensource.guide/how-to-contribute/) guide for the basis.\n\nContributions are always welcome in many ways:\n\n- Give a star to show your fondness;\n- File an [issue](https://github.com/quchao/nutshells/issues) if you have a question or an idea;\n- Fork this repo and submit a [PR](https://github.com/quchao/nutshells/pulls);\n- Improve the documentation.\n\n\n## Todo\n\n- [ ] Add a section about modifying kernel parameters in containers.\n- [ ] Add a `HealthCheck` instruction.\n- [ ] Add ipv6 support.\n\n## Acknowledgments & Licenses\n\nUnless specified, all codes of **Project Nutshells** are released under the [MIT License](https://github.com/quchao/nutshells/blob/master/LICENSE).\n\nOther relevant softwares:\n\n| Ware/Lib | License |\n|:-- |:--:|\n| [Docker](https://www.docker.com/) | [![License](https://img.shields.io/github/license/moby/moby.svg?maxAge=2592000&label=License)](https://github.com/moby/moby/blob/master/LICENSE/) |\n| [Shadowsocks-libev](https://github.com/shadowsocks/shadowsocks-libev/) | [![License](https://img.shields.io/github/license/shadowsocks/shadowsocks-libev.svg?maxAge=2592000&label=License)](https://github.com/shadowsocks/shadowsocks-libev/blob/master/LICENSE) |\n| [Simple-obfs](https://github.com/shadowsocks/simple-obfs/) | [![License](https://img.shields.io/github/license/shadowsocks/simple-obfs.svg?maxAge=2592000&label=License)](https://github.com/shadowsocks/simple-obfs/blob/master/LICENSE) |\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":22,"_83":11,"_84":11},"read","write","admin","user","storage_size",133405960,"orgData",{"_90":91,"_92":93,"_94":95,"_96":33,"_97":98,"_99":100,"_101":102,"_103":104,"_105":106,"_107":108,"_109":102,"_110":102,"_111":22},"id","81c96d265b874d799b945016eb3f30ca","uuid","81c96d26-5b87-4d79-9b94-5016eb3f30ca","type","organization","orgname","full_name","Team Nutshells","location","San Junipero","company","","profile_url","https://quchao.com/entry/project-nutshells","date_joined","2017-07-11T07:18:51.565591Z","gravatar_url","https://www.gravatar.com/avatar/b97dcfceccc5ff37a71268e3ffb45c5e?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[114],{"_115":44,"_116":117,"_118":119,"_90":120,"_121":122,"_50":139,"_140":117,"_141":33,"_142":56,"_57":143,"_144":145,"_146":130,"_147":139,"_148":66,"_149":22},"content_type","creator",1928237,"full_size",6248965,18248466,"images",[123],{"_124":125,"_126":127,"_128":102,"_129":130,"_131":132,"_133":134,"_135":102,"_136":-5,"_137":119,"_63":66,"_138":-5},"architecture","amd64","digest","sha256:f4a46bcf46987d37a954d9aab047796a0fe9bb23be3e879438b1d84d91965b3b","features","last_pulled","2026-10-29T09:32:55.316229969Z","last_pushed","2020-01-28T09:24:22Z","os","linux","os_features","os_version","size","variant","2020-01-28T09:24:21.826974Z","last_updater","last_updater_username","media_type","latest","repository",2081672,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":164,"_171":172,"_158":181,"_182":11},{"_40":165,"_42":166,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":167,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":168,"_79":22,"_80":170,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":169},[78],{"_82":22,"_83":11,"_84":11},"tags",{"_173":64,"_174":-5,"_175":-5,"_176":177},"count","next","previous","results",[178],{"_115":44,"_116":117,"_118":119,"_90":120,"_121":179,"_50":139,"_140":117,"_141":33,"_142":56,"_57":143,"_144":145,"_146":130,"_147":139,"_148":66,"_149":22},[180],{"_124":125,"_126":127,"_128":102,"_129":130,"_131":132,"_133":134,"_135":102,"_136":-5,"_137":119,"_63":66,"_138":-5},[],"canDeleteTags","actionData","errors"]

nutshells/ss-obfs

Tags for nutshells/ss-obfs