Skip to content
This repository was archived by the owner on Dec 31, 2025. It is now read-only.

Commit a58bc97

Browse files
Merge pull request #188 from runreveal/docs-tailscale-updates
updating tailscale docs
2 parents c9bf5e3 + 74b704b commit a58bc97

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

  • pages/sources/source-types/tailscale

pages/sources/source-types/tailscale/audit.mdx

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: 'Tailscale Audit Logs'
33
description: 'Tailscale is a VPN service that simplifies secure network connections using a peer-to-peer mesh network. Tailscale audit logs capture information about user and device activity, such as authentication events, access control changes, connection attempts, and traffic flow across the network. These logs are valuable for monitoring network security, tracking who accessed resources, and auditing for compliance with access policies.'
44
---
55

6+
import { Callout } from 'nextra/components'
7+
68
# Tailscale Audit Logs
79

810
Tailscale is a VPN service that simplifies secure network connections using a peer-to-peer mesh network. Tailscale audit logs capture information about user and device activity, such as authentication events, access control changes, connection attempts, and traffic flow across the network. These logs are valuable for monitoring network security, tracking who accessed resources, and auditing for compliance with access policies.
@@ -14,14 +16,35 @@ When first added RunReveal will backfill the last 30 days worth of audit logs.
1416

1517
## Setup
1618

17-
Create a new OAuth Client under your Tailnet settings and provide it the
18-
Audit Logs Read scope.
19+
<Callout type="warning">
20+
**Important:** When setting up your OAuth client, please only enable the read permissions for audit logs. Do not grant any other permissions or the source will fail.
21+
</Callout>
22+
23+
### Step 1: Create an OAuth Client in Tailscale
24+
25+
To set up the Tailscale integration, you need to create an OAuth client in your Tailnet settings. For detailed instructions, see the [Tailscale OAuth client documentation](https://tailscale.com/kb/1215/oauth-clients#setting-up-an-oauth-client).
26+
27+
**Brief setup steps:**
28+
29+
1. Log into your Tailscale admin console
30+
2. Navigate to the [Trust credentials page](https://login.tailscale.com/admin/settings/trust-credentials)
31+
3. Click **Create OAuth client**
32+
4. Give your client a descriptive name (e.g., "RunReveal Audit Logs")
33+
5. Select the **Audit Logs Read** scope only
34+
6. Click **Create**
1935

2036
<img style={{maxWidth:"500px"}} src="/tailscale-audit-1.png"/>
2137

38+
### Step 2: Configure RunReveal
39+
40+
Once created, you'll be provided a `Client ID` and a `Client secret`.
2241

23-
Once created, you'll be provided a `Client ID` and a `Client secret`. Paste these
24-
into the RunReveal dashboard, along with the name of your tailnet, and we'll begin
25-
collecting your tailscale logs immediately.
42+
1. In the RunReveal dashboard, enter your **tailnet name** (not the tailnet ID)
43+
- You can find your tailnet name in the General page of the Tailscale admin console
44+
2. Copy both the `Client ID` and `Client secret` from the OAuth client you just created
45+
3. Paste these credentials into the corresponding fields in RunReveal
46+
4. Click **Connect** to begin collecting your Tailscale audit logs
2647

2748
<img style={{maxWidth:"700px"}} src="/tailscale-audit-2.png"/>
49+
50+
RunReveal will begin collecting your Tailscale logs immediately and backfill the last 30 days of audit logs.

0 commit comments

Comments
 (0)