nodiscc 91a21c2729 **General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization**

- standardize page names, rework documentation structure, update TOC
- use same example paths everywhere
- level 1 titles on all pages
- fix broken links
- .md suffix on all page links (works both from readthedocs and github repository views)

**Server:**

A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration.

- server: move most server-related info to server-configuration.md, cleanup/shorten
- server: update list of php dependencies/libraries, link to composer.json
- server: installation: support 3 install methods (from release zip, from sources, using docker)
- server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not
- server: add example/basic usage of certbot
- server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root
- server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example
- server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files
- server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section
- server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here
- server: simplify phpinfo documentation
- server: move backup and restore information to dedicated page
- docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet
- troubleshooting: move all troubleshooting documentation to troubleshooting.md

**Usage:**

- index: add getting started section on index page
- features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list
- shaarli configuration: add note about configuring from web interface

**Removed:**

- remove obsolete/orphan images
- remove obsolete shaarchiver example
- remove outdated "decode datastore content" snippet

**Development:**

- development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory
- development: Merge several pages to development.md
- **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag)
- **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details
- development: directory structure: add note about required file permissions
- .travis-ci.yml: add comments
- .htaccess: add comment

2020-09-12 14:31:45 +02:00

11 KiB

Raw Blame History

Troubleshooting

First of all, ensure that both the web server and Shaarli are correctly configured.

I forgot my password!

Delete the file data/config.json.php and display the page again. You will be asked for a new login/password.

Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse Shaares.

To remove the current IP bans, delete the file data/ipbans.php
To list all login attempts, see data/log.txt (succesful/failed logins, bans/lifted bans)

Browser issues

Redirection issues (HTTP Referer)

Shaarli relies on HTTP_REFERER for some functions (like redirects and clicking on tags). If you have disabled or altered/spoofed HTTP referers in your browser, some features of Shaarli may not work as expected (depending on configuration and installed plugins), notably redirections between pages.

Firefox Referer settings are available by browsing about:config and are documented here. network.http.referer.spoofSource = true in particular is known to break some functionality in Shaarli.

Firefox, localhost and redirections

localhost is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly. To solve this, assign a local domain to your host, e.g. localhost.lan in your hosts file and browse Shaarli at http://localhost.lan/.

Hosting problems

Old PHP versions

On free.fr: free.fr now supports php 5.6.x(link) and so support now the tag autocompletion but you have to do the following.

At the root of your webspace create a sessions directory and a .htaccess file containing:

<IfDefine Free>
php56 1
</IfDefine>

If you have an error such as: Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to .php5
On 1and1 : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP).
If you have the error Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines:

//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.
// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html
//if (strpos($status,'200 OK')) $title=html_extract_title($data);

On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work.
On lost-oasis, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : <? // tout ce qui est charge ici (generalement des includes et require) est charge en permanence. ?>. To fix this, remove this message from php-include/prepend.php

Dates are not properly formatted

Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generally speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( )

My session expires! I can't stay logged in

This can be caused by several things:

Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a session directory on the root of your website.) You may need to create the session directory of set it up.
Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the sessions subdirectory and add ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');. Make sure this directory is not browsable !)
If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses).
Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those.
You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time.
If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions.

Old apache versions, Internal Server Error

If you hosting provider only provides apache 2.2 and no support for mod_version, .htaccess files may cause 500 errors (Internal Server Error). See this workaround.

Sessions do not seem to work correctly on your server

Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have no dots in the hostname (e.g. localhost or http://my-webserver/shaarli/), some browsers will not store cookies at all (this respects the HTTP cookie specification).

Upgrades

You must specify an integer as a key

In v0.8.1 we changed how Shaare keys are handled (from timestamps to incremental integers). Take a look at data/updates.txt content.

`updates.txt` contains `updateMethodDatastoreIds`

Try to delete it and refresh your page while being logged in.

`updates.txt` doesn't exist or doesn't contain `updateMethodDatastoreIds`

Create data/updates.txt if it doesn't exist
Paste this string in the update file ;updateMethodRenameDashTags;
Login to Shaarli
Delete the update file
Refresh

Import/export

Importing shaarli data to Firefox

In Firefox, open the bookmark manager (Bookmarks menu > Show all bookmarks or Ctrl+Shift+B), select Import and Backup > Import bookmarks in HTML format
Make sure the Prepend note permalinks with this Shaarli instance's URL box is checked when exporting, so that text-only/notes Shaares still point to the Shaarli instance you exported them from.
Depending on the number of bookmarks, the import can take some time.

You may be interested in these Firefox addons to manage bookmarks imported from Shaarli

Bookmark Deduplicator - provides an easy way to deduplicate your bookmarks
TagSieve - browse your bookmarks by their tags

Diigo

If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.)

Mister Wong

See this issue for import tweaks.

SemanticScuttle

To correctly import the tags from a SemanticScuttle HTML export, edit the HTML file before importing and replace all occurences of tags= (lowercase) to TAGS= (uppercase).

Scuttle

Shaarli cannot import data directly from Scuttle.

However, you can use the third-party scuttle-to-shaarli tool to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer.

Refind.com

You can use the third-party tool Derefind to convert refind.com bookmark exports to a format that can be imported into Shaarli.

Other

The bookmarklet doesn't work

Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunately, there is nothing Shaarli can do about it (1, 2, 3.

Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar.

Changing the timestamp for a shaare

Look for <input type="hidden" name="lf_linkdate" value="{$link.linkdate}"> in tpl/editlink.tpl (line 14)
Replace type="hidden" with type="text" from this line
A new date/time field becomes available in the edit/new Shaare dialog.
You can set the timestamp manually by entering it in the format YYYMMDD_HHMMS.

Support

If the solutions above did not help, please:

Come and ask question on the Gitter chat (also reachable via IRC)
Search for issues and Pull Requests
- if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup...)
- check issues labeled feature, enhancement, and plugin if you would like a feature added to Shaarli.
- else, open a new issue, and provide information about the problem:
  - what happens? - display glitches, invalid data, security flaws...
  - what is your configuration? - OS, server version, activated extensions, web browser...
  - is it reproducible?

11 KiB Raw Blame History