Skip to content

Commit

Permalink
docs: sync config.js.md (add prefetchTimeout, update ldap) (#275)
Browse files Browse the repository at this point in the history
  • Loading branch information
flotwig authored Dec 13, 2023
1 parent 379c34d commit 51dfc80
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions _includes/config.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
DO NOT EDIT THIS FILE MANUALLY.
Content for the following is generated by this script in the main repo:
https://github.com/thelounge/thelounge/blob/master/scripts/generate-config-doc.js
Last updated at 2022-03-03 00:59:45 (UTC) by Max Leiter
Last updated at 2023-12-12 16:26:27 (UTC) by Zach Bloomquist
-->

## Server settings
Expand Down Expand Up @@ -146,6 +146,19 @@ kilobytes.

This value is set to `50` kilobytes by default.

### `prefetchTimeout`

When `prefetch` is enabled, this value sets the number of milliseconds
before The Lounge gives up attempting to fetch a link. This can be useful
if you've increased the `prefetchMaxImageSize`.

Take caution, however, that an inordinately large value may lead to
performance issues or even a denial of service, since The Lounge will not
be able to clean up outgoing connections as quickly. Usually the default
value is appropriate, so only change it if necessary.

This value is set to `5000` milliseconds by default.

### `fileUpload`

Allow uploading files to the server hosting The Lounge.
Expand Down Expand Up @@ -206,7 +219,7 @@ The available keys for the `defaults` object are:
- `nick`: Nick name. Percent signs (`%`) will be replaced by random
numbers from 0 to 9. For example, `Guest%%%` may become `Guest123`.
- `username`: User name.
- `realname`: Real name.
- `realname`: Real name displayed by some clients. Defaults to the nick if set to ""
- `leaveMessage`: Network specific leave message (overrides global leaveMessage)
- `join`: Comma-separated list of channels to auto-join once connected.

Expand Down Expand Up @@ -393,7 +406,7 @@ The available keys for the `ldap` object are:

- `rootPassword`: Password of The Lounge LDAP system user.

- `ldapFilter`: it is set to `"(objectClass=person)(memberOf=ou=accounts,dc=example,dc=com)"`
- `filter`: it is set to `"(&(objectClass=person)(memberOf=ou=accounts,dc=example,dc=com))"`
by default.

- `base`: LDAP search base (search only within this node). It is set
Expand Down

0 comments on commit 51dfc80

Please sign in to comment.