{"id":18708098,"url":"https://github.com/threecommaio/circleci-tailscale","last_synced_at":"2025-11-09T09:30:35.453Z","repository":{"id":39849757,"uuid":"404853151","full_name":"threecommaio/circleci-tailscale","owner":"threecommaio","description":"CircleCI Orb for Tailscale","archived":false,"fork":false,"pushed_at":"2022-08-23T07:54:34.000Z","size":18,"stargazers_count":4,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-28T07:26:36.435Z","etag":null,"topics":["circleci","tailscale"],"latest_commit_sha":null,"homepage":null,"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/threecommaio.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":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2021-09-09T19:56:40.000Z","updated_at":"2023-10-05T00:08:20.000Z","dependencies_parsed_at":"2022-09-05T10:11:47.140Z","dependency_job_id":null,"html_url":"https://github.com/threecommaio/circleci-tailscale","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threecommaio%2Fcircleci-tailscale","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threecommaio%2Fcircleci-tailscale/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threecommaio%2Fcircleci-tailscale/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threecommaio%2Fcircleci-tailscale/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/threecommaio","download_url":"https://codeload.github.com/threecommaio/circleci-tailscale/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239571586,"owners_count":19661165,"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","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":["circleci","tailscale"],"created_at":"2024-11-07T12:21:36.023Z","updated_at":"2025-11-09T09:30:35.375Z","avatar_url":"https://github.com/threecommaio.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# CircleCI Orb for using Tailscale\n\nOrb: https://circleci.com/developer/orbs/orb/threecomma/circleci-tailscale\n\n## Quick Start Guide\n\nUse CircleCI version 2.1 at the top of your `.circleci/config.yml` file.\n\n```\nversion: 2.1\n```\n\nIf you do not already have Pipelines enabled, you'll need to go to Project Settings -\u003e Advanced Settings and turn it on.\n\nAdd the orbs stanza below your version, invoking the orb:\n\n```\norbs:\n  circleci-tailscale: threecomma/circleci-tailscale@2.2.0\n```\n\n1. Goto the [Tailscale Admin Console](https://login.tailscale.com/admin/settings/authkeys) and create a new `Auth Key`. Select `Ephemeral Key`\n\n2. Create an environment variable in your project: `TAILSCALE_AUTH_KEY` and paste the new key you created.\n\n3. The orb automatically exposes environment variables: `[http_proxy,https_proxy,ALL_PROXY,HTTP_PROXY,HTTPS_PROXY]` that populates to `socks5h://localhost:1055/`.\n\nThis makes it compatible with various applications like `curl` that respect these environment variables to proxy through a socks5 proxy.\n\n\u003e The reason we use `socks5h` is to force DNS resolution through the socks5 proxy that is setup with Tailscale.\n\n## Sample workflow in CircleCI\n\nHere is a sample `.circleci/config.yml`\nIf you would like to change the tailscale version you can set the parameter `tailscale-version`.\n\n```yaml\nversion: 2.1\n\norbs:\n  circleci-tailscale: threecomma/circleci-tailscale@2.2.0\n\njobs:\n  build:\n    docker:\n      - image: circleci/node:fermium-stretch\n    parameters:\n      tailscale-auth-key:\n        type: env_var_name\n        default: TAILSCALE_AUTH_KEY\n      tailscale-proxy-address:\n        type: string\n        default: localhost\n    steps:\n      - checkout\n      - circleci-tailscale/connect\n      - run:\n          name: curl a tailscale machine over port 8080\n          command: |\n            until curl \"http://[machine].[namespace].beta.tailscale.net:8080/\"\n            do\n             sleep 1\n            done\n```\n\n## Parameters\n\n| Parameter               | Description                                              | Default Value |\n| ----------------------- | -------------------------------------------------------- | ------------- |\n| tailscale-auth-key      | Your Tailscale authentication key, from the admin panel. |               |\n| tailscale-proxy-address | Proxy address where tailscale should listen.             | localhost     |\n| tailscale-version       | Tailscale version to use.                                | 1.20.4        |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthreecommaio%2Fcircleci-tailscale","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthreecommaio%2Fcircleci-tailscale","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthreecommaio%2Fcircleci-tailscale/lists"}