Keyboard shortcuts

Press or to navigate between chapters

Press ? to show this help

Press Esc to hide this help

Configuration reference

Example configuration: See here at Codeberg or Code Flow

Config

FieldTypeDescription
aliasesmap[string]stringA set of shortnames mapped to the enbas command.
This section is managed by enbas.
credentialsFilestringThe absolute path to your credentials file.
cacheDirectorystringThe absolute path to the root cache directory.
lineWrapMaxWidthnumber (integer)The maximum number of characters on a line before that line breaks.
This setting is used when displaying a timeline, your notifications, your bookmarks, the list of statuses from an account, etc.
gtsClientGTSClientThe settings for the GTS Client.
serverServerThe settings for running enbas in server mode.
integrationsIntegrationsIntegration settings.

GTSClient

FieldTypeDescription
timeoutnumber (integer)The timeout (in seconds) for API requests made to your GoToSocial instance.
mediaTimeoutnumber (integer)The timeout (in seconds) for requests made for retrieving media from your GoToSocial instance.

Server

FieldTypeDescription
socketPathstringThe path to the socket file that the backend server binds to.
This file is used for the communication between the enbas client and the enbas server.
pidPathstringThe path to the backend server’s PID file.
When the server starts it writes its process ID to this file.
The enbas client reads from this file when it is called to stop the backend server.
idleTimeoutnumber (integer)The time (in seconds) that the backend server can remain idle before shutting down.
This setting is only used when running the server without the --without-idle-timeout flag.
loggerServerLoggerThe settings for the server’s logger.

ServerLogger

FieldTypeDescription
levelstringThe server’s general logging level.
The accepted values are debug, info, warn and error.
By default the logging level is set to info.
pathstringThe path to the file where the logger will write the logs to.
If this field is empty, the logger will write to the console.

Integrations

FieldTypeDescription
browserstringThe command to run for opening the browser for viewing URLs (e.g. the URL of a remote account).
editorstringThe command to run for opening your favourite text editor for creating or editing statuses.
(THIS INTEGRATION IS NOT YET USED).
pagerstringThe command to run for piping long outputs into your favourite pager. To disable paging, leave this field blank.
imageViewerstringThe command to run for opening your favourite image viewer for viewing image files from media attachments.
videoPlayerstringThe command to run for opening your favourite video player for playing video files from media attachments.
audioPlayerstringThe command to run for opening your favourite audio player for playing audio files from media attachments.