enbas/docs/configuration.md
Dan Anglin 23ec6048b5
docs: updated documentation
- Converted documentation from Asciidoc to Markdown
- Updated the installation instructions and moved to a separate
  file in the docs directory.
- Updated the login instructions and moved to the Getting Started guide
  in the docs directory.
- Updated the licensing information in the main README.
- Created a page for changelog.
- Create a page for the user manual.
2024-07-01 13:49:11 +01:00

2.2 KiB

Configuration reference

Config

Field Type Description
credentialsFile string The (absolute) path to your credentials file.
cacheDirectory string The (absolute) path to the root cache directory.
lineWrapMaxWidth int The character limit used for line wrapping.
http HTTPConfig HTTP settings.
integrations Integrations Specify your integrations with Enbas.

HTTPConfig

Field Type Description
timeout int The timeout (in seconds) for normal HTTP requests to your instance.
mediaTimeout int The timeout (in seconds) for retrieving media from your instance.

Integrations

Field Type Description
browser string The browser used for opening URLs (e.g. URL to a remote account).
editor string The text editor used for writing statuses (not yet implemented).
pager string The pager used for paging through long outputs (e.g. status timelines). Leave blank to disable paging.
imageViewer string The image viewer used for viewing images from media attachments.
videoPlayer string The video player used for viewing videos from media attachments.