Skip to content

Commit d6512cc

Browse files
committed
chore: add appjail director support & regen docs
1 parent 921fd71 commit d6512cc

3 files changed

Lines changed: 71 additions & 11 deletions

File tree

Containerfile.pkg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ARG UPSTREAM_JQ=".tag_name"
1414

1515
# --- Metadata (Injected by Generator) ---
1616
LABEL org.opencontainers.image.title="Tailscale" \
17-
org.opencontainers.image.description="Tailscale mesh VPN on FreeBSD." \
17+
org.opencontainers.image.description="Zero-config mesh VPN built on WireGuard — securely connect your devices without port forwarding or firewall changes." \
1818
org.opencontainers.image.source="https://github.com/daemonless/tailscale" \
1919
org.opencontainers.image.url="https://tailscale.com/" \
2020
org.opencontainers.image.documentation="https://tailscale.com/kb/" \

README.md

Lines changed: 67 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,28 @@ Source: dbuild templates
55

66
# Tailscale
77

8-
Tailscale mesh VPN on FreeBSD.
8+
[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/tailscale/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/tailscale/actions)
9+
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/tailscale?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/tailscale/commits)
10+
11+
Zero-config mesh VPN built on WireGuard — securely connect your devices without port forwarding or firewall changes.
912

1013
| | |
1114
|---|---|
1215
| **Registry** | `ghcr.io/daemonless/tailscale` |
13-
| **Docs** | [daemonless.io/images/tailscale](https://daemonless.io/images/tailscale/) |
1416
| **Source** | [https://github.com/tailscale/tailscale](https://github.com/tailscale/tailscale) |
1517
| **Website** | [https://tailscale.com/](https://tailscale.com/) |
1618

19+
## Version Tags
20+
21+
| Tag | Description | Best For |
22+
| :--- | :--- | :--- |
23+
| `latest` / `pkg` | **FreeBSD Quarterly**. Uses stable, tested packages. | Most users. Matches Linux Docker behavior. |
24+
| `pkg-latest` | **FreeBSD Latest**. Rolling package updates. | Newest FreeBSD packages. |
25+
26+
## Prerequisites
27+
28+
Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.
29+
1730
## Deployment
1831

1932
### Podman Compose
@@ -27,10 +40,52 @@ services:
2740
- TS_AUTHKEY=tskey-auth-xxxx
2841
- TS_EXTRA_ARGS=--advertise-exit-node
2942
volumes:
30-
- /path/to/containers/tailscale:/config
43+
- "/path/to/containers/tailscale:/config"
3144
restart: unless-stopped
3245
```
3346
47+
### AppJail Director
48+
49+
**.env**:
50+
51+
```
52+
DIRECTOR_PROJECT=tailscale
53+
TS_AUTHKEY=tskey-auth-xxxx
54+
TS_EXTRA_ARGS=--advertise-exit-node
55+
```
56+
57+
**appjail-director.yml**:
58+
59+
```yaml
60+
options:
61+
- virtualnet: ':<random> default'
62+
- nat:
63+
services:
64+
tailscale:
65+
name: tailscale
66+
options:
67+
- container: 'boot args:--pull'
68+
oci:
69+
user: root
70+
environment:
71+
- TS_AUTHKEY: !ENV '${TS_AUTHKEY}'
72+
- TS_EXTRA_ARGS: !ENV '${TS_EXTRA_ARGS}'
73+
volumes:
74+
- tailscale: /config
75+
volumes:
76+
tailscale:
77+
device: '/path/to/containers/tailscale'
78+
```
79+
80+
**Makejail**:
81+
82+
```
83+
ARG tag=latest
84+
85+
OPTION overwrite=force
86+
OPTION from=ghcr.io/daemonless/tailscale:${tag}
87+
```
88+
3489
### Podman CLI
3590

3691
```bash
@@ -57,21 +112,25 @@ podman run -d --name tailscale \
57112
- "/path/to/containers/tailscale:/config"
58113
```
59114
60-
## Configuration
115+
## Parameters
116+
61117
### Environment Variables
62118
63119
| Variable | Default | Description |
64120
|----------|---------|-------------|
65121
| `TS_AUTHKEY` | `tskey-auth-xxxx` | Optional: Tailscale Auth Key for automatic login |
66122
| `TS_EXTRA_ARGS` | `--advertise-exit-node` | Optional: Additional arguments for tailscale up |
123+
67124
### Volumes
68125

69126
| Path | Description |
70127
|------|-------------|
71128
| `/config` | State directory (tailscaled.state) |
72129

73-
## Notes
130+
**Architectures:** amd64
131+
**User:** `root` (UID/GID via PUID/PGID, defaults to 1000:1000)
132+
**Base:** FreeBSD 15.0
133+
134+
---
74135

75-
- **Architectures:** amd64
76-
- **User:** `root` (UID/GID set via PUID/PGID)
77-
- **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD)
136+
Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.

compose.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ x-daemonless:
44
title: "Tailscale"
55
icon: ":simple-tailscale:"
66
category: "Infrastructure"
7-
description: "Tailscale mesh VPN on FreeBSD."
7+
description: "Zero-config mesh VPN built on WireGuard — securely connect your devices without port forwarding or firewall changes."
88
upstream_url: "https://github.com/tailscale/tailscale"
99
web_url: "https://tailscale.com/"
1010
freshports_url: "https://www.freshports.org/security/tailscale/"
1111
user: "root"
1212
mlock: false
1313
upstream_binary: false
14-
14+
appjail: true
15+
1516
docs:
1617
env:
1718
TS_AUTHKEY: "Optional: Tailscale Auth Key for automatic login"

0 commit comments

Comments
 (0)