{"id":23228380,"url":"https://github.com/flathead/shadowsocks-installer","last_synced_at":"2026-04-26T23:31:32.237Z","repository":{"id":265144928,"uuid":"895263409","full_name":"flathead/shadowsocks-installer","owner":"flathead","description":"A simple script to install and manage a Shadowsocks server with Docker, featuring multilingual support and automated setup.","archived":false,"fork":false,"pushed_at":"2024-11-27T23:47:06.000Z","size":41,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T18:24:38.465Z","etag":null,"topics":["shadowsocks","shadowsocks-libev","vpn"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flathead.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-27T21:48:01.000Z","updated_at":"2024-11-27T23:49:15.000Z","dependencies_parsed_at":"2024-11-28T00:46:50.535Z","dependency_job_id":null,"html_url":"https://github.com/flathead/shadowsocks-installer","commit_stats":null,"previous_names":["flathead/shadowsocks-installer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/flathead/shadowsocks-installer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathead%2Fshadowsocks-installer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathead%2Fshadowsocks-installer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathead%2Fshadowsocks-installer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathead%2Fshadowsocks-installer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flathead","download_url":"https://codeload.github.com/flathead/shadowsocks-installer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathead%2Fshadowsocks-installer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32317163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"ssl_error","status_checked_at":"2026-04-26T23:26:25.802Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["shadowsocks","shadowsocks-libev","vpn"],"created_at":"2024-12-19T01:13:34.544Z","updated_at":"2026-04-26T23:31:32.223Z","avatar_url":"https://github.com/flathead.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shadowsocks easy installer\n\n## README in different languages\n| Language | Description | Link |\n|----------|-------------|------|\n| 🇷🇺 Русский| README на русском языке тут -\u003e | [✨ README.ru.md](https://github.com/flathead/shadowsocks-installer/blob/master/readme-lang/README.ru.md) |\n| 🇬🇧 English| README in English is here -\u003e | [✨ README.en.md](https://github.com/flathead/shadowsocks-installer/blob/master/readme-lang/README.gb.md) |\n| 🇨🇳 中国人| 中国人 README 位于这里 -\u003e | [✨ README.cn.md](https://github.com/flathead/shadowsocks-installer/blob/master/readme-lang/README.cn.md) |\n| 🇮🇷 فارسی| README این به زبان فارسی است -\u003e | [✨ README.ir.md](https://github.com/flathead/shadowsocks-installer/blob/master/readme-lang/README.ir.md) |\n| 🇹🇷 Türkçe| Türkçe README burada -\u003e | [✨ README.tr.md](https://github.com/flathead/shadowsocks-installer/blob/master/readme-lang/README.tr.md) |\n| 🇻🇳 Tiếng Việt| README tiếng Việt tại đây -\u003e | [✨ README.vn.md](https://github.com/flathead/shadowsocks-installer/blob/master/readme-lang/README.vn.md) |\n\nThis repository provides tools for managing a **Shadowsocks** server using Docker. It includes:\n- **Management Script**: Sets up the management script and its dependencies; Controls the Shadowsocks container with commands like setup, start, stop, restart, and uninstall.\n\n### Special thanks:\n[![repo](https://img.shields.io/badge/repo-shadowsocks--libev-red.svg)](https://github.com/shadowsocks/shadowsocks-libev)\n\n---\n\n## Features\n\n- **Symbolic Link**: Ensures the script is globally accessible as `vpn`.\n- **Password Management**: Automatically generates a strong password or lets you specify one.\n- **Docker Handling**: Installs and sets up Docker automatically if not already installed.\n- **Full Cleanup**: Removes the container, image, and associated files during uninstallation.\n- **Multilingual Support**: Includes 7 different language messages.\n\n---\n\n## Installation\n\n### 1. Download and Run the Installer\n\n```bash\nhash -r \u0026\u0026 curl -fsSL https://raw.githubusercontent.com/flathead/shadowsocks-installer/refs/heads/master/installer.sh -o /tmp/installer.sh \u0026\u0026 bash /tmp/installer.sh en\n```\n\n### 2. Verify Installation\n\nThe script is installed at `/opt/shadowsocks-vpn/shadowsocks.sh` with a symbolic link created at `/usr/local/bin/vpn`.\n\nRun the following to verify:\n```bash\nvpn --help\n```\n\n---\n\n## Usage\n\nThe script supports the following commands:\n\n- **`setup [lang]`**  \n  Configures and starts a Shadowsocks container.  \n  **Example**: `vpn setup en` (English), `vpn setup ru` (Russian).\n\n- **`start`**  \n  Starts the existing container.  \n  **Example**: `vpn start`\n\n- **`stop`**  \n  Stops the container.  \n  **Example**: `vpn stop`\n\n- **`restart`**  \n  Restarts the container.  \n  **Example**: `vpn restart`\n\n- **`uninstall`**  \n  Completely removes the container, its image, and all associated files.  \n  **Example**: `vpn uninstall`\n\n- **`--help | -h`**  \n  Displays usage information.  \n  **Example**: `vpn --help`\n\n---\n\n## Example Output\n\n### Setup\n```bash\nvpn setup en\n```\n\n**Output:**\n```\n[INFO] Docker installed successfully!\n[INFO] Pulling Docker image...\n[INFO] Starting Shadowsocks container...\n\nShadowsocks successfully configured!\n=======================================\nServer IP:       203.0.113.42\nServer Port:     8388\nPassword:        randompassword123\nEncryption:      aes-256-gcm\nTimezone:        UTC+3\n=======================================\n```\n\n### Uninstall\n```bash\nvpn uninstall\n```\n\n**Output:**\n```\n[INFO] Stopping Shadowsocks container...\n[INFO] Removing Shadowsocks container...\n[INFO] Removing Docker image...\n[SUCCESS] Shadowsocks container and image removed successfully.\n```\n\n---\n\n## File Structure\n\nAfter installation:\n- **`/opt/shadowsocks-installer`**: Persistent folder containing the main script and dependencies.\n- **`/usr/local/bin/vpn`**: Symbolic link for global access.\n\n---\n\n## Dependencies\n\n- **Docker**: Automatically installed if missing.\n- **jq**: Used for JSON parsing. Install it with:\n  ```bash\n  sudo apt install jq\n  ```\n\n---\n\n## License\n\nLicensed under the **MIT License**. Contributions and forks are welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflathead%2Fshadowsocks-installer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflathead%2Fshadowsocks-installer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflathead%2Fshadowsocks-installer/lists"}