From 3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sat, 29 Jul 2017 15:29:54 +0200 Subject: [PATCH] Generate HTML documentation Signed-off-by: VirtualTam --- AUTHORS | 12 +- doc/html/3rd-party-libraries/index.html | 8 +- .../index.html | 8 +- doc/html/Bookmarklet/index.html | 8 +- doc/html/Browsing-and-searching/index.html | 8 +- doc/html/Coding-guidelines/index.html | 8 +- .../Community-&-Related-software/index.html | 8 +- .../Continuous-integration-tools/index.html | 8 +- doc/html/Development-guidelines/index.html | 8 +- doc/html/Directory-structure/index.html | 8 +- doc/html/Download-and-Installation/index.html | 8 +- doc/html/FAQ/index.html | 8 +- doc/html/Features/index.html | 12 +- doc/html/Firefox-share/index.html | 8 +- doc/html/GnuPG-signature/index.html | 8 +- doc/html/Plugin-System/index.html | 8 +- doc/html/Plugins/index.html | 12 +- doc/html/REST-API/index.html | 8 +- doc/html/RSS-feeds/index.html | 8 +- doc/html/Release-Shaarli/index.html | 8 +- doc/html/Security/index.html | 8 +- doc/html/Server-configuration/index.html | 8 +- doc/html/Server-requirements/index.html | 8 +- doc/html/Server-security/index.html | 8 +- doc/html/Shaarli-configuration/index.html | 60 ++++++---- doc/html/Static-analysis/index.html | 8 +- doc/html/Theming/index.html | 8 +- doc/html/Troubleshooting/index.html | 8 +- doc/html/Unit-tests/index.html | 8 +- doc/html/Upgrade-and-migration/index.html | 8 +- doc/html/Various-hacks/index.html | 8 +- doc/html/Versioning-and-Branches/index.html | 8 +- .../docker-101}/index.html | 110 ++++++++--------- .../resources}/index.html | 110 ++++++++--------- .../reverse-proxy-configuration}/index.html | 110 ++++++++--------- .../shaarli-images}/index.html | 111 +++++++++--------- doc/html/index.html | 10 +- doc/html/mkdocs/search_index.json | 46 ++++---- doc/html/search.html | 8 +- doc/html/sitemap.xml | 80 ++++++------- 40 files changed, 459 insertions(+), 446 deletions(-) rename doc/html/{Docker-101 => docker/docker-101}/index.html (71%) rename doc/html/{Docker-resources => docker/resources}/index.html (68%) rename doc/html/{Reverse-proxy-configuration => docker/reverse-proxy-configuration}/index.html (64%) rename doc/html/{Shaarli-images => docker/shaarli-images}/index.html (74%) diff --git a/AUTHORS b/AUTHORS index c0e3594..9c0ca3d 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,6 +1,6 @@ - 472 ArthurHoaro - 201 VirtualTam - 132 nodiscc + 506 ArthurHoaro + 204 VirtualTam + 147 nodiscc 56 Sébastien Sauvage 15 Florian Eula 13 Emilien Klein @@ -8,15 +8,18 @@ 8 Christophe HENRY 4 Alexandre Alapetite 4 David Sferruzza + 3 Lucas Cimon 3 Teromene + 3 kalvn 2 Chris Kuethe 2 Knah Tsaeb 2 Mathieu Chabanon 2 Miloš Jovanović 2 Qwerty + 2 Stephen Muth 2 Timo Van Neerden 2 julienCXX - 2 kalvn + 2 philipp-r 1 Adrien Oliva 1 Alexis J 1 BoboTiG @@ -38,4 +41,3 @@ 1 Sbgodin 1 TsT 1 dimtion - 1 philipp-r diff --git a/doc/html/3rd-party-libraries/index.html b/doc/html/3rd-party-libraries/index.html index 0d62007..d775447 100644 --- a/doc/html/3rd-party-libraries/index.html +++ b/doc/html/3rd-party-libraries/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Backup,-restore,-import-and-export/index.html b/doc/html/Backup,-restore,-import-and-export/index.html index 33ec912..caebb6c 100644 --- a/doc/html/Backup,-restore,-import-and-export/index.html +++ b/doc/html/Backup,-restore,-import-and-export/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Bookmarklet/index.html b/doc/html/Bookmarklet/index.html index 325d305..924a871 100644 --- a/doc/html/Bookmarklet/index.html +++ b/doc/html/Bookmarklet/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Browsing-and-searching/index.html b/doc/html/Browsing-and-searching/index.html index c8b7386..f245410 100644 --- a/doc/html/Browsing-and-searching/index.html +++ b/doc/html/Browsing-and-searching/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Coding-guidelines/index.html b/doc/html/Coding-guidelines/index.html index dfcdd45..3e27309 100644 --- a/doc/html/Coding-guidelines/index.html +++ b/doc/html/Coding-guidelines/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Community-&-Related-software/index.html b/doc/html/Community-&-Related-software/index.html index 2497433..e9c3313 100644 --- a/doc/html/Community-&-Related-software/index.html +++ b/doc/html/Community-&-Related-software/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Continuous-integration-tools/index.html b/doc/html/Continuous-integration-tools/index.html index 339f37a..b059922 100644 --- a/doc/html/Continuous-integration-tools/index.html +++ b/doc/html/Continuous-integration-tools/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Development-guidelines/index.html b/doc/html/Development-guidelines/index.html index e75c911..9e1d8ab 100644 --- a/doc/html/Development-guidelines/index.html +++ b/doc/html/Development-guidelines/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Directory-structure/index.html b/doc/html/Directory-structure/index.html index ff075ec..49f26dd 100644 --- a/doc/html/Directory-structure/index.html +++ b/doc/html/Directory-structure/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Download-and-Installation/index.html b/doc/html/Download-and-Installation/index.html index 9234268..8bc9a5b 100644 --- a/doc/html/Download-and-Installation/index.html +++ b/doc/html/Download-and-Installation/index.html @@ -128,19 +128,19 @@ diff --git a/doc/html/FAQ/index.html b/doc/html/FAQ/index.html index f8ced26..5b7900b 100644 --- a/doc/html/FAQ/index.html +++ b/doc/html/FAQ/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Features/index.html b/doc/html/Features/index.html index e847c54..7903079 100644 --- a/doc/html/Features/index.html +++ b/doc/html/Features/index.html @@ -94,19 +94,19 @@ @@ -318,7 +318,7 @@ Next - Previous + Previous @@ -346,7 +346,7 @@ GitHub - « Previous + « Previous Next » diff --git a/doc/html/Firefox-share/index.html b/doc/html/Firefox-share/index.html index 9c028ff..4c84a07 100644 --- a/doc/html/Firefox-share/index.html +++ b/doc/html/Firefox-share/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/GnuPG-signature/index.html b/doc/html/GnuPG-signature/index.html index 0b2d842..82e2207 100644 --- a/doc/html/GnuPG-signature/index.html +++ b/doc/html/GnuPG-signature/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Plugin-System/index.html b/doc/html/Plugin-System/index.html index dbed590..11ea5ed 100644 --- a/doc/html/Plugin-System/index.html +++ b/doc/html/Plugin-System/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Plugins/index.html b/doc/html/Plugins/index.html index 4b63681..f87cf84 100644 --- a/doc/html/Plugins/index.html +++ b/doc/html/Plugins/index.html @@ -115,19 +115,19 @@ @@ -358,7 +358,7 @@ Example:

