feat(docs): start configuration page

docs/content/docs/configuration.md

@@ -0,0 +1,36 @@
+# Configuration
+
+All configuration variables can be provided either through the configuration
+file, as environment variables or using CLI flags. All environment variable
+names are derived from their place in the TOML file, prepended with `OTTER_`.
+
+Variables are grouped by their section in the configuration file, e.g. the
+variables under the `net` section should be placed inside the `[net]` group in
+the TOML file.
+
+## Top-level settings
+
+* `data_dir` (`OTTER_DATA_DIR`): directory where Otter stores its data. This
+  directory must exist and be accessible by the server when starting up.
+    * Default: `./data`
+* `session_cleanup_interval` (`OTTER_SESSION_CLEANUP_INTERVAL`): how frequently
+  (in seconds) the session cleanup background job should be run. This job
+  removes expired user sessions from the database.
+    * Default: `86400` (once a day)
+* `log_level` (`OTTER_LOG_LEVEL`): how verbose the logging should be; one of
+  `debug`, `info`, `warn` or `error`
+    * Default: `warn`
+
+## Network (`net`)
+
+* `type` (`OTTER_NET_TYPE`): type of network connection to establish; one of
+  `tcp`, `unix`
+    * Default: `tcp`
+* `domain` (`OTTER_NET_DOMAIN`): domain to bind TCP socket to; only applicable
+  when `net.type` is `tcp`.
+    * Default: `127.0.0.1`
+* `port` (`OTTER_NET_PORT`): port to bind TCP socket to; only applicable when
+  `net.type` is `tcp`.
+    * Default: `8080`
+* `path` (`OTTER_NET_PATH`): path to bind Unix socket to; only applicable when
+  `net.type` is `unix`.

docs/hugo.toml

@@ -3,5 +3,92 @@ languageCode = 'en-us'
 title = 'Otter'
 theme = "hugo-book"
 
+# Book configuration
+disablePathToLower = true
+enableGitInfo = true
+
 [markup.goldmark.renderer]
 unsafe = true
+
+[markup.tableOfContents]
+  startLevel = 1
+
+[menu]
+[[menu.after]]
+  name = "Source"
+  url = "https://git.rustybever.be/Chewing_Bever/otter"
+  weight = 10
+
+[[menu.after]]
+  name = "Devlogs"
+  url = "https://rustybever.be/dev/otter/"
+  weight = 20
+
+[params]
+  # (Optional, default light) Sets color theme: light, dark or auto.
+  # Theme 'auto' switches between dark and light modes based on browser/os preferences
+  BookTheme = 'auto'
+
+  # (Optional, default true) Controls table of contents visibility on right side of pages.
+  # Start and end levels can be controlled with markup.tableOfContents setting.
+  # You can also specify this parameter per page in front matter.
+  BookToC = true
+
+  # (Optional, default favicon.png) Set the path to a favicon file.
+  # If the favicon is /static/favicon.png then the path would be favicon.png
+  # BookFavicon = 'favicon.png'
+
+  # (Optional, default none) Set the path to a logo for the book.
+  # If the logo is /static/logo.png then the path would be logo.png
+  # BookLogo = 'logo.png'
+
+  # (Optional, default docs) Specify root page to render child pages as menu.
+  # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
+  # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
+  BookSection = 'docs'
+
+  # Set source repository location.
+  # Used for 'Last Modified' and 'Edit this page' links.
+  BookRepo = 'https://github.com/alex-shpak/hugo-book'
+
+  # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
+  # commit hash for 'doc' page type.
+  # Requires 'BookRepo' param.
+  # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
+  # Github uses 'commit', Bitbucket uses 'commits'
+  # BookCommitPath = 'commit'
+
+  # Enable "Edit this page" links for 'doc' page type.
+  # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
+  # Edit path must point to root directory of repo.
+  # BookEditPath = 'edit/main/exampleSite'
+
+  # Configure the date format used on the pages
+  # - In git information
+  # - In blog posts
+  BookDateFormat = 'January 2, 2006'
+
+  # (Optional, default true) Enables search function with flexsearch,
+  # Index is built on fly, therefore it might slowdown your website.
+  # Configuration for indexing can be adjusted in i18n folder per language.
+  BookSearch = true
+
+  # (Optional, default true) Enables comments template on pages
+  # By default partals/docs/comments.html includes Disqus template
+  # See https://gohugo.io/content-management/comments/#configure-disqus
+  # Can be overwritten by same param in page frontmatter
+  # BookComments = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
+  # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
+  # Theme will print warning if page referenced in markdown does not exists.
+  # BookPortableLinks = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
+  # BookServiceWorker = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
+  # BookTranslatedOnly = false