this repo has no description
athome: update README
+54
+54
cmd/athome/README.md
+54
cmd/athome/README.md
···
12
12
2. point one or more handle domains to it (CNAME or reverse proxy)
13
13
3. serves up profile and feed for that account only
14
14
4. fetches data from public bsky app view API
15
+
16
+
17
+
## Running athome
18
+
19
+
The recommended way to run `athome` is behind a `caddy` HTTPS server which does automatic on-demand SSL certificate registration (using Let's Encrypt).
20
+
21
+
Build and run `athome`:
22
+
23
+
go build ./cmd/athome
24
+
25
+
# will listen on :8200 by default
26
+
./athome serve
27
+
28
+
Create a `Caddyfile`:
29
+
30
+
```
31
+
{
32
+
on_demand_tls {
33
+
interval 1h
34
+
burst 8
35
+
}
36
+
}
37
+
38
+
:443 {
39
+
reverse_proxy localhost:8200
40
+
tls YOUREMAIL@example.com {
41
+
on_demand
42
+
}
43
+
}
44
+
```
45
+
46
+
Run `caddy`:
47
+
48
+
caddy run
49
+
50
+
51
+
## Configuring a Handle
52
+
53
+
The easiest way, if there is no existing web service on the handle domain, is to get the handle resolution working with the DNS TXT record option, then point the domain itself to a `athome` service using an A/AAAA or CNAME record.
54
+
55
+
If there is an existing web service (eg, a blog), then handle resolution can be set up using either the DNS TXT mechanism or HTTP `/.well-known/` mechanism. Then HTTP proxy paths starting `/bsky` to an `athome` service.
56
+
57
+
Here is an nginx config snippet demonstrating HTTP proxying:
58
+
59
+
```
60
+
location /bsky {
61
+
// in theory https:// should work, on default port?
62
+
proxy_pass http://athome.example.com:8200;
63
+
proxy_set_header X-Real-IP $remote_addr;
64
+
proxy_set_header Host $http_host;
65
+
proxy_set_header X-Forwarded-Proto https;
66
+
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
67
+
}
68
+
```