dunkirk.sh
rss email digests over ssh because you're a cool kid
herald.dunkirk.sh
go
rss
rss-reader
ssh
charm
docs: add more info on commands
+18
-1
+13
-1
README.md
+13
-1
README.md
···
43
43
### SSH Commands
44
44
45
45
```bash
46
+
# Get your fingerprint (for web dashboard)
47
+
ssh herald.dunkirk.sh
48
+
46
49
# List your configs
47
50
ssh herald.dunkirk.sh ls
48
51
···
51
54
52
55
# Delete a config
53
56
ssh herald.dunkirk.sh rm feeds.txt
57
+
58
+
# Activate/deactivate configs
59
+
ssh herald.dunkirk.sh activate feeds.txt
60
+
ssh herald.dunkirk.sh deactivate feeds.txt
54
61
55
62
# Run immediately (don't wait for cron)
56
63
ssh herald.dunkirk.sh run feeds.txt
···
61
68
62
69
### Web Interface
63
70
64
-
Visit `http://localhost:8080` for the landing page, or `http://localhost:8080/{fingerprint}` for your user page with aggregated RSS/JSON feeds.
71
+
Visit `http://localhost:8080` for the landing page.
72
+
73
+
After uploading a config, run `ssh herald.dunkirk.sh` to get your fingerprint, then visit:
74
+
- `http://localhost:8080/{fingerprint}` - Your dashboard with config status
75
+
- `http://localhost:8080/{fingerprint}/feeds.xml` - RSS feed for feeds.txt
76
+
- `http://localhost:8080/{fingerprint}/feeds.json` - JSON feed for feeds.txt
65
77
66
78
## Config Format
67
79
+5
web/templates/index.html
+5
web/templates/index.html
···
31
31
# Upload a config
32
32
scp {{if ne .SSHPort 22}}-P {{.SSHPort}} {{end}}feeds.txt herald@{{.SSHHost}}:
33
33
34
+
# Get your fingerprint (for web dashboard)
35
+
# Your dashboard will be at:
36
+
# {{.Origin}}/<fingerprint>
37
+
ssh {{if ne .SSHPort 22}}-p {{.SSHPort}} {{end}}herald@{{.SSHHost}}
38
+
34
39
# Check status
35
40
ssh {{if ne .SSHPort 22}}-p {{.SSHPort}} {{end}}herald@{{.SSHHost}} ls
36
41