]> git.immae.eu Git - github/shaarli/Shaarli.git/blobdiff - doc/html/mkdocs/search_index.json
Generate HTML documentation
[github/shaarli/Shaarli.git] / doc / html / mkdocs / search_index.json
index 71bc2bcf96509973539797203b3da8a5f9715d0a..d9e8b5b895b90ce03aba1f2edd4188db4f2d92b8 100644 (file)
         },
         {
             "location": "/Shaarli-configuration/",
-            "text": "Foreword\n\n\nDo not edit configuration options in index.php! Your changes would be lost.\n \n\n\nOnce your Shaarli instance is installed, the file \ndata/config.json.php\n is generated:\n\n it contains all settings in JSON format, and can be edited to customize values\n\n it defines which \nplugins\n are enabled\n\n\n its values override those defined in \nindex.php\n\n\n it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration\n\n\nFile and directory permissions\n\n\nThe server process running Shaarli must have:\n- \nread\n access to the following resources:\n    - PHP scripts: \nindex.php\n, \napplication/*.php\n, \nplugins/*.php\n\n    - 3rd party PHP and Javascript libraries: \ninc/*.php\n, \ninc/*.js\n\n    - static assets:\n        - CSS stylesheets: \ninc/*.css\n\n        - \nimages/*\n\n    - RainTPL templates: \ntpl/*.html\n\n- \nread\n, \nwrite\n and \nexecution\n access to the following directories:\n    - \ncache\n - thumbnail cache\n    - \ndata\n - link data store, configuration options\n    - \npagecache\n - Atom/RSS feed cache\n    - \ntmp\n - RainTPL page cache\n\n\nOn a Linux distribution:\n- the web server user will likely be \nwww\n or \nhttp\n (for Apache2)\n- it will be a member of a group of the same name: \nwww:www\n, \nhttp:http\n\n- to give it access to Shaarli, either:\n    - unzip Shaarli in the default web server location (usually \n/var/www/\n) and set the web server user as the owner\n    - put users in the same group as the web server, and set the appropriate access rights\n- if you have a domain / subdomain to serve Shaarli, \nconfigure the server\n accordingly\n\n\nConfiguration\n\n\nIn \ndata/config.json.php\n.\n\n\nSee also \nPlugin System\n.\n\n\nCredentials\n\n\n\n\nYou shouldn't edit those.\n\n\n\n\nlogin\n: Login username.\n\n\nhash\n: Generated password hash.\n\n\nsalt\n: Password salt.\n\n\nGeneral\n\n\ntitle\n: Shaarli's instance title.\n\n\nheader_link\n: Link to the homepage.\n\n\nlinks_per_page\n: Number of shaares displayed per page.\n\n\ntimezone\n: See \nthe list of supported timezones\n.\n\n\nenabled_plugins\n: List of enabled plugins.\n\n\nSecurity\n\n\nsession_protection_disabled\n: Disable session cookie hijacking protection (not recommended). \nIt might be useful if your IP adress often changes.\n\n\nban_after\n: Failed login attempts before being IP banned.\n\n\nban_duration\n: IP ban duration in seconds.\n\n\nopen_shaarli\n: Anyone can add a new link while logged out if enabled.\n\n\ntrusted_proxies\n: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.\n\n\nallowed_protocols\n: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store \njavascript:\n links (bookmarklets) in Shaarli (default: \n[\"ftp\", \"ftps\", \"magnet\"]\n).\n\n\nResources\n\n\ndata_dir\n: Data directory.\n\n\ndatastore\n: Shaarli's links database file path.\n\n\nhistory\n: Shaarli's operation history file path.\n\nupdates\n: File path for the ran updates file.\n\n\nlog\n: Log file path.\n\n\nupdate_check\n: Last update check file path.\n\n\nraintpl_tpl\n: Templates directory.\n\n\nraintpl_tmp\n: Template engine cache directory.\n\n\nthumbnails_cache\n: Thumbnails cache directory.\n\n\npage_cache\n: Shaarli's internal cache directory.\n\n\nban_file\n: Banned IP file path.\n\n\nUpdates\n\n\ncheck_updates\n: Enable or disable update check to the git repository.\n\n\ncheck_updates_branch\n: Git branch used to check updates (e.g. \nstable\n or \nmaster\n).\n\n\ncheck_updates_interval\n: Look for new version every N seconds (default: every day).\n\n\nPrivacy\n\n\ndefault_private_links\n: Check the private checkbox by default for every new link.\n\n\nhide_public_links\n: All links are hidden while logged out.\n\n\nhide_timestamps\n: Timestamps are hidden.\n\n\nFeed\n\n\nrss_permalinks\n: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.\n\n\nshow_atom\n: Display ATOM feed button.\n\n\nThumbnail\n\n\nenable_thumbnails\n: Enable or disable thumbnail display.\n\n\nenable_localcache\n: Enable or disable local cache.\n\n\nRedirector\n\n\nurl\n: Redirector URL, such as \nanonym.to\n.\n\n\nencode_url\n: Enable this if the redirector needs encoded URL to work properly.\n\n\nConfiguration file example\n\n\n<?php /*\n{\n    \"credentials\": {\n        \"login\": \"<login>\",\n        \"hash\": \"<password hash>\",\n        \"salt\": \"<password salt>\"\n    },\n    \"security\": {\n        \"ban_after\": 4,\n        \"session_protection_disabled\": false,\n        \"ban_duration\": 1800,\n        \"trusted_proxies\": [\n            \"1.2.3.4\",\n            \"5.6.7.8\"\n        ],\n        \"allowed_protocols\": [\n            \"ftp\",\n            \"ftps\",\n            \"magnet\"\n        ]\n    },\n    \"resources\": {\n        \"data_dir\": \"data\",\n        \"config\": \"data\\/config.php\",\n        \"datastore\": \"data\\/datastore.php\",\n        \"ban_file\": \"data\\/ipbans.php\",\n        \"updates\": \"data\\/updates.txt\",\n        \"log\": \"data\\/log.txt\",\n        \"update_check\": \"data\\/lastupdatecheck.txt\",\n        \"raintpl_tmp\": \"tmp\\/\",\n        \"raintpl_tpl\": \"tpl\\/\",\n        \"thumbnails_cache\": \"cache\",\n        \"page_cache\": \"pagecache\"\n    },\n    \"general\": {\n        \"check_updates\": true,\n        \"rss_permalinks\": true,\n        \"links_per_page\": 20,\n        \"default_private_links\": true,\n        \"enable_thumbnails\": true,\n        \"enable_localcache\": true,\n        \"check_updates_branch\": \"stable\",\n        \"check_updates_interval\": 86400,\n        \"enabled_plugins\": [\n            \"markdown\",\n            \"wallabag\",\n            \"archiveorg\"\n        ],\n        \"timezone\": \"Europe\\/Paris\",\n        \"title\": \"My Shaarli\",\n        \"header_link\": \"?\"\n    },\n    \"extras\": {\n        \"show_atom\": false,\n        \"hide_public_links\": false,\n        \"hide_timestamps\": false,\n        \"open_shaarli\": false,\n        \"redirector\": \"http://anonym.to/?\",\n        \"redirector_encode_url\": false\n    },\n    \"general\": {\n        \"header_link\": \"?\",\n        \"links_per_page\": 20,\n        \"enabled_plugins\": [\n            \"markdown\",\n            \"wallabag\"\n        ],\n        \"timezone\": \"Europe\\/Paris\",\n        \"title\": \"My Shaarli\"\n    },\n    \"updates\": {\n        \"check_updates\": true,\n        \"check_updates_branch\": \"stable\",\n        \"check_updates_interval\": 86400\n    },\n    \"feed\": {\n        \"rss_permalinks\": true,\n        \"show_atom\": false\n    },\n    \"privacy\": {\n        \"default_private_links\": true,\n        \"hide_public_links\": false,\n        \"hide_timestamps\": false\n    },\n    \"thumbnail\": {\n        \"enable_thumbnails\": true,\n        \"enable_localcache\": true\n    },\n    \"redirector\": {\n        \"url\": \"http://anonym.to/?\",\n        \"encode_url\": false\n    },\n    \"plugins\": {\n        \"WALLABAG_URL\": \"http://demo.wallabag.org\",\n        \"WALLABAG_VERSION\": \"1\"\n    }\n} ?>\n\n\n\n\nAdditional configuration\n\n\nThe playvideos plugin may require that you adapt your server's \n\nContent Security Policy\n \nconfiguration to work properly.",
+            "text": "Foreword\n\n\nDo not edit configuration options in index.php! Your changes would be lost.\n \n\n\nOnce your Shaarli instance is installed, the file \ndata/config.json.php\n is generated:\n\n it contains all settings in JSON format, and can be edited to customize values\n\n it defines which \nplugins\n are enabled\n\n\n its values override those defined in \nindex.php\n\n\n it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration\n\n\nFile and directory permissions\n\n\nThe server process running Shaarli must have:\n\n\n\n\nread\n access to the following resources:\n\n\nPHP scripts: \nindex.php\n, \napplication/*.php\n, \nplugins/*.php\n\n\n3rd party PHP and Javascript libraries: \ninc/*.php\n, \ninc/*.js\n\n\nstatic assets:\n\n\nCSS stylesheets: \ninc/*.css\n\n\nimages/*\n\n\n\n\n\n\nRainTPL templates: \ntpl/*.html\n\n\n\n\n\n\nread\n, \nwrite\n and \nexecution\n access to the following directories:\n\n\ncache\n - thumbnail cache\n\n\ndata\n - link data store, configuration options\n\n\npagecache\n - Atom/RSS feed cache\n\n\ntmp\n - RainTPL page cache\n\n\n\n\n\n\n\n\nOn a Linux distribution:\n\n\n\n\nthe web server user will likely be \nwww\n or \nhttp\n (for Apache2)\n\n\nit will be a member of a group of the same name: \nwww:www\n, \nhttp:http\n\n\nto give it access to Shaarli, either:\n\n\nunzip Shaarli in the default web server location (usually \n/var/www/\n) and set the web server user as the owner\n\n\nput users in the same group as the web server, and set the appropriate access rights\n\n\n\n\n\n\nif you have a domain / subdomain to serve Shaarli, \nconfigure the server\n accordingly\n\n\n\n\nConfiguration\n\n\nIn \ndata/config.json.php\n.\n\n\nSee also \nPlugin System\n.\n\n\nCredentials\n\n\n\n\nYou shouldn't edit those.\n\n\n\n\nlogin\n: Login username.\n\n\nhash\n: Generated password hash.\n\n\nsalt\n: Password salt.\n\n\nGeneral\n\n\ntitle\n: Shaarli's instance title.\n\n\nheader_link\n: Link to the homepage.\n\n\nlinks_per_page\n: Number of shaares displayed per page.\n\n\ntimezone\n: See \nthe list of supported timezones\n.\n\n\nenabled_plugins\n: List of enabled plugins.\n\n\nSecurity\n\n\nsession_protection_disabled\n: Disable session cookie hijacking protection (not recommended). \nIt might be useful if your IP adress often changes.\n\n\nban_after\n: Failed login attempts before being IP banned.\n\n\nban_duration\n: IP ban duration in seconds.\n\n\nopen_shaarli\n: Anyone can add a new link while logged out if enabled.\n\n\ntrusted_proxies\n: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy.\n\n\nallowed_protocols\n: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store \njavascript:\n links (bookmarklets) in Shaarli (default: \n[\"ftp\", \"ftps\", \"magnet\"]\n).\n\n\nResources\n\n\ndata_dir\n: Data directory.\n\n\ndatastore\n: Shaarli's links database file path.\n\n\nhistory\n: Shaarli's operation history file path.\n\nupdates\n: File path for the ran updates file.\n\n\nlog\n: Log file path.\n\n\nupdate_check\n: Last update check file path.\n\n\nraintpl_tpl\n: Templates directory.\n\n\nraintpl_tmp\n: Template engine cache directory.\n\n\nthumbnails_cache\n: Thumbnails cache directory.\n\n\npage_cache\n: Shaarli's internal cache directory.\n\n\nban_file\n: Banned IP file path.\n\n\nUpdates\n\n\ncheck_updates\n: Enable or disable update check to the git repository.\n\n\ncheck_updates_branch\n: Git branch used to check updates (e.g. \nstable\n or \nmaster\n).\n\n\ncheck_updates_interval\n: Look for new version every N seconds (default: every day).\n\n\nPrivacy\n\n\ndefault_private_links\n: Check the private checkbox by default for every new link.\n\n\nhide_public_links\n: All links are hidden while logged out.\n\n\nhide_timestamps\n: Timestamps are hidden.\n\n\nFeed\n\n\nrss_permalinks\n: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL.\n\n\nshow_atom\n: Display ATOM feed button.\n\n\nThumbnail\n\n\nenable_thumbnails\n: Enable or disable thumbnail display.\n\n\nenable_localcache\n: Enable or disable local cache.\n\n\nRedirector\n\n\nurl\n: Redirector URL, such as \nanonym.to\n.\n\n\nencode_url\n: Enable this if the redirector needs encoded URL to work properly.\n\n\nConfiguration file example\n\n\n<?php /*\n{\n    \"credentials\": {\n        \"login\": \"<login>\",\n        \"hash\": \"<password hash>\",\n        \"salt\": \"<password salt>\"\n    },\n    \"security\": {\n        \"ban_after\": 4,\n        \"session_protection_disabled\": false,\n        \"ban_duration\": 1800,\n        \"trusted_proxies\": [\n            \"1.2.3.4\",\n            \"5.6.7.8\"\n        ],\n        \"allowed_protocols\": [\n            \"ftp\",\n            \"ftps\",\n            \"magnet\"\n        ]\n    },\n    \"resources\": {\n        \"data_dir\": \"data\",\n        \"config\": \"data\\/config.php\",\n        \"datastore\": \"data\\/datastore.php\",\n        \"ban_file\": \"data\\/ipbans.php\",\n        \"updates\": \"data\\/updates.txt\",\n        \"log\": \"data\\/log.txt\",\n        \"update_check\": \"data\\/lastupdatecheck.txt\",\n        \"raintpl_tmp\": \"tmp\\/\",\n        \"raintpl_tpl\": \"tpl\\/\",\n        \"thumbnails_cache\": \"cache\",\n        \"page_cache\": \"pagecache\"\n    },\n    \"general\": {\n        \"check_updates\": true,\n        \"rss_permalinks\": true,\n        \"links_per_page\": 20,\n        \"default_private_links\": true,\n        \"enable_thumbnails\": true,\n        \"enable_localcache\": true,\n        \"check_updates_branch\": \"stable\",\n        \"check_updates_interval\": 86400,\n        \"enabled_plugins\": [\n            \"markdown\",\n            \"wallabag\",\n            \"archiveorg\"\n        ],\n        \"timezone\": \"Europe\\/Paris\",\n        \"title\": \"My Shaarli\",\n        \"header_link\": \"?\"\n    },\n    \"extras\": {\n        \"show_atom\": false,\n        \"hide_public_links\": false,\n        \"hide_timestamps\": false,\n        \"open_shaarli\": false,\n        \"redirector\": \"http://anonym.to/?\",\n        \"redirector_encode_url\": false\n    },\n    \"general\": {\n        \"header_link\": \"?\",\n        \"links_per_page\": 20,\n        \"enabled_plugins\": [\n            \"markdown\",\n            \"wallabag\"\n        ],\n        \"timezone\": \"Europe\\/Paris\",\n        \"title\": \"My Shaarli\"\n    },\n    \"updates\": {\n        \"check_updates\": true,\n        \"check_updates_branch\": \"stable\",\n        \"check_updates_interval\": 86400\n    },\n    \"feed\": {\n        \"rss_permalinks\": true,\n        \"show_atom\": false\n    },\n    \"privacy\": {\n        \"default_private_links\": true,\n        \"hide_public_links\": false,\n        \"hide_timestamps\": false\n    },\n    \"thumbnail\": {\n        \"enable_thumbnails\": true,\n        \"enable_localcache\": true\n    },\n    \"redirector\": {\n        \"url\": \"http://anonym.to/?\",\n        \"encode_url\": false\n    },\n    \"plugins\": {\n        \"WALLABAG_URL\": \"http://demo.wallabag.org\",\n        \"WALLABAG_VERSION\": \"1\"\n    }\n} ?>\n\n\n\n\nAdditional configuration\n\n\nThe playvideos plugin may require that you adapt your server's \n\nContent Security Policy\n \nconfiguration to work properly.",
             "title": "Shaarli configuration"
         },
         {
         },
         {
             "location": "/Shaarli-configuration/#file-and-directory-permissions",
-            "text": "The server process running Shaarli must have:\n-  read  access to the following resources:\n    - PHP scripts:  index.php ,  application/*.php ,  plugins/*.php \n    - 3rd party PHP and Javascript libraries:  inc/*.php ,  inc/*.js \n    - static assets:\n        - CSS stylesheets:  inc/*.css \n        -  images/* \n    - RainTPL templates:  tpl/*.html \n-  read ,  write  and  execution  access to the following directories:\n    -  cache  - thumbnail cache\n    -  data  - link data store, configuration options\n    -  pagecache  - Atom/RSS feed cache\n    -  tmp  - RainTPL page cache  On a Linux distribution:\n- the web server user will likely be  www  or  http  (for Apache2)\n- it will be a member of a group of the same name:  www:www ,  http:http \n- to give it access to Shaarli, either:\n    - unzip Shaarli in the default web server location (usually  /var/www/ ) and set the web server user as the owner\n    - put users in the same group as the web server, and set the appropriate access rights\n- if you have a domain / subdomain to serve Shaarli,  configure the server  accordingly",
+            "text": "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",
             "title": "File and directory permissions"
         },
         {
             "title": "Third party plugins"
         },
         {
-            "location": "/Docker-101/",
+            "location": "/docker/docker-101/",
             "text": "Basics\n\n\nInstall \nDocker\n, by following the instructions relevant\nto your OS / distribution, and start the service.\n\n\nSearch an image on \nDockerHub\n\n\n$ docker search debian\n\nNAME            DESCRIPTION                                     STARS   OFFICIAL   AUTOMATED\nubuntu          Ubuntu is a Debian-based Linux operating s...   2065    [OK]\ndebian          Debian is a Linux distribution that's comp...   603     [OK]\ngoogle/debian                                                   47                 [OK]\n\n\n\n\nShow available tags for a repository\n\n\n$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool\n\n% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current\nDload  Upload   Total   Spent    Left  Speed\n100  1283    0  1283    0     0    433      0 --:--:--  0:00:02 --:--:--   433\n\n\n\n\nSample output:\n\n\n[\n    {\n        \"layer\": \"85a02782\",\n        \"name\": \"stretch\"\n    },\n    {\n        \"layer\": \"59abecbc\",\n        \"name\": \"testing\"\n    },\n    {\n        \"layer\": \"bf0fd686\",\n        \"name\": \"unstable\"\n    },\n    {\n        \"layer\": \"60c52dbe\",\n        \"name\": \"wheezy\"\n    },\n    {\n        \"layer\": \"c5b806fe\",\n        \"name\": \"wheezy-backports\"\n    }\n]\n\n\n\n\n\nPull an image from DockerHub\n\n\n$ docker pull repository[:tag]\n\n$ docker pull debian:wheezy\nwheezy: Pulling from debian\n4c8cbfd2973e: Pull complete\n60c52dbe9d91: Pull complete\nDigest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe\nStatus: Downloaded newer image for debian:wheezy",
             "title": "Docker 101"
         },
         {
-            "location": "/Docker-101/#basics",
+            "location": "/docker/docker-101/#basics",
             "text": "Install  Docker , by following the instructions relevant\nto your OS / distribution, and start the service.",
             "title": "Basics"
         },
         {
-            "location": "/Docker-101/#search-an-image-on-dockerhub",
+            "location": "/docker/docker-101/#search-an-image-on-dockerhub",
             "text": "$ docker search debian\n\nNAME            DESCRIPTION                                     STARS   OFFICIAL   AUTOMATED\nubuntu          Ubuntu is a Debian-based Linux operating s...   2065    [OK]\ndebian          Debian is a Linux distribution that's comp...   603     [OK]\ngoogle/debian                                                   47                 [OK]",
             "title": "Search an image on DockerHub"
         },
         {
-            "location": "/Docker-101/#show-available-tags-for-a-repository",
+            "location": "/docker/docker-101/#show-available-tags-for-a-repository",
             "text": "$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool\n\n% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current\nDload  Upload   Total   Spent    Left  Speed\n100  1283    0  1283    0     0    433      0 --:--:--  0:00:02 --:--:--   433  Sample output:  [\n    {\n        \"layer\": \"85a02782\",\n        \"name\": \"stretch\"\n    },\n    {\n        \"layer\": \"59abecbc\",\n        \"name\": \"testing\"\n    },\n    {\n        \"layer\": \"bf0fd686\",\n        \"name\": \"unstable\"\n    },\n    {\n        \"layer\": \"60c52dbe\",\n        \"name\": \"wheezy\"\n    },\n    {\n        \"layer\": \"c5b806fe\",\n        \"name\": \"wheezy-backports\"\n    }\n]",
             "title": "Show available tags for a repository"
         },
         {
-            "location": "/Docker-101/#pull-an-image-from-dockerhub",
+            "location": "/docker/docker-101/#pull-an-image-from-dockerhub",
             "text": "$ docker pull repository[:tag]\n\n$ docker pull debian:wheezy\nwheezy: Pulling from debian\n4c8cbfd2973e: Pull complete\n60c52dbe9d91: Pull complete\nDigest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe\nStatus: Downloaded newer image for debian:wheezy",
             "title": "Pull an image from DockerHub"
         },
         {
-            "location": "/Shaarli-images/",
-            "text": "Get and run a Shaarli image\n\n\nDockerHub repository\n\n\nThe images can be found in the \nshaarli/shaarli\n\nrepository.\n\n\nAvailable image tags\n\n\n\n\nlatest\n: master branch (tarball release)\n\n\nstable\n: stable branch (tarball release)\n\n\ndev\n: master branch (Git clone)\n\n\n\n\nAll images rely on:\n- \nDebian 8 Jessie\n\n- \nPHP5-FPM\n\n- \nNginx\n\n\nDownload from DockerHub\n\n\n$ docker pull shaarli/shaarli\nlatest: Pulling from shaarli/shaarli\n32716d9fcddb: Pull complete\n84899d045435: Pull complete\n4b6ad7444763: Pull complete\ne0345ef7a3e0: Pull complete\n5c1dd344094f: Pull complete\n6422305a200b: Pull complete\n7d63f861dbef: Pull complete\n3eb97210645c: Pull complete\n869319d746ff: Already exists\n869319d746ff: Pulling fs layer\n902b87aaaec9: Already exists\nDigest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98\nStatus: Downloaded newer image for shaarli/shaarli:latest\n\n\n\n\nCreate and start a new container from the image\n\n\n# map the host's :8000 port to the container's :80 port\n$ docker create -p 8000:80 shaarli/shaarli\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# launch the container in the background\n$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# list active containers\n$ docker ps\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES\nd40b7af693d6  shaarli/shaarli  /usr/bin/supervisor  15 seconds ago  Up 4 seconds  0.0.0.0:8000->80/tcp  backstabbing_galileo\n\n\n\n\nStop and destroy a container\n\n\n$ docker stop backstabbing_galileo  # those docker guys are really rude to physicists!\nbackstabbing_galileo\n\n# check the container is stopped\n$ docker ps\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES\n\n# list ALL containers\n$ docker ps -a\nCONTAINER ID        IMAGE               COMMAND                CREATED             STATUS                      PORTS               NAMES\nd40b7af693d6        shaarli/shaarli     /usr/bin/supervisor   5 minutes ago       Exited (0) 48 seconds ago                       backstabbing_galileo\n\n# destroy the container\n$ docker rm backstabbing_galileo  # let's put an end to these barbarian practices\nbackstabbing_galileo\n\n$ docker ps -a\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES",
+            "location": "/docker/shaarli-images/",
+            "text": "Get and run a Shaarli image\n\n\nDockerHub repository\n\n\nThe images can be found in the \nshaarli/shaarli\n\nrepository.\n\n\nAvailable image tags\n\n\n\n\nlatest\n: master branch (tarball release)\n\n\nstable\n: stable branch (tarball release)\n\n\n\n\nAll images rely on:\n- \nDebian 8 Jessie\n\n- \nPHP5-FPM\n\n- \nNginx\n\n\nDownload from DockerHub\n\n\n$ docker pull shaarli/shaarli\nlatest: Pulling from shaarli/shaarli\n32716d9fcddb: Pull complete\n84899d045435: Pull complete\n4b6ad7444763: Pull complete\ne0345ef7a3e0: Pull complete\n5c1dd344094f: Pull complete\n6422305a200b: Pull complete\n7d63f861dbef: Pull complete\n3eb97210645c: Pull complete\n869319d746ff: Already exists\n869319d746ff: Pulling fs layer\n902b87aaaec9: Already exists\nDigest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98\nStatus: Downloaded newer image for shaarli/shaarli:latest\n\n\n\n\nCreate and start a new container from the image\n\n\n# map the host's :8000 port to the container's :80 port\n$ docker create -p 8000:80 shaarli/shaarli\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# launch the container in the background\n$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# list active containers\n$ docker ps\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES\nd40b7af693d6  shaarli/shaarli  /usr/bin/supervisor  15 seconds ago  Up 4 seconds  0.0.0.0:8000->80/tcp  backstabbing_galileo\n\n\n\n\nStop and destroy a container\n\n\n$ docker stop backstabbing_galileo  # those docker guys are really rude to physicists!\nbackstabbing_galileo\n\n# check the container is stopped\n$ docker ps\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES\n\n# list ALL containers\n$ docker ps -a\nCONTAINER ID        IMAGE               COMMAND                CREATED             STATUS                      PORTS               NAMES\nd40b7af693d6        shaarli/shaarli     /usr/bin/supervisor   5 minutes ago       Exited (0) 48 seconds ago                       backstabbing_galileo\n\n# destroy the container\n$ docker rm backstabbing_galileo  # let's put an end to these barbarian practices\nbackstabbing_galileo\n\n$ docker ps -a\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES",
             "title": "Shaarli images"
         },
         {
-            "location": "/Shaarli-images/#get-and-run-a-shaarli-image",
+            "location": "/docker/shaarli-images/#get-and-run-a-shaarli-image",
             "text": "",
             "title": "Get and run a Shaarli image"
         },
         {
-            "location": "/Shaarli-images/#dockerhub-repository",
+            "location": "/docker/shaarli-images/#dockerhub-repository",
             "text": "The images can be found in the  shaarli/shaarli \nrepository.",
             "title": "DockerHub repository"
         },
         {
-            "location": "/Shaarli-images/#available-image-tags",
-            "text": "latest : master branch (tarball release)  stable : stable branch (tarball release)  dev : master branch (Git clone)   All images rely on:\n-  Debian 8 Jessie \n-  PHP5-FPM \n-  Nginx",
+            "location": "/docker/shaarli-images/#available-image-tags",
+            "text": "latest : master branch (tarball release)  stable : stable branch (tarball release)   All images rely on:\n-  Debian 8 Jessie \n-  PHP5-FPM \n-  Nginx",
             "title": "Available image tags"
         },
         {
-            "location": "/Shaarli-images/#download-from-dockerhub",
+            "location": "/docker/shaarli-images/#download-from-dockerhub",
             "text": "$ docker pull shaarli/shaarli\nlatest: Pulling from shaarli/shaarli\n32716d9fcddb: Pull complete\n84899d045435: Pull complete\n4b6ad7444763: Pull complete\ne0345ef7a3e0: Pull complete\n5c1dd344094f: Pull complete\n6422305a200b: Pull complete\n7d63f861dbef: Pull complete\n3eb97210645c: Pull complete\n869319d746ff: Already exists\n869319d746ff: Pulling fs layer\n902b87aaaec9: Already exists\nDigest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98\nStatus: Downloaded newer image for shaarli/shaarli:latest",
             "title": "Download from DockerHub"
         },
         {
-            "location": "/Shaarli-images/#create-and-start-a-new-container-from-the-image",
+            "location": "/docker/shaarli-images/#create-and-start-a-new-container-from-the-image",
             "text": "# map the host's :8000 port to the container's :80 port\n$ docker create -p 8000:80 shaarli/shaarli\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# launch the container in the background\n$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\nd40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101\n\n# list active containers\n$ docker ps\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES\nd40b7af693d6  shaarli/shaarli  /usr/bin/supervisor  15 seconds ago  Up 4 seconds  0.0.0.0:8000->80/tcp  backstabbing_galileo",
             "title": "Create and start a new container from the image"
         },
         {
-            "location": "/Shaarli-images/#stop-and-destroy-a-container",
+            "location": "/docker/shaarli-images/#stop-and-destroy-a-container",
             "text": "$ docker stop backstabbing_galileo  # those docker guys are really rude to physicists!\nbackstabbing_galileo\n\n# check the container is stopped\n$ docker ps\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES\n\n# list ALL containers\n$ docker ps -a\nCONTAINER ID        IMAGE               COMMAND                CREATED             STATUS                      PORTS               NAMES\nd40b7af693d6        shaarli/shaarli     /usr/bin/supervisor   5 minutes ago       Exited (0) 48 seconds ago                       backstabbing_galileo\n\n# destroy the container\n$ docker rm backstabbing_galileo  # let's put an end to these barbarian practices\nbackstabbing_galileo\n\n$ docker ps -a\nCONTAINER ID  IMAGE            COMMAND               CREATED         STATUS        PORTS                 NAMES",
             "title": "Stop and destroy a container"
         },
         {
-            "location": "/Reverse-proxy-configuration/",
+            "location": "/docker/reverse-proxy-configuration/",
             "text": "TODO, see https://github.com/shaarli/Shaarli/issues/888\n\n\nHAProxy\n\n\nNginx",
             "title": "Reverse proxy configuration"
         },
         {
-            "location": "/Reverse-proxy-configuration/#haproxy",
+            "location": "/docker/reverse-proxy-configuration/#haproxy",
             "text": "",
             "title": "HAProxy"
         },
         {
-            "location": "/Reverse-proxy-configuration/#nginx",
+            "location": "/docker/reverse-proxy-configuration/#nginx",
             "text": "",
             "title": "Nginx"
         },
         {
-            "location": "/Docker-resources/",
+            "location": "/docker/resources/",
             "text": "Docker\n\n\n\n\nInteractive Docker training portal\n on \nKatakoda\n\n\nWhere are Docker images stored?\n\n\nDockerfile reference\n\n\nDockerfile best practices\n\n\nVolumes\n\n\n\n\nDockerHub\n\n\n\n\nRepositories\n\n\nTeams and organizations\n\n\nGitHub automated build\n\n\n\n\nService management\n\n\n\n\nUsing supervisord\n\n\nNginx in the foreground\n\n\nsupervisord",
             "title": "Docker resources"
         },
         {
-            "location": "/Docker-resources/#docker",
+            "location": "/docker/resources/#docker",
             "text": "Interactive Docker training portal  on  Katakoda  Where are Docker images stored?  Dockerfile reference  Dockerfile best practices  Volumes",
             "title": "Docker"
         },
         {
-            "location": "/Docker-resources/#dockerhub",
+            "location": "/docker/resources/#dockerhub",
             "text": "Repositories  Teams and organizations  GitHub automated build",
             "title": "DockerHub"
         },
         {
-            "location": "/Docker-resources/#service-management",
+            "location": "/docker/resources/#service-management",
             "text": "Using supervisord  Nginx in the foreground  supervisord",
             "title": "Service management"
         },