Skip to content

Commit 788c238

Browse files
committed
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.
1 parent ce960af commit 788c238

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ A modern, real-time web application for visualizing and analyzing network traffi
3838
- SWR for efficient data fetching and caching
3939

4040
## 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.
4142
4243
### Prerequisites
4344
- Tailscale API key with appropriate permissions
@@ -240,7 +241,7 @@ For developers who want to build and run TSFlow locally:
240241
1. Go to the [Tailscale Admin Console](https://login.tailscale.com/admin/settings/keys)
241242
2. Create a new API key with the following permissions:
242243
- `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.
244245
3. Copy the API key to your `.env` file
245246

246247
### Environment Variables

0 commit comments

Comments
 (0)