diff --git a/doc/html/REST-API/index.html b/doc/html/REST-API/index.html index 6e2c951..dae27e5 100644 --- a/doc/html/REST-API/index.html +++ b/doc/html/REST-API/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/RSS-feeds/index.html b/doc/html/RSS-feeds/index.html index a4b7339..1e4ea95 100644 --- a/doc/html/RSS-feeds/index.html +++ b/doc/html/RSS-feeds/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Release-Shaarli/index.html b/doc/html/Release-Shaarli/index.html index 5857a52..fbb0672 100644 --- a/doc/html/Release-Shaarli/index.html +++ b/doc/html/Release-Shaarli/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Security/index.html b/doc/html/Security/index.html index c7aec58..bea1ba9 100644 --- a/doc/html/Security/index.html +++ b/doc/html/Security/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Server-configuration/index.html b/doc/html/Server-configuration/index.html index 6e798b4..91b20fd 100644 --- a/doc/html/Server-configuration/index.html +++ b/doc/html/Server-configuration/index.html @@ -149,19 +149,19 @@ diff --git a/doc/html/Server-requirements/index.html b/doc/html/Server-requirements/index.html index f3bfa18..29bb610 100644 --- a/doc/html/Server-requirements/index.html +++ b/doc/html/Server-requirements/index.html @@ -112,19 +112,19 @@ diff --git a/doc/html/Server-security/index.html b/doc/html/Server-security/index.html index 6d9f25c..5ec0fdb 100644 --- a/doc/html/Server-security/index.html +++ b/doc/html/Server-security/index.html @@ -118,19 +118,19 @@ diff --git a/doc/html/Shaarli-configuration/index.html b/doc/html/Shaarli-configuration/index.html index 4e55606..cd323a3 100644 --- a/doc/html/Shaarli-configuration/index.html +++ b/doc/html/Shaarli-configuration/index.html @@ -134,19 +134,19 @@ @@ -323,26 +323,38 @@ its values override those defined in index.php it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration

