blob: ecda3e0100c8ee7b197cc5b30f9d5ec0b1a9c0c3 (
plain) (
blame)
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
.TH KITTYBOX 1 "" https://kittybox.fireburn.ru/
.SH NAME
kittybox \- a CMS using IndieWeb technologies
.SH SYNOPSIS
.SY kittybox
.YS
.SH DESCRIPTION
.P
.B kittybox
is a full-featured CMS for a personal website which is able to use various
storage backends to store website content.
It is most suitable for a personal blog, though it probably is capable of being
used for other purposes.
.SH ENVIRONMENT
.PP
.I $BACKEND_URI
.RS 4
The URI of the main storage backend to use. Available backends are:
.TP
.EX
.B "postgres://<connection URI>"
.EE
Store website content in a Postgres database. Takes a connection URI.
.TP
.EX
.B "file://<path to a folder>"
.EE
Store website content in a folder on the local filesystem.
.B NOTE:
This backend is not actively maintained and may not work as expected.
It does not implement some advanced features and will probably not receive
updates often.
.RE
.PP
.I $AUTHSTORE_URI
.RS 4
The URI of the authentication backend to use.
This backend is responsible for storing access tokens and short-lived
authorization codes.
Available backends are:
.TP
.EX
.B "file://<path to a folder>"
.EE
Store authentication data in a folder on the filesystem.
.RE
.PP
.I $BLOBSTORE_URI
.RS 4
The URI of the media store backend to use.
This backend manages file uploads and storage of post attachments.
Available backends are:
.TP
.EX
.B "file://<path to a folder>"
.EE
Store file uploads in a content-addressed storage based on a folder. File
contents are hashed using SHA-256, and the hash is used to construct the path.
A small piece of metadata is stored next to the file in JSON format.
.RE
.PP
.I $JOB_QUEUE_URI
.RS 4
The URI of the job queue backend to use.
This backend is responsible for some background tasks, like receiving and
validating Webmentions.
Available backends are:
.TP 4
.EX
.B "postgres://<connection URI>"
.EE
Use PostgreSQL as a job queue.
This works better than one would expect.
.RE
.PP
.I $COOKIE_KEY
.RS 4
A key for signing session cookies.
This needs to be kept secret.
.RE
.SH STANDARDS
Aaron Parecki, W3C,
.UR https://www.w3.org/TR/micropub/
.I Micropub
.UE ","
23 May 2017. W3C Recommendation.
Aaron Parecki, IndieWeb community,
.UR https://indieauth.spec.indieweb.org
.I IndieAuth
.UE ","
11 July 2024. Living Standard.
.SH SEE ALSO
.MR postgres 1
|
