Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yukaii/tailportal
Create tailscale exit node on cloud with simple commands
https://github.com/yukaii/tailportal
exit-node exitnode oclif pulumi pulumi-automation-sdk tailscale typescript
Last synced: about 2 months ago
JSON representation
Create tailscale exit node on cloud with simple commands
- Host: GitHub
- URL: https://github.com/yukaii/tailportal
- Owner: Yukaii
- License: mit
- Created: 2024-04-27T04:03:15.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-03T11:24:11.000Z (8 months ago)
- Last Synced: 2024-05-03T15:30:49.625Z (8 months ago)
- Topics: exit-node, exitnode, oclif, pulumi, pulumi-automation-sdk, tailscale, typescript
- Language: TypeScript
- Homepage:
- Size: 479 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tailportal
Create a Tailscale exit node with simple commands.
Bring your own key and pay your own bill, then let me do the rest.
## Usage
### Step 0: Install and setup pulumi CLI
link
### Step 1: Configuring your Tailnet
Add the following ACL changes:
```json
"tagOwners": {
"tag:tailportal": ["autogroup:admin"],
},
"autoApprovers": {
"exitNode": ["tag:tailportal"],
},
// Add ssh if you want to do more with the exit node
"ssh": [
{
"action": "accept",
// !!IMPORTANT Change this
"src": ["username@GitHub"],
"dst": ["tag:tailportal"],
"users": ["autogroup:nonroot", "root"],
},
]
```
2. Create tailscale authkey
### Step 2: Config Cloud Providers API
TBD: Vultr/Digital Ocean/AWS
### Step 3: Clone project and fill in `.env`
I'll provide better config management in the future.
```bash
VULTR_API_KEY=
PULUMI_CONFIG_PASSPHRASE=
TS_AUTH_KEY=
```
### Step 4: Run
```bash
git clone https://github.com/Yukaii/tailportal
pnpm install
pnpm start
pnpm start list
pnpm start create
pnpm start remov instance-name
pnpm start destroy
```
## TODOs
- [ ] instance management: status, shutdown...
- [ ] simple TUI
## Appendix A: Startup times (for reference only)
| Provider | Startup time (seconds) |
| -------- | ---------------------- |
| vultr | 70 secs |
| gcp | ~40 secs |
CLI draft
## CLI draft
WIP WIP WIP
### General Options
- `-h, --help` : Show help and exit
- `-v, --version` : Show version and exit
### Commands
#### `up`
- Create and configure a new Tailportal instance
- Options:
- `provider` : Specify the cloud provider (e.g. AWS, GCP, DigitalOcean)
- `location` : Specify the location of the instance (e.g. us-west-2, europe-west1)
- `authkey` : Specify the Tailscale AuthKey (optional, will prompt if not provided)
#### `down`
- Destroy the current Tailportal instance
#### `list`
- List all available instances
#### `status`
- Show the status of the current instance
#### `regions`
- List available regions for each provider
- Options:
- `--provider` : Specify the cloud provider (e.g. AWS, GCP, DigitalOcean)
- `--detail` : Show detailed information about each region (e.g. availability zones, instance types)
#### `providers`
- List available cloud providers
- Options:
- `--detail` : Show detailed information about each provider (e.g. supported regions, instance types)
### Example Usage
- `tailportal up --provider=aws --location=us-west-2` : Create a new instance on AWS in us-west-2
- `tailportal down` : Destroy the current instance
- `tailportal list` : List all available instances
- `tailportal status` : Show the status of the current instance
- `tailportal regions` : List available regions for all providers
- `tailportal regions --provider=aws` : List available regions for AWS
- `tailportal regions --provider=aws --detail` : Show detailed information about each AWS region
- `tailportal providers` : List available cloud providers
- `tailportal providers --detail` : Show detailed information about each provider (e.g. supported regions, instance types)
## License
MIT