summaryrefslogtreecommitdiffhomepage
path: root/tsnet/example/tsnet-services/README.md
blob: 18bc072d782f60447313b474926e775703cc435e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<!-- README.md auto-generated by misc/genreadme; DO NOT EDIT. (or remove this line) -->

# tsnet-services

The tsnet-services example demonstrates how to use tsnet with Services.

To run this example yourself:

 1. Add access controls which (i) define a new ACL tag, (ii) allow the demo node to host the Service, and (iii) allow peers on the tailnet to reach the Service. A sample ACL policy is provided below.
 2. [Generate an auth key](https://tailscale.com/kb/1085/auth-keys#generate-an-auth-key) using the Tailscale admin panel. When doing so, add your new tag to your key (Service hosts must be tagged nodes).
 3. [Define a Service](https://tailscale.com/kb/1552/tailscale-services#step-1-define-a-tailscale-service). For the purposes of this demo, it must be defined to listen on TCP port 443. Note that you only need to follow Step 1 in the linked document.
 4. Run the demo on the command line (step 4 command shown below).

Command for step 4:

	TS_AUTHKEY=<yourkey> go run tsnet-services.go -service <service-name>

The following is a sample ACL policy for step 1:

	"tagOwners": {
	   "tag:tsnet-demo-host": ["autogroup:member"],
	},
	"autoApprovers": {
	   "services": {
	      "svc:tsnet-demo": ["tag:tsnet-demo-host"],
	   },
	},
	"grants": [
	   "src": ["*"],
	   "dst": ["svc:tsnet-demo"],
	   "ip": ["*"],
	],