{"id":31642378,"url":"https://github.com/marksowell/digitalocean-droplet-deploy-shadowsocks","last_synced_at":"2025-10-07T03:58:56.330Z","repository":{"id":316535648,"uuid":"1063786112","full_name":"marksowell/DigitalOcean-Droplet-Deploy-Shadowsocks","owner":"marksowell","description":"Deploy a DigitalOcean Droplet with Docker, Shadowsocks (TLS or TCP/UDP), and automatic HTTPS","archived":false,"fork":false,"pushed_at":"2025-10-05T02:43:04.000Z","size":30,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-05T04:26:05.263Z","etag":null,"topics":["certbot","cloud-init","digitalocean","digitalocean-droplets","docker","droplet-creation","letsencrypt","shadowsocks","shadowsocks-rust","ssl"],"latest_commit_sha":null,"homepage":"","language":null,"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/marksowell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-25T05:52:17.000Z","updated_at":"2025-10-05T02:48:48.000Z","dependencies_parsed_at":"2025-10-05T04:26:10.006Z","dependency_job_id":"cc4f95f5-a862-4049-b9a4-6ce756b3134e","html_url":"https://github.com/marksowell/DigitalOcean-Droplet-Deploy-Shadowsocks","commit_stats":null,"previous_names":["marksowell/shadowsocks-to-digitalocean","marksowell/digitalocean-droplet-deploy-shadowsocks"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/marksowell/DigitalOcean-Droplet-Deploy-Shadowsocks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2FDigitalOcean-Droplet-Deploy-Shadowsocks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2FDigitalOcean-Droplet-Deploy-Shadowsocks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2FDigitalOcean-Droplet-Deploy-Shadowsocks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2FDigitalOcean-Droplet-Deploy-Shadowsocks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marksowell","download_url":"https://codeload.github.com/marksowell/DigitalOcean-Droplet-Deploy-Shadowsocks/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2FDigitalOcean-Droplet-Deploy-Shadowsocks/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278717442,"owners_count":26033542,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["certbot","cloud-init","digitalocean","digitalocean-droplets","docker","droplet-creation","letsencrypt","shadowsocks","shadowsocks-rust","ssl"],"created_at":"2025-10-07T03:58:48.801Z","updated_at":"2025-10-07T03:58:56.326Z","avatar_url":"https://github.com/marksowell.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# DigitalOcean Droplet Deploy Shadowsocks GitHub Action\n\nThis GitHub Action deploys a **DigitalOcean Droplet** with Docker and a **Shadowsocks-Rust** container, in TLS camouflage or TCP/UDP mode. It automatically creates free Let’s Encrypt TLS certificates and manages DNS records in DigitalOcean.  \n\n\u003cbr\u003e\n\u003cp\u003e\n  \u003ca href=\"https://www.digitalocean.com\"\u003e\n    \u003cimg src=\"https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg\" alt=\"Powered by DigitalOcean\" width=\"200px\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- Deploy a droplet from GitHub Actions with **one click**\n- Uses `doctl` and a `cloud-init.yml` file\n- Provisioned with **cloud-init**\n  - Installs Docker \u0026 Docker Compose\n  - Installs Certbot and issues a valid Let’s Encrypt certificate when TLS mode is selected\n  - Waits until Docker is ready\n  - Launches a Shadowsocks container in either **TLS (443 TCP)** mode or **TCP/UDP** mode\n  - Auto-renews certs and restarts Shadowsocks after renewal\n- Auto-creates or updates a **DigitalOcean DNS A record** for your domain/subdomain\n- Works with defaults but allows overriding region, size, image, and hostname\n\n## Requirements\n\n- A **DigitalOcean account** with:\n  - An existing **SSH key** already uploaded (you’ll provide its ID in the secrets).\n- A **domain managed in DigitalOcean DNS**:\n  - The GitHub Action automatically creates or updates an **A record** for your chosen subdomain.\n  - Your domain must already be added to [DigitalOcean’s DNS control panel](https://cloud.digitalocean.com/networking/domains).\n  - If your domain is currently managed elsewhere (Cloudflare, registrar DNS, etc.), you must first point your domain’s nameservers to DigitalOcean:\n    ```txt\n    ns1.digitalocean.com\n    ns2.digitalocean.com\n    ns3.digitalocean.com\n    ```\n- A **GitHub repository fork** with required secrets set up (see [Secrets Setup](#2-secrets-setup)).\n\n## Usage\n\n### 1. Fork the Repository\n\n1. Click the **Fork** button at the top of the GitHub repository page.\n2. Once forked you can use it directly from your account.\n\n### 2. Secrets Setup\n\nYou'll need to create the following secrets in your forked repository for the action to work:\n\n1. **`DIGITALOCEAN_ACCESS_TOKEN`**: Your DigitalOcean API token. You can generate it in your DigitalOcean API settings.\n    1. Create A New Personal Access Token and give the token a name.\n    2. Choose **Custom Scopes** then select the following granular scopes:\n       1. `ssh_key:read`\n       2. `droplet:read,create`\n       3. `domain:read,create,update`\n2. **`DIGITALOCEAN_SSH_KEY_ID`**: The DigitalOcean SSH key ID you'd like to use. List your SSH key IDs with ```doctl compute ssh-key list```.\n\nTo add these secrets:\n\n1. Go to your forked repository on GitHub.\n2. Navigate to **Settings** \u003e **Secrets and variables** \u003e **Actions**.\n3. Click **New repository secret** and add `DIGITALOCEAN_ACCESS_TOKEN` then `DIGITALOCEAN_SSH_KEY_ID`.\n\n### 3. Run the Included Workflow\n\nAfter forking this repository into your own GitHub account:\n\n1. Go to your forked repo’s **Actions** tab.\n2. Select **Deploy Droplet to DigitalOcean**.  \n3. Click **Run workflow** and fill in the inputs:\n   - `domain` - Root domain (example.com).\n   - `subdomain` - Subdomain (e.g., app, www, test). Leave blank for root.\n   - `hostname` - Droplet hostname.\n   - `password` - Shadowsocks password.\n   - Optionally, override mode, region, size, or image.\n4. Wait for job to complete.\n5. Your droplet will be live with:\n   - Shadowsocks running in either **TLS (443 TCP)** mode or **TCP/UDP** mode.\n   - Valid TLS certificate from Let’s Encrypt.\n   - Auto-renew enabled.\n   - Shadowsocks running, accessible via 443 (TLS camouflage or TCP/UDP).\n\n### Alternate Usage: Use as a GitHub Action in Your Own Workflow\n\nInstead of forking, you can also use this as an Action directly in your own workflows:\n\n```yaml\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Deploy Droplet\n        uses: marksowell/DigitalOcean-Droplet-Deploy-Shadowsocks@v1\n        with:\n          domain: example.com\n          subdomain: app\n          hostname: app-server\n          password: shadowsockspassword\n        env:\n          DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}\n          DIGITALOCEAN_SSH_KEY_ID: ${{ secrets.DIGITALOCEAN_SSH_KEY_ID }}\n```\n\n### 4. Connect Client\n\nExample client config (TLS):\n\n```json\n{\n  \"server\": \"ss.example.com\",\n  \"server_port\": 443,\n  \"password\": \"shadowsockspassword\",\n  \"method\": \"chacha20-ietf-poly1305\",\n  \"plugin\": \"v2ray-plugin\",\n  \"plugin_opts\": \"tls;host=ss.example.com\",\n  \"local_address\": \"127.0.0.1\",\n  \"local_port\": 9053\n}\n```\n\nExample client config (TCP/UDP):\n\n```json\n{\n  \"server\": \"ss.example.com\",\n  \"server_port\": 443,\n  \"password\": \"shadowsockspassword\",\n  \"method\": \"chacha20-ietf-poly1305\",\n  \"mode\": \"tcp_and_udp\",\n  \"local_address\": \"127.0.0.1\",\n  \"local_port\": 9053\n}\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksowell%2Fdigitalocean-droplet-deploy-shadowsocks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarksowell%2Fdigitalocean-droplet-deploy-shadowsocks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksowell%2Fdigitalocean-droplet-deploy-shadowsocks/lists"}