Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #2036 from nodiscc/doc-general-download-timeout-max-size

Browse source 
doc: document general.download_max_size/timeout configuration settings
This commit is contained in:
nodiscc 2023-11-15 15:51:58 +00:00 committed by GitHub
commit 4557abb981
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/md/Shaarli-configuration.md
View file

@ -64,6 +64,8 @@ Some settings can be configured directly from a web browser by accesing the `Too
"default_private_links": true, "default_private_links": true,
"check_updates_branch": "stable", "check_updates_branch": "stable",
"check_updates_interval": 86400, "check_updates_interval": 86400,
"download_max_size": 4194304,
"download_timeout": 30,
"enabled_plugins": [ "enabled_plugins": [
"markdown", "markdown",
"wallabag", "wallabag",
@ -141,6 +143,8 @@ _These settings should not be edited_
- **timezone**: See [the list of supported timezones](https://www.php.net/manual/en/timezones.php). - **timezone**: See [the list of supported timezones](https://www.php.net/manual/en/timezones.php).
- **enabled_plugins**: List of enabled plugins. - **enabled_plugins**: List of enabled plugins.
- **default_note_title**: Default title of a new note. - **default_note_title**: Default title of a new note.
- **download_max_size:**: Maximum number of bytes to download when retrieveing page content/metadata.
- **download_timeout:**: Network timeout (in seconds) when retrieveing page content/metadata.
- **enable_async_metadata** (boolean): Retrieve external bookmark metadata asynchronously to prevent bookmark creation slowdown. - **enable_async_metadata** (boolean): Retrieve external bookmark metadata asynchronously to prevent bookmark creation slowdown.
- **retrieve_description** (boolean): If set to true, for every new Shaare Shaarli will try to retrieve the description and keywords from the HTML meta tags. - **retrieve_description** (boolean): If set to true, for every new Shaare Shaarli will try to retrieve the description and keywords from the HTML meta tags.
- **root_url**: Overrides automatic discovery of Shaarli instance's URL (e.g.) `https://sub.domain.tld/shaarli-folder/`. - **root_url**: Overrides automatic discovery of Shaarli instance's URL (e.g.) `https://sub.domain.tld/shaarli-folder/`.