{"id":28399323,"url":"https://github.com/rajsinghtech/tsflow","last_synced_at":"2026-02-22T21:56:00.481Z","repository":{"id":296572162,"uuid":"993696959","full_name":"rajsinghtech/tsflow","owner":"rajsinghtech","description":" Network flow visualizer for Tailscale","archived":false,"fork":false,"pushed_at":"2025-06-16T19:52:20.000Z","size":50880,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-16T20:41:41.791Z","etag":null,"topics":["tailscale"],"latest_commit_sha":null,"homepage":"https://tsflow.rajsingh.info","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rajsinghtech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2025-05-31T10:21:06.000Z","updated_at":"2025-06-16T19:52:24.000Z","dependencies_parsed_at":"2025-06-16T20:31:21.404Z","dependency_job_id":"93bc3d82-e127-4644-84c7-b47cd8fed826","html_url":"https://github.com/rajsinghtech/tsflow","commit_stats":null,"previous_names":["rajsinghtech/tsflow"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/rajsinghtech/tsflow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajsinghtech%2Ftsflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajsinghtech%2Ftsflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajsinghtech%2Ftsflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajsinghtech%2Ftsflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rajsinghtech","download_url":"https://codeload.github.com/rajsinghtech/tsflow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajsinghtech%2Ftsflow/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262484051,"owners_count":23318386,"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":["tailscale"],"created_at":"2025-06-01T08:00:29.358Z","updated_at":"2026-02-06T08:06:52.088Z","avatar_url":"https://github.com/rajsinghtech.png","language":"TypeScript","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# TSFlow - Tailscale Network Flow Visualizer\n\nA real-time network traffic visualization dashboard for Tailscale networks. Monitor device connectivity, analyze bandwidth usage, and explore network flows with an interactive graph interface.\n\n## Installation\n\n### Homebrew (macOS/Linux)\n\n```bash\nbrew install rajsinghtech/tap/tsflow\n```\n\n### Docker\n\n```bash\ndocker pull ghcr.io/rajsinghtech/tsflow:latest\n```\n\n### Binary Download\n\nDownload from [GitHub Releases](https://github.com/rajsinghtech/tsflow/releases).\n\n## Quick Start\n\n\u003e **Note:** TSFlow requires **Tailscale Network Flow Logs** (Premium/Enterprise plans). Enable it in your [Tailscale admin console](https://login.tailscale.com/admin/logs).\n\n### Run with Homebrew\n\n```bash\nexport TAILSCALE_OAUTH_CLIENT_ID=your-client-id\nexport TAILSCALE_OAUTH_CLIENT_SECRET=your-client-secret\ntsflow\n```\n\nOpen `http://localhost:8080`\n\n### Run with Docker\n\n```bash\ndocker run -d \\\n  --name tsflow \\\n  -p 8080:8080 \\\n  -v tsflow_data:/app/data \\\n  -e TAILSCALE_OAUTH_CLIENT_ID=your-client-id \\\n  -e TAILSCALE_OAUTH_CLIENT_SECRET=your-client-secret \\\n  ghcr.io/rajsinghtech/tsflow:latest\n```\n\n## Configuration\n\n### Authentication\n\nTSFlow supports OAuth (recommended) or API key authentication.\n\n**OAuth Setup:**\n1. Go to [OAuth clients](https://login.tailscale.com/admin/settings/oauth) in Tailscale Admin\n2. Create a new OAuth client with `all:read` scope\n3. Set `TAILSCALE_OAUTH_CLIENT_ID` and `TAILSCALE_OAUTH_CLIENT_SECRET`\n\n**API Key Setup:**\n1. Go to [API keys](https://login.tailscale.com/admin/settings/keys) in Tailscale Admin\n2. Create a new API key\n3. Set `TAILSCALE_API_KEY`\n\n### Environment Variables\n\n#### Tailscale Authentication\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `TAILSCALE_OAUTH_CLIENT_ID` | OAuth client ID | - |\n| `TAILSCALE_OAUTH_CLIENT_SECRET` | OAuth client secret | - |\n| `TAILSCALE_OAUTH_SCOPES` | OAuth scopes (comma-separated) | `all:read` |\n| `TAILSCALE_API_KEY` | API key (alternative to OAuth) | - |\n| `TAILSCALE_TAILNET` | Tailnet name (`-` for auto-detect) | `-` |\n| `TAILSCALE_API_URL` | API endpoint | `https://api.tailscale.com` |\n\n#### Server Settings\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `PORT` | Server port | `8080` |\n| `ENVIRONMENT` | `development` or `production` | `development` |\n\n#### Data Storage \u0026 Polling\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `TSFLOW_DB_PATH` | SQLite database path | `./data/tsflow.db` |\n| `TSFLOW_POLL_INTERVAL` | How often to poll Tailscale API for new logs | `5m` |\n| `TSFLOW_INITIAL_BACKFILL` | How far back to fetch logs on startup | `6h` |\n| `TSFLOW_RETENTION` | How long to keep flow logs | `168h` (7 days) |\n\n### Data Storage\n\nTSFlow stores flow logs in SQLite with:\n- **7-day retention** for raw flow logs (configurable via `TSFLOW_RETENTION`)\n\nMount a volume to persist data: `-v tsflow_data:/app/data`\n\n## Development\n\n### Setup\n\n```bash\ngit clone https://github.com/rajsinghtech/tsflow.git\ncd tsflow\n\n# Install dependencies\ncd frontend \u0026\u0026 npm install \u0026\u0026 cd ..\ncd backend \u0026\u0026 go mod download \u0026\u0026 cd ..\n```\n\n### Development Mode\n\nRun backend and frontend separately for hot reload:\n\n```bash\n# Terminal 1: Backend (no embedded frontend)\nmake dev-backend\n\n# Terminal 2: Frontend with Vite dev server\nmake dev-frontend\n```\n\nFrontend runs on `http://localhost:5173` and proxies `/api` to backend on `:8080`.\n\n### Production Build\n\n```bash\nmake build\n./backend/tsflow\n```\n\nThis builds the SvelteKit frontend and embeds it in the Go binary.\n\n## Deployment\n\n### Docker Compose\n\n```yaml\nservices:\n  tsflow:\n    image: ghcr.io/rajsinghtech/tsflow:latest\n    ports:\n      - \"8080:8080\"\n    environment:\n      - TAILSCALE_OAUTH_CLIENT_ID=${TAILSCALE_OAUTH_CLIENT_ID}\n      - TAILSCALE_OAUTH_CLIENT_SECRET=${TAILSCALE_OAUTH_CLIENT_SECRET}\n    volumes:\n      - tsflow_data:/app/data\n    restart: unless-stopped\n\nvolumes:\n  tsflow_data:\n```\n\n### Kubernetes\n\n```bash\ncd k8s\n# Edit kustomization.yaml with your credentials\nkubectl apply -k .\n```\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=rajsinghtech/tsflow\u0026type=Date)](https://star-history.com/#rajsinghtech/tsflow\u0026Date)\n\n## License\n\nMIT\n\n---\n\nBuilt with ❤️ for the Tailscale community\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajsinghtech%2Ftsflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frajsinghtech%2Ftsflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajsinghtech%2Ftsflow/lists"}