File and directory permissions

-

The server process running Shaarli must have: -- read access to the following resources: - - PHP scripts: index.php, application/*.php, plugins/*.php - - 3rd party PHP and Javascript libraries: inc/*.php, inc/*.js - - static assets: - - CSS stylesheets: inc/*.css - - images/* - - RainTPL templates: tpl/*.html -- read, write and execution access to the following directories: - - cache - thumbnail cache - - data - link data store, configuration options - - pagecache - Atom/RSS feed cache - - tmp - RainTPL page cache

-

On a Linux distribution: -- the web server user will likely be www or http (for Apache2) -- it will be a member of a group of the same name: www:www, http:http -- to give it access to Shaarli, either: - - unzip Shaarli in the default web server location (usually /var/www/) and set the web server user as the owner - - put users in the same group as the web server, and set the appropriate access rights -- if you have a domain / subdomain to serve Shaarli, configure the server accordingly

+

The server process running Shaarli must have:

+
    +
  • read access to the following resources:
      +
    • PHP scripts: index.php, application/*.php, plugins/*.php
      • +
    • 3rd party PHP and Javascript libraries: inc/*.php, inc/*.js
      • +
    • static assets:
        +
      • CSS stylesheets: inc/*.css
        • +
      • images/*
        • +
      +
      • +
    • RainTPL templates: tpl/*.html
      • +
    +
    • +
  • read, write and execution access to the following directories:
      +
    • cache - thumbnail cache
      • +
    • data - link data store, configuration options
      • +
    • pagecache - Atom/RSS feed cache
      • +
    • tmp - RainTPL page cache
      • +
    +
    • +
+

On a Linux distribution:

+
    +
  • the web server user will likely be www or http (for Apache2)
    • +
  • it will be a member of a group of the same name: www:www, http:http
    • +
  • to give it access to Shaarli, either:
      +
    • unzip Shaarli in the default web server location (usually /var/www/) and set the web server user as the owner
      • +
    • put users in the same group as the web server, and set the appropriate access rights
      • +
    +
    • +
  • if you have a domain / subdomain to serve Shaarli, configure the server accordingly
    • +

Configuration

In data/config.json.php.

See also Plugin System.

diff --git a/doc/html/Static-analysis/index.html b/doc/html/Static-analysis/index.html index ddd81f8..e0aff52 100644 --- a/doc/html/Static-analysis/index.html +++ b/doc/html/Static-analysis/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Theming/index.html b/doc/html/Theming/index.html index 670dbb8..d6ecb06 100644 --- a/doc/html/Theming/index.html +++ b/doc/html/Theming/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Troubleshooting/index.html b/doc/html/Troubleshooting/index.html index f156436..90705ad 100644 --- a/doc/html/Troubleshooting/index.html +++ b/doc/html/Troubleshooting/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Unit-tests/index.html b/doc/html/Unit-tests/index.html index ce90ed1..ebc92be 100644 --- a/doc/html/Unit-tests/index.html +++ b/doc/html/Unit-tests/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Upgrade-and-migration/index.html b/doc/html/Upgrade-and-migration/index.html index 3319fa7..b190ed3 100644 --- a/doc/html/Upgrade-and-migration/index.html +++ b/doc/html/Upgrade-and-migration/index.html @@ -133,19 +133,19 @@ diff --git a/doc/html/Various-hacks/index.html b/doc/html/Various-hacks/index.html index b06207a..a10358c 100644 --- a/doc/html/Various-hacks/index.html +++ b/doc/html/Various-hacks/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Versioning-and-Branches/index.html b/doc/html/Versioning-and-Branches/index.html index 97bdb47..d3f61ec 100644 --- a/doc/html/Versioning-and-Branches/index.html +++ b/doc/html/Versioning-and-Branches/index.html @@ -94,19 +94,19 @@ diff --git a/doc/html/Docker-101/index.html b/doc/html/docker/docker-101/index.html similarity index 71% rename from doc/html/Docker-101/index.html rename to doc/html/docker/docker-101/index.html index 31e57b5..67a3f8e 100644 --- a/doc/html/Docker-101/index.html +++ b/doc/html/docker/docker-101/index.html @@ -7,25 +7,25 @@ - + Docker 101 - Shaarli Documentation - - - - + + + + - - - + + + @@ -36,9 +36,9 @@