You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README to clarify requirements for TSFlow: add note about the necessity of Premium or Enterprise plans for Tailscale Network Flow Logs feature and specify API key permissions needed for accessing network flow logs.
Copy file name to clipboardExpand all lines: README.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,7 @@ A modern, real-time web application for visualizing and analyzing network traffi
38
38
- SWR for efficient data fetching and caching
39
39
40
40
## Quick Start
41
+
> **Important:** TSFlow requires the **Tailscale Network Flow Logs** feature, which is available on **Premium** and **Enterprise** plans. The application will not show any flow data on other plans.
41
42
42
43
### Prerequisites
43
44
- Tailscale API key with appropriate permissions
@@ -240,7 +241,7 @@ For developers who want to build and run TSFlow locally:
240
241
1. Go to the [Tailscale Admin Console](https://login.tailscale.com/admin/settings/keys)
241
242
2. Create a new API key with the following permissions:
242
243
-`devices:read` - To fetch device information
243
-
-`logs:read` - To access network flow logs
244
+
-`logs:read` - To access network flow logs. **Note**: This requires a **Premium** or **Enterprise** plan.
0 commit comments