checkpoint: add config ref page
This commit is contained in:
parent
89264c0a22
commit
737c67b785
4 changed files with 41 additions and 4 deletions
|
@ -23,8 +23,9 @@ the `main` branch mirrored to [Codeberg](https://codeberg.org/dananglin/enbas) a
|
|||
|
||||
### Documentation
|
||||
|
||||
- **[Installation guide](./docs/install.md)**: Follow this link to install Enbas.
|
||||
- **[Getting started guide](./docs/getting_started.md)**: Follow this link to go through the Getting started guide.
|
||||
- **[Installation guide](./docs/install.md)**: A guide for installing Enbas on your machine.
|
||||
- **[Getting started guide](./docs/getting_started.md)**: A guide to help you get started on using Enbas.
|
||||
- **[Configuration reference](./docs/configuration.md)**: The configuration reference documentation.
|
||||
|
||||
### Licensing
|
||||
|
||||
|
|
35
docs/configuration.md
Normal file
35
docs/configuration.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
<!--
|
||||
SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
|
||||
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
-->
|
||||
|
||||
# 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](#httpconfig) | HTTP settings. |
|
||||
| `integrations` | [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. |
|
|
@ -41,7 +41,8 @@ enbas --config-dir ./config init
|
|||
```
|
||||
|
||||
You should now see a file called `config.json` in your configuration directory.
|
||||
Feel free to edit the file to your preferences (configuration documentation coming soon).
|
||||
Feel free to edit the file to your preferences.
|
||||
The [configuration reference page](./configuration.md) should help you with this.
|
||||
|
||||
For this 'Getting Started' guide you may want to specify your preferred browser in the configuration to allow
|
||||
Enbas to open the link to your instance's authorisation page.
|
||||
|
|
|
@ -4,4 +4,4 @@ SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
|
|||
SPDX-License-Identifier: CC-BY-4.0
|
||||
-->
|
||||
|
||||
# Manual
|
||||
# User Manual
|
||||
|
|
Loading…
Reference in a new issue