From 6335a0fc0ce0c2f962333f0b4d6baac1671df901 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Tue, 18 Aug 2015 00:33:25 +0200 Subject: Doc: sync from Wiki, generate HTML Signed-off-by: VirtualTam --- doc/3rd-party-libraries.html | 1 + doc/Backup,-restore,-import-and-export.html | 1 + doc/Coding-guidelines.html | 1 + doc/Community-&-Related-software.html | 1 + ...installation-over-SSH-and-serve-it-locally.html | 1 + doc/Datastore-hacks.html | 1 + doc/Development.html | 1 + doc/Directory-structure.html | 1 + doc/Download-CSS-styles-from-an-OPML-list.html | 1 + ...xample-patch---add-new-via-field-for-links.html | 1 + doc/FAQ.html | 1 + doc/Firefox-share.html | 1 + doc/GnuPG-signature.html | 1 + doc/Home.html | 1 + doc/Plugin-System.html | 1 + doc/RSS-feeds.html | 1 + doc/Security.html | 1 + doc/Server-configuration.html | 1 + doc/Server-requirements.html | 1 + doc/Shaarli-configuration.html | 1 + doc/Sharing-button.html | 1 + doc/Static-analysis.html | 1 + doc/TODO.html | 1 + doc/Theming.html | 1 + doc/Troubleshooting.html | 50 +++++++++++++++++++++ doc/Troubleshooting.md | 51 ++++++++++++++++++++-- doc/Unit-tests.html | 1 + doc/Usage.html | 1 + doc/_Sidebar.html | 2 + doc/_Sidebar.md | 1 + doc/sidebar.html | 1 + 31 files changed, 128 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/3rd-party-libraries.html b/doc/3rd-party-libraries.html index a9c3a88e..86f670ae 100644 --- a/doc/3rd-party-libraries.html +++ b/doc/3rd-party-libraries.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Backup,-restore,-import-and-export.html b/doc/Backup,-restore,-import-and-export.html index 183a5ed4..40c7a852 100644 --- a/doc/Backup,-restore,-import-and-export.html +++ b/doc/Backup,-restore,-import-and-export.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Coding-guidelines.html b/doc/Coding-guidelines.html index 0f071a5a..fd6fa571 100644 --- a/doc/Coding-guidelines.html +++ b/doc/Coding-guidelines.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Community-&-Related-software.html b/doc/Community-&-Related-software.html index 5468379c..25ef0f88 100644 --- a/doc/Community-&-Related-software.html +++ b/doc/Community-&-Related-software.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html index 9e930e52..1e81b735 100644 --- a/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html +++ b/doc/Copy-an-existing-installation-over-SSH-and-serve-it-locally.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Datastore-hacks.html b/doc/Datastore-hacks.html index 4677ae91..e3adee19 100644 --- a/doc/Datastore-hacks.html +++ b/doc/Datastore-hacks.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Development.html b/doc/Development.html index 1e33eff4..6e222573 100644 --- a/doc/Development.html +++ b/doc/Development.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Directory-structure.html b/doc/Directory-structure.html index 4ea5e249..ae0458f3 100644 --- a/doc/Directory-structure.html +++ b/doc/Directory-structure.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Download-CSS-styles-from-an-OPML-list.html b/doc/Download-CSS-styles-from-an-OPML-list.html index b21a54bd..033dd18c 100644 --- a/doc/Download-CSS-styles-from-an-OPML-list.html +++ b/doc/Download-CSS-styles-from-an-OPML-list.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Example-patch---add-new-via-field-for-links.html b/doc/Example-patch---add-new-via-field-for-links.html index 44352d3e..ff73ec0f 100644 --- a/doc/Example-patch---add-new-via-field-for-links.html +++ b/doc/Example-patch---add-new-via-field-for-links.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/FAQ.html b/doc/FAQ.html index 0ebd1bcf..b26b6355 100644 --- a/doc/FAQ.html +++ b/doc/FAQ.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Firefox-share.html b/doc/Firefox-share.html index 198afe23..d666ac7b 100644 --- a/doc/Firefox-share.html +++ b/doc/Firefox-share.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/GnuPG-signature.html b/doc/GnuPG-signature.html index c9e0455a..b7dc1083 100644 --- a/doc/GnuPG-signature.html +++ b/doc/GnuPG-signature.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Home.html b/doc/Home.html index 37d62e8b..90372a40 100644 --- a/doc/Home.html +++ b/doc/Home.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Plugin-System.html b/doc/Plugin-System.html index 6d08d859..719b76fe 100644 --- a/doc/Plugin-System.html +++ b/doc/Plugin-System.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/RSS-feeds.html b/doc/RSS-feeds.html index 4a9b7a0e..7d1de078 100644 --- a/doc/RSS-feeds.html +++ b/doc/RSS-feeds.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Security.html b/doc/Security.html index 1fbbabde..db44da2c 100644 --- a/doc/Security.html +++ b/doc/Security.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Server-configuration.html b/doc/Server-configuration.html index de6bf488..e4e383a3 100644 --- a/doc/Server-configuration.html +++ b/doc/Server-configuration.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Server-requirements.html b/doc/Server-requirements.html index bf5a2e8b..b0426eec 100644 --- a/doc/Server-requirements.html +++ b/doc/Server-requirements.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Shaarli-configuration.html b/doc/Shaarli-configuration.html index 90c09542..663b43e5 100644 --- a/doc/Shaarli-configuration.html +++ b/doc/Shaarli-configuration.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Sharing-button.html b/doc/Sharing-button.html index 034f2f9c..d3f36253 100644 --- a/doc/Sharing-button.html +++ b/doc/Sharing-button.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Static-analysis.html b/doc/Static-analysis.html index d4588e4d..dd1dd223 100644 --- a/doc/Static-analysis.html +++ b/doc/Static-analysis.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/TODO.html b/doc/TODO.html index f66d64f2..c25775cc 100644 --- a/doc/TODO.html +++ b/doc/TODO.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Theming.html b/doc/Theming.html index e814dadf..b5d214e5 100644 --- a/doc/Theming.html +++ b/doc/Theming.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Troubleshooting.html b/doc/Troubleshooting.html index 6965a578..00cfdff8 100644 --- a/doc/Troubleshooting.html +++ b/doc/Troubleshooting.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development @@ -74,6 +75,54 @@ code > span.er { color: #ff0000; font-weight: bold; }

    Troubleshooting

    +

    Browser

    +

    Redirection issues (HTTP Referer)

    +

    Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages.

    +

    See:

    + +

    Firefox HTTP Referer options

    +

    HTTP settings are available by browsing about:config, here are the available settings and their values.

    +

    network.http.sendRefererHeader - determines when to send the Referer HTTP header

    +
      +
    • 0: Never send the referring URL +
        +
      • not recommended, may break some sites
        • +
      • +
    • 1: Send only on clicked links
      • +
    • 2 (default): Send for links and images
      • +
    +

    network.http.referer.XOriginPolicy - Cross-domain origin policy

    +
      +
    • 0 (default): Always send
      • +
    • 1: Send if base domains match
      • +
    • 2: Send if hosts match
      • +
    +

    network.http.referer.spoofSource - Referer spoofing (~faking)

    +
      +
    • false (default): real referer
      • +
    • true: spoof referer (use target URI as referer)
      • +
    +

    network.http.referer.trimmingPolicy - trim the URI not to send a full Referer

    +
      +
    • 0 (default): send full URI
      • +
    • 1: scheme+host+port+path
      • +
    • 2: scheme+host+port
      • +
    +

    Firefox, localhost and redirections

    +

    localhost is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or anly 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.

    +
    127.0.0.1 localhost desktop localhost.lan
+::1       localhost desktop localhost.lan
    +

    and browse Shaarli at http://localhost.lan/.

    +

    Related threads:

    +

    Login

    I forgot my password!

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

    @@ -83,6 +132,7 @@ code > span.er { color: #ff0000; font-weight: bold; }

    List of all login attempts

    The file data/log.txt shows all logins (successful or failed) and bans/lifted bans.
    Search for failed in this file to look for unauthorized login attempts.

    Hosting problems

    +

    Old PHP versions

    • On free.fr : Please note that free uses php 5.1 and thus you will not have autocomplete in tag editing. Don't forget to create a sessions directory at the root of your webspace. Change the file extension to .php5 or create a .htaccess file in the directory where Shaarli is located containing:
    diff --git a/doc/Troubleshooting.md b/doc/Troubleshooting.md index 4adf7c92..4e6cdb06 100644 --- a/doc/Troubleshooting.md +++ b/doc/Troubleshooting.md @@ -1,7 +1,53 @@ #Troubleshooting +## Browser +### Redirection issues (HTTP Referer) +Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages. + +See: +- [HTTP referer](https://en.wikipedia.org/wiki/HTTP_referer) (Wikipedia)[](.html) +- [Improve online privacy by controlling referrer information](http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/)[](.html) +- [Better security, privacy and anonymity in Firefox](http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/)[](.html) + +### Firefox HTTP Referer options +HTTP settings are available by browsing `about:config`, here are the available settings and their values. + +`network.http.sendRefererHeader` - determines when to send the Referer HTTP header +- 0: Never send the referring URL + - not recommended, may break some sites +- 1: Send only on clicked links +- 2 (default): Send for links and images + +`network.http.referer.XOriginPolicy` - Cross-domain origin policy +- 0 (default): Always send +- 1: Send if base domains match +- 2: Send if hosts match + +`network.http.referer.spoofSource` - Referer spoofing (~faking) +- false (default): real referer +- true: spoof referer (use target URI as referer) + +`network.http.referer.trimmingPolicy` - trim the URI not to send a full Referer +- 0 (default): send full URI +- 1: scheme+host+port+path +- 2: scheme+host+port + +### Firefox, localhost and redirections +`localhost` is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or anly 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. +``` +127.0.0.1 localhost desktop localhost.lan +::1 localhost desktop localhost.lan +``` + +and browse Shaarli at http://localhost.lan/. + +Related threads: +- [What is localhost.localdomain for?](https://bbs.archlinux.org/viewtopic.php?id=156064)[](.html) +- [Stop returning to the first page after editing a bookmark from another page](https://github.com/shaarli/Shaarli/issues/311)[](.html) + ## Login ### I forgot my password! - Delete the file `data/config.php` and display the page again. You will be asked for a new login/password. ### I'm locked out - Login bruteforce protection @@ -10,11 +56,11 @@ Login form is protected against brute force attacks: 4 failed logins will ban th To remove the current IP bans, delete the file `data/ipbans.php` ### List of all login attempts - The file `data/log.txt` shows all logins (successful or failed) and bans/lifted bans. Search for `failed` in this file to look for unauthorized login attempts. ## Hosting problems +### Old PHP versions * On **free.fr** : Please note that free uses php 5.1 and thus you will not have autocomplete in tag editing. Don't forget to create a `sessions` directory at the root of your webspace. Change the file extension to `.php5` or create a `.htaccess` file in the directory where Shaarli is located containing: ```ini @@ -56,5 +102,4 @@ This can be caused by several things: 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](http://curl.haxx.se/rfc/cookie_spec.html)).[](.html) ### pubsubhubbub support - Download [publisher.php](https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php) at the root of your Shaarli installation and set `$GLOBALS['config'['PUBSUBHUB_URL']` in your `config.php`]('PUBSUBHUB_URL']`-in-your-`config.php`.html) diff --git a/doc/Unit-tests.html b/doc/Unit-tests.html index 25873cb0..f4b42bdf 100644 --- a/doc/Unit-tests.html +++ b/doc/Unit-tests.html @@ -51,6 +51,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/Usage.html b/doc/Usage.html index cffdc4d6..ad5b7965 100644 --- a/doc/Usage.html +++ b/doc/Usage.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/_Sidebar.html b/doc/_Sidebar.html index c2725196..0f9d546e 100644 --- a/doc/_Sidebar.html +++ b/doc/_Sidebar.html @@ -32,6 +32,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development @@ -74,6 +75,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development diff --git a/doc/_Sidebar.md b/doc/_Sidebar.md index 64b16491..db75943a 100644 --- a/doc/_Sidebar.md +++ b/doc/_Sidebar.md @@ -12,6 +12,7 @@ - [Backup, restore, import and export](Backup,-restore,-import-and-export.html) - [Copy an existing installation over SSH and serve it locally](Copy-an-existing-installation-over-SSH-and-serve-it-locally.html) - [Download CSS styles from an OPML list](Download-CSS-styles-from-an-OPML-list.html) + - [Datastore hacks](Datastore-hacks.html) - [Troubleshooting](Troubleshooting.html) - [Development](Development.html) - [GnuPG signature](GnuPG-signature.html) diff --git a/doc/sidebar.html b/doc/sidebar.html index 1b585400..e8bc5932 100644 --- a/doc/sidebar.html +++ b/doc/sidebar.html @@ -18,6 +18,7 @@
  • Backup, restore, import and export
  • Copy an existing installation over SSH and serve it locally
  • Download CSS styles from an OPML list
    • +
  • Datastore hacks
  • Troubleshooting
  • Development -- cgit v1.2.3