Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: troubleshooting: list more cases in which title retrieval fails #2060

Merged
merged 1 commit into from
Jan 7, 2024
Merged

doc: troubleshooting: list more cases in which title retrieval fails #2060

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions doc/md/Troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,6 @@ On some shared hosting services (such as **Bluehost**), `mod_security` is enable
You may need to adjust timeouts to larger values in your [reverse proxy configuration](Reverse-proxy.md) if you're getting `504 Gateway Timeout` errors during long-lasting operations (like importing many bookmarks from HTML, or batch deleting tags) on slow hardware. The PHP setting `max_execution_time` may also need to be adjusted for your specific setup. See issues [#1854](https://github.com/shaarli/Shaarli/issues/1854) and [#1910](https://github.com/shaarli/Shaarli/issues/1910).


### Automatic title retrieval fails

When bookmarking a page using the `+ Shaare > Add Link` dialog, Shaarli cannot retrieve the page `<title>` HTML attribute if it is set by javascript at page load (e.g. Youtube videos). You can work around this limitation by using a [Browser extension](Community-and-related-software.md) or the [Bookmarklet](#Usage).


----------------------------------------------------------

## Upgrades
Expand Down Expand Up @@ -179,6 +174,16 @@ You can use the third-party tool [Derefind](https://github.com/ShawnPConroy/Dere

## Other

### Page title and description are not retrieved automatically

When using the `+Shaare` button (`Shaare a new link` dialog) to add a bookmark, Shaarli attempts to extract the HTML title and description from the target page, and uses this to populate the `Title` and `Description` fields of the `New Shaare` dialog. In consequence, Shaarli can **not** extract the title/description in the following cases:
- the target page relies on javascript to build the HTML `<title>` and `<description>` attributes (e.g. YouTube videos)
- the target page is behind a DDoS protection/bot blocking mechanism (e.g. Cloudflare challenge)
- the target page is unreachable by the server running Shaarli (e.g. firewall or security mechanism blocking outgoing HTTP/HTTPS requests)

You can usually workaround this limitation by adding bookmarks from a [browser extension](Community-and-related-software.md#browser-extensions) or the [bookmarklet](Usage.md#adding-editing-shaares) instead.


### The bookmarklet doesn't work

Some websites may disallow usage of bookmarklets through [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP). Unfortunately, there is nothing Shaarli can do about it ([1](https://github.com/shaarli/Shaarli/issues/196), [2](https://bugzilla.mozilla.org/show_bug.cgi?id=866522), [3](https://bugs.chromium.org/p/chromium/issues/detail?id=233903).
Expand Down
Loading