]> git.armaanb.net Git - bin.git/blob - man/scoop-cgi.1.scd
e3b6ee0487e0048eab9f6da6bcf1ceb13568110a
[bin.git] / man / scoop-cgi.1.scd
1 scoop-cgi(1)
2
3 # NAME
4 scoop-cgi - run scoop as a cgi script
5
6 # SYNOPSIS
7 Run with your favorite web server
8
9 # DESCRIPTION
10 june's scooper is a great, full-featured web interface to litterbox, however it
11 is relatively complex. The plaintext output of scoop is good enough for me. This
12 script just makes it accesible via the web. Requires scoop and litterbox.
13
14 # URL SCHEME
15 */*
16         Home page
17
18 */channel*
19         Logs from channel from today
20
21 */channel/date*
22         Logs from channel from specified date. The date is passed through the date
23         command so on systems running the GNU coreutils, keywords like "last-thursday"
24         will work, however for portability, using ISO8601 (YYYY-MM-DD) is safest.
25
26 # CONFIGURATION
27 There are two config files that go in /etc/scoop-cgi/channels, and
28 /etc/scoop-cgi/database. The channels file has a list of channels for which
29 public logging is enabled, and the database file has the path to the litterbox
30 database file.
31
32 # DRAWBACKS
33 - No built-in search functionality. Combine with YaCy or scoot for a searching
34   solution.
35 - Only supports a single database at a time
36 - Homepage text is hard coded
37
38 # SEE ALSO
39 scoop(1), litterbox(1)
40
41 # COPYRIGHT
42 This is free and unencumbered software released into the public domain. For more
43 information, please refer to <https://unlicense.org/>.