about summary refs log tree commit diff
path: root/splorm/README.md
blob: 60b779eabec4f6dc3e897af29857d16dcce4ce60 (plain)
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
**splorm**, i wake and breathe  
*(an after-awake)*

## Command Line Arguments
`config=<path>` *or* `c=<path>` **(required)**  
location of configuration file

## Configuration File Variables
`Database` - Location of the database

### Section: `Auth`
`AllowRegistration` - Whether or not registration is enabled

#### Section: `Network`
`Port` - Port to listen on

#### Section: `Serving`
`$` - Webroot splorm tries to serve from  
`Hostname` - Hostname of the website  
`Uploads` - Directory to put uploads  

**Subsection: `Me`**  
`Email` - My email, for the `/.me/email` route

**Subsection: `Opengraph`**  
`DefaultImage` - webroot-relative path to use as the default opengraph image when none is provided
`DefaultImage/Text` - alt text for the default image

**Subsection: `Templates`**  
`$` - Directory templates are located in  
`Default` - Name of the default template *(assumed to end in .html)*

**Subsection: `Wikarden`**  
`$` - Directory wikarden expects to find a git repository for the wiki  
`Index` - Name of the page acting as the index  
`GitName` - Name wikarden issues git commits under  
`GitEmail` - Email wikarden issues git commits under

#### Section: `Connectors`
`Gatherer` - Path to gatherer's unix socket