simon/smeagol
1
0
Fork 0
mirror of https://github.com/journeyman-cc/smeagol.git synced 2026-04-13 02:05:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Bringing documentation up to date with version 1.0.0

Simon Brooke 2017-09-12 17:23:12 +01:00
parent 6444e96f3e
commit e955596945
1 changed files with 25 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

37
Configuration.md

@ -2,19 +2,32 @@ Smeagol reads a configuration file, whose content should be formatted as a cloju
The default content is as follows: The default content is as follows:
{ ```
:site-title "Smeagol" ;; overall title of the site, used in page headings {
:default-locale "en-GB" ;; default language used for messages :site-title "Smeagol" ;; overall title of the site, used in page headings
:formatters {"vega" smeagol.formatting/process-vega :default-locale "en-GB" ;; default language used for messages
"vis" smeagol.formatting/process-vega :content-dir "/usr/local/etc/content"
"mermaid" smeagol.formatting/process-mermaid ;; where content is served from
"backticks" smeagol.formatting/process-backticks} :passwd "/usr/local/etc/passwd"
} ;; where the password file is stored
:log-level :info ;; the minimum logging level; one of
;; :trace :debug :info :warn :error :fatal
:formatters {"vega" smeagol.formatting/process-vega
"vis" smeagol.formatting/process-vega
"mermaid" smeagol.formatting/process-mermaid
"backticks" smeagol.formatting/process-backticks}
}
```
The three keys given above should be present. The values should be: The values should be:
* **:site-title** The title for your wiki * `:content-dir` The directory in which your editable content is stored;
* **:default-locale** A string comprising a lower-case [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code specifying a language, optionally followed by a hyphen and an upper-case [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) specifying a country. * `:default-locale` A string comprising a lower-case [ISO 639](https://en.wikipedia.org/wiki/ISO_639) code specifying a language, optionally followed by a hyphen and an upper-case [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) specifying a country.
* **:formatters** A map of formatters used in [[Extensible Markup]], q.v. * `:formatters` A map of formatters used in [[Extensible Markup]], q.v.
* `:log-level` The minimum level of log messages to be logged; one of `:trace :debug :info :warn :error :fatal`
* `:passwd` The path to your `passwd` file - see [[Security and authentication]];
* `:site-title` The title for your wiki.
The default file is at `resources/config.edn`; this default can be overridden by providing an environment variable, `SMEAGOL_CONFIG`, whose value is the full or relative pathname of a suitable file. The default file is at `resources/config.edn`; this default can be overridden by providing an environment variable, `SMEAGOL_CONFIG`, whose value is the full or relative pathname of a suitable file.
Note that all the values in the configuration can be overridden with [[Environment Variables]].