hassio-addons/shadowsocks/DOCS.md

32 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2023-10-22 14:41:02 +02:00
# Home Assistant Slowtech Add-on: Shadowsocks
2023-10-22 14:23:58 +02:00
This is an Home Assistant add-on that packages a [shadowsocks server][package-homepage], an encrypted SOCKS v5 proxy server.
## Installation
1. Add the _addons_ repository to your Home Assistant instance's repositories list. (See README.md file in the parent directory.)
1. Follow [Home Assistant's instructions][hassio-install-addon] to install the add-on.
## Configuration
The port on which the proxy is exposed can be changed in the _Configuration_ tab, under _Network_.
## Changelog & Releases
The add-on versioning follows the [docker container's versioning][container-releases].
## Support
This repository does not accept inquiries for the moment.
## Authors & contributors
The original setup of this repository and packaging work is by Pierre Guillod.
The backend software is developped by [contributors][github-contribs].
[package-homepage]: https://shadowsocks.org/
[hassio-install-addon]: https://www.home-assistant.io/addons/
[github-contribs]: https://github.com/shadowsocks/shadowsocks-rust/graphs/contributors
[container-releases]: https://github.com/shadowsocks/shadowsocks-rust/pkgs/container/ssserver-rust