- 472 ArthurHoaro <arthur@hoa.ro>
- 201 VirtualTam <virtualtam@flibidi.net>
- 132 nodiscc <nodiscc@gmail.com>
+ 506 ArthurHoaro <arthur@hoa.ro>
+ 204 VirtualTam <virtualtam@flibidi.net>
+ 147 nodiscc <nodiscc@gmail.com>
56 Sébastien Sauvage <sebsauvage@sebsauvage.net>
15 Florian Eula <eula.florian@gmail.com>
13 Emilien Klein <emilien@klein.st>
8 Christophe HENRY <christophe.henry@sbgodin.fr>
4 Alexandre Alapetite <alexandre@alapetite.fr>
4 David Sferruzza <david.sferruzza@gmail.com>
+ 3 Lucas Cimon <lucas.cimon@gmail.com>
3 Teromene <teromene@teromene.fr>
+ 3 kalvn <kalvnthereal@gmail.com>
2 Chris Kuethe <chris.kuethe@gmail.com>
2 Knah Tsaeb <Knah-Tsaeb@knah-tsaeb.org>
2 Mathieu Chabanon <git@matchab.fr>
2 Miloš Jovanović <mjovanovic@gmail.com>
2 Qwerty <champlywood@free.fr>
+ 2 Stephen Muth <smuth4@gmail.com>
2 Timo Van Neerden <fire@lehollandaisvolant.net>
2 julienCXX <software@chmodplusx.eu>
- 2 kalvn <kalvnthereal@gmail.com>
+ 2 philipp-r <philipp-r@users.noreply.github.com>
1 Adrien Oliva <adrien.oliva@yapbreak.fr>
1 Alexis J <alexis@effingo.be>
1 BoboTiG <bobotig@gmail.com>
1 Sbgodin <Sbgodin@users.noreply.github.com>
1 TsT <tst2005@gmail.com>
1 dimtion <zizou.xena@gmail.com>
- 1 philipp-r <philipp-r@users.noreply.github.com>
+++ /dev/null
-#Docker
-- [Docker usage](#docker-usage)[](.html)
-- [Get and run a Shaarli image](#get-and-run-a-shaarli-image)[](.html)
-- [Resources](#resources)[](.html)
-
-## Docker usage
-### Basics
-Install [Docker](https://www.docker.com/), by following the instructions relevant[](.html)
-to your OS / distribution, and start the service.
-
-#### Search an image on [DockerHub](https://hub.docker.com/)[](.html)
-
-```bash
-$ docker search debian
-
-NAME DESCRIPTION STARS OFFICIAL AUTOMATED
-ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK][](.html)
-debian Debian is a Linux distribution that's comp... 603 [OK][](.html)
-google/debian 47 [OK][](.html)
-```
-
-#### Show available tags for a repository
-```bash
-$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool
-
-% Total % Received % Xferd Average Speed Time Time Time Current
-Dload Upload Total Spent Left Speed
-100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433
-```
-
-Sample output:
-```json
-[[](.html)
- {
- "layer": "85a02782",
- "name": "stretch"
- },
- {
- "layer": "59abecbc",
- "name": "testing"
- },
- {
- "layer": "bf0fd686",
- "name": "unstable"
- },
- {
- "layer": "60c52dbe",
- "name": "wheezy"
- },
- {
- "layer": "c5b806fe",
- "name": "wheezy-backports"
- }
-]
-
-```
-
-#### Pull an image from DockerHub
-```bash
-$ docker pull repository[:tag][](.html)
-
-$ docker pull debian:wheezy
-wheezy: Pulling from debian
-4c8cbfd2973e: Pull complete
-60c52dbe9d91: Pull complete
-Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
-Status: Downloaded newer image for debian:wheezy
-```
-
-## Get and run a Shaarli image
-### DockerHub repository
-The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/)[](.html)
-repository.
-
-### Available image tags
-- `latest`: master branch (tarball release)
-- `stable`: stable branch (tarball release)
-- `dev`: master branch (Git clone)
-
-All images rely on:
-- [Debian 8 Jessie](https://hub.docker.com/_/debian/)[](.html)
-- [PHP5-FPM](http://php-fpm.org/)[](.html)
-- [Nginx](http://nginx.org/)[](.html)
-
-### Download from DockerHub
-```bash
-$ docker pull shaarli/shaarli
-latest: Pulling from shaarli/shaarli
-32716d9fcddb: Pull complete
-84899d045435: Pull complete
-4b6ad7444763: Pull complete
-e0345ef7a3e0: Pull complete
-5c1dd344094f: Pull complete
-6422305a200b: Pull complete
-7d63f861dbef: Pull complete
-3eb97210645c: Pull complete
-869319d746ff: Already exists
-869319d746ff: Pulling fs layer
-902b87aaaec9: Already exists
-Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
-Status: Downloaded newer image for shaarli/shaarli:latest
-```
-
-### Create and start a new container from the image
-```bash
-# map the host's :8000 port to the container's :80 port
-$ docker create -p 8000:80 shaarli/shaarli
-d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
-
-# launch the container in the background
-$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
-d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
-
-# list active containers
-$ docker ps
-CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
-d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo
-```
-
-### Stop and destroy a container
-```bash
-$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!
-backstabbing_galileo
-
-# check the container is stopped
-$ docker ps
-CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
-
-# list ALL containers
-$ docker ps -a
-CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
-d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo
-
-# destroy the container
-$ docker rm backstabbing_galileo # let's put an end to these barbarian practices
-backstabbing_galileo
-
-$ docker ps -a
-CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
-```
-
-## Resources
-### Docker
-- [Interactive Docker training portal](https://www.katacoda.com/courses/docker/) on [Katakoda](https://www.katacoda.com/)[](.html)
-- [Where are Docker images stored?](http://blog.thoward37.me/articles/where-are-docker-images-stored/)[](.html)
-- [Dockerfile reference](https://docs.docker.com/reference/builder/)[](.html)
-- [Dockerfile best practices](https://docs.docker.com/articles/dockerfile_best-practices/)[](.html)
-- [Volumes](https://docs.docker.com/userguide/dockervolumes/)[](.html)
-
-### DockerHub
-- [Repositories](https://docs.docker.com/userguide/dockerrepos/)[](.html)
-- [Teams and organizations](https://docs.docker.com/docker-hub/orgs/)[](.html)
-- [GitHub automated build](https://docs.docker.com/docker-hub/github/)[](.html)
-
-### Service management
-- [Using supervisord](https://docs.docker.com/articles/using_supervisord/)[](.html)
-- [Nginx in the foreground](http://nginx.org/en/docs/ngx_core_module.html#daemon)[](.html)
-- [supervisord](http://supervisord.org/)[](.html)
+++ /dev/null
-#REST API
-## Usage
-
-See the [REST API documentation](http://shaarli.github.io/api-documentation/).[](.html)
-
-## Authentication
-
-All requests to Shaarli's API must include a JWT token to verify their authenticity.
-
-This token has to be included as an HTTP header called `Authentication: Bearer <jwt token>`.
-
-JWT resources :
-
- * [jwt.io](https://jwt.io) (including a list of client per language).[](.html)
- * RFC : https://tools.ietf.org/html/rfc7519
- * https://float-middle.com/json-web-tokens-jwt-vs-sessions/
- * HackerNews thread: https://news.ycombinator.com/item?id=11929267
-
-
-### Shaarli JWT Token
-
-JWT tokens are composed by three parts, separated by a dot `.` and encoded in base64:
-
-```
-[header].[payload].[signature][](.html)
-```
-
-#### Header
-
-Shaarli only allow one hash algorithm, so the header will always be the same:
-
-```json
-{
- "typ": "JWT",
- "alg": "HS512"
-}
-```
-
-Encoded in base64, it gives:
-
-```
-ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==
-```
-
-#### Payload
-
-**Validity duration**
-
-To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key `iat` (issued at). This token will be accepted during 9 minutes.
-
-```json
-{
- "iat": 1468663519
-}
-```
-
-See [RFC reference](https://tools.ietf.org/html/rfc7519#section-4.1.6).[](.html)
-
-
-#### Signature
-
-The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot `.`, hashed in SHA512 with the API secret available in Shaarli administration page.
-
-Signature example with PHP:
-
-```php
-$content = base64_encode($header) . '.' . base64_encode($payload);
-$signature = hash_hmac('sha512', $content, $secret);
-```
-
-
-### Complete example
-
-#### PHP
-
-```php
-function generateToken($secret) {
- $header = base64_encode('{
- "typ": "JWT",
- "alg": "HS512"
- }');
- $payload = base64_encode('{
- "iat": '. time() .'
- }');
- $signature = hash_hmac('sha512', $header .'.'. $payload , $secret);
- return $header .'.'. $payload .'.'. $signature;
-}
-
-$secret = 'mysecret';
-$token = generateToken($secret);
-echo $token;
-```
-
-> `ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68`
-
-```php
-$options = [[](.html)
- 'http' => [[](.html)
- 'method' => 'GET',
- 'jwt' => $token,
- ],
-];
-$context = stream_context_create($options);
-file_get_contents($apiEndpoint, false, $context);
-```
+++ /dev/null
-#Versioning and Branches
-[**WORK IN PROGRESS**][](.html)
-
-It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible.
-
-## `master` branch
-
-The `master` branch is the development branch. Any new change MUST go through this branch using Pull Requests.
-
-Remarks:
-
- * This branch shouldn't be used for production as it isn't necessary stable.
- * 3rd party aren't required to be compatible with the latest changes.
- * Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch.
- * The version in this branch is always `dev`.
-
-## `v0.x` branch
-
-This `v0.x` branch, points to the latest `v0.x.y` release.
-
-Explanation:
-
-When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli.
-
-In this case, the issue is fixed in the `master` branch, and the fix is backported the to the `v0.x` branch. Then a new release is made from the `v0.x` branch.
-
-This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon.
-
-## `latest` branch
-
-This branch point the latest release. It recommended to use it to get the latest tested changes.
-
-## `stable` branch
-
-The `stable` branch doesn't contain any major bug, and is one major digit version behind the latest release.
-
-For example, the current latest release is `v0.8.3`, the stable branch is an alias to the latest `v0.7.x` release. When the `v0.9.0` version will be released, the stable will move to the latest `v0.8.x` release.
-
-Remarks:
-
- * Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release.
-
-## Releases
-
-Releases are always made from the latest `v0.x` branch.
-
-Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step.
-
-## Advices on 3rd party git repos workflow
-
-### Versioning
-
-Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the [changelog](https://github.com/shaarli/Shaarli/releases) (*Draft* means not released yet) and the commit log (like [`tpl` folder](https://github.com/shaarli/Shaarli/commits/master/tpl/default) for themes)). You can either:[](.html)
-
- - use the Shaarli version number, with your repo version. For example, if Shaarli `v0.8.3` is released, publish a `v0.8.3-1` release, where `v0.8.3` states Shaarli compatibility and `-1` is your own version digit for the current Shaarli version.
- - use your own versioning scheme, and state Shaarli compatibility in the release description.
-
-Using this, any user will be able to pick the release matching his own Shaarli version.
-
-### Major bugfix backport releases
-
-To be able to support backported fixes, it recommended to use our workflow:
-
-```bash
-# In master, fix the major bug
-git commit -m "Katastrophe"
-git push origin master
-# Get your commit hash
-git log --format="%H" -n 1
-# Create a new branch from your latest release, let's say v0.8.2-1 (the tag name)
-git checkout -b katastrophe v0.8.2-1
-# Backport the fix commit to your brand new branch
-git cherry-pick <fix commit hash>
-git push origin katastrophe
-# Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1`
-```
+++ /dev/null
-#_Sidebar
-- [Home](Home.html)
-- Setup
- - [Download and Installation](Download-and-Installation.html)
- - [Upgrade and migration](Upgrade-and-migration.html)
- - [Server requirements](Server-requirements.html)
- - [Server configuration](Server-configuration.html)
- - [Server security](Server-security.html)
- - [Shaarli configuration](Shaarli-configuration.html)
- - [Plugins](Plugins.html)
-- [Docker](Docker.html)
-- [Usage](Usage.html)
- - [Sharing button](Sharing-button.html) (bookmarklet)
- - [Browsing and Searching](Browsing-and-Searching.html)
- - [Firefox share](Firefox-share.html)
- - [RSS feeds](RSS-feeds.html)
- - [REST API](REST-API.html)
-- How To
- - [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)
- - [Create and serve multiple Shaarlis (farm)](Create-and-serve-multiple-Shaarlis-(farm).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)
- - [Coding guidelines](Coding-guidelines.html)
- - [Directory structure](Directory-structure.html)
- - [3rd party libraries](3rd-party-libraries.html)
- - [Plugin System](Plugin-System.html)
- - [Release Shaarli](Release-Shaarli.html)
- - [Versioning and Branches](Versioning-and-Branches.html)
- - [Security](Security.html)
- - [Static analysis](Static-analysis.html)
- - [Theming](Theming.html)
- - [Unit tests](Unit-tests.html)
-- About
- - [FAQ](FAQ.html)
- - [Community & Related software](Community-&-Related-software.html)
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<a href="../Bookmarklet/" class="btn btn-neutral float-right" title="Bookmarklet">Next <span class="icon icon-circle-arrow-right"></span></a>
- <a href="../Docker-resources/" class="btn btn-neutral" title="Docker resources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+ <a href="../docker/resources/" class="btn btn-neutral" title="Docker resources"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
- <span><a href="../Docker-resources/" style="color: #fcfcfc;">« Previous</a></span>
+ <span><a href="../docker/resources/" style="color: #fcfcfc;">« Previous</a></span>
<span style="margin-left: 15px"><a href="../Bookmarklet/" style="color: #fcfcfc">Next »</a></span>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../Docker-101/" class="btn btn-neutral float-right" title="Docker 101">Next <span class="icon icon-circle-arrow-right"></span></a>
+ <a href="../docker/docker-101/" class="btn btn-neutral float-right" title="Docker 101">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../Shaarli-configuration/" class="btn btn-neutral" title="Shaarli configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<span><a href="../Shaarli-configuration/" style="color: #fcfcfc;">« Previous</a></span>
- <span style="margin-left: 15px"><a href="../Docker-101/" style="color: #fcfcfc">Next »</a></span>
+ <span style="margin-left: 15px"><a href="../docker/docker-101/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<em> its values override those defined in <code>index.php</code>
</em> it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration</p>
<h2 id="file-and-directory-permissions">File and directory permissions</h2>
-<p>The server process running Shaarli must have:
-- <code>read</code> access to the following resources:
- - PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code>
- - 3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code>
- - static assets:
- - CSS stylesheets: <code>inc/*.css</code>
- - <code>images/*</code>
- - RainTPL templates: <code>tpl/*.html</code>
-- <code>read</code>, <code>write</code> and <code>execution</code> access to the following directories:
- - <code>cache</code> - thumbnail cache
- - <code>data</code> - link data store, configuration options
- - <code>pagecache</code> - Atom/RSS feed cache
- - <code>tmp</code> - RainTPL page cache</p>
-<p>On a Linux distribution:
-- the web server user will likely be <code>www</code> or <code>http</code> (for Apache2)
-- it will be a member of a group of the same name: <code>www:www</code>, <code>http:http</code>
-- to give it access to Shaarli, either:
- - unzip Shaarli in the default web server location (usually <code>/var/www/</code>) 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, <a href="../Server-configuration">configure the server</a> accordingly<a href="../.html"></a></p>
+<p>The server process running Shaarli must have:</p>
+<ul>
+<li><code>read</code> access to the following resources:<ul>
+<li>PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code></li>
+<li>3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code></li>
+<li>static assets:<ul>
+<li>CSS stylesheets: <code>inc/*.css</code></li>
+<li><code>images/*</code></li>
+</ul>
+</li>
+<li>RainTPL templates: <code>tpl/*.html</code></li>
+</ul>
+</li>
+<li><code>read</code>, <code>write</code> and <code>execution</code> access to the following directories:<ul>
+<li><code>cache</code> - thumbnail cache</li>
+<li><code>data</code> - link data store, configuration options</li>
+<li><code>pagecache</code> - Atom/RSS feed cache</li>
+<li><code>tmp</code> - RainTPL page cache</li>
+</ul>
+</li>
+</ul>
+<p>On a Linux distribution:</p>
+<ul>
+<li>the web server user will likely be <code>www</code> or <code>http</code> (for Apache2)</li>
+<li>it will be a member of a group of the same name: <code>www:www</code>, <code>http:http</code></li>
+<li>to give it access to Shaarli, either:<ul>
+<li>unzip Shaarli in the default web server location (usually <code>/var/www/</code>) and set the web server user as the owner</li>
+<li>put users in the same group as the web server, and set the appropriate access rights</li>
+</ul>
+</li>
+<li>if you have a domain / subdomain to serve Shaarli, <a href="../Server-configuration">configure the server</a> accordingly<a href="../.html"></a></li>
+</ul>
<h2 id="configuration">Configuration</h2>
<p>In <code>data/config.json.php</code>.</p>
<p>See also <a href="../Plugin-System.html">Plugin System</a>.</p>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <link rel="shortcut icon" href="../img/favicon.ico">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
<title>Docker 101 - Shaarli Documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="../css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
- <link rel="stylesheet" href="../css/highlight.css">
- <link href="../github-markdown.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../github-markdown.css" rel="stylesheet">
<script>
// Current page data
var mkdocs_page_name = "Docker 101";
- var mkdocs_page_input_path = "Docker-101.md";
- var mkdocs_page_url = "/Docker-101/";
+ var mkdocs_page_input_path = "docker/docker-101.md";
+ var mkdocs_page_url = "/docker/docker-101/";
</script>
- <script src="../js/jquery-2.1.1.min.js"></script>
- <script src="../js/modernizr-2.8.3.min.js"></script>
- <script type="text/javascript" src="../js/highlight.pack.js"></script>
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
</head>
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
- <a href=".." class="icon icon-home"> Shaarli Documentation</a>
+ <a href="../.." class="icon icon-home"> Shaarli Documentation</a>
<div role="search">
- <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
<li class="toctree-l1">
- <a class="" href="..">Home</a>
+ <a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Download-and-Installation/">Download and Installation</a>
+ <a class="" href="../../Download-and-Installation/">Download and Installation</a>
</li>
<li class="">
- <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
+ <a class="" href="../../Upgrade-and-migration/">Upgrade and migration</a>
</li>
<li class="">
- <a class="" href="../Server-requirements/">Server requirements</a>
+ <a class="" href="../../Server-requirements/">Server requirements</a>
</li>
<li class="">
- <a class="" href="../Server-configuration/">Server configuration</a>
+ <a class="" href="../../Server-configuration/">Server configuration</a>
</li>
<li class="">
- <a class="" href="../Server-security/">Server security</a>
+ <a class="" href="../../Server-security/">Server security</a>
</li>
<li class="">
- <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
+ <a class="" href="../../Shaarli-configuration/">Shaarli configuration</a>
</li>
<li class="">
- <a class="" href="../Plugins/">Plugins</a>
+ <a class="" href="../../Plugins/">Plugins</a>
</li>
</ul>
</li>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Features/">Features</a>
+ <a class="" href="../../Features/">Features</a>
</li>
<li class="">
- <a class="" href="../Bookmarklet/">Bookmarklet</a>
+ <a class="" href="../../Bookmarklet/">Bookmarklet</a>
</li>
<li class="">
- <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
+ <a class="" href="../../Browsing-and-searching/">Browsing and searching</a>
</li>
<li class="">
- <a class="" href="../Firefox-share/">Firefox share</a>
+ <a class="" href="../../Firefox-share/">Firefox share</a>
</li>
<li class="">
- <a class="" href="../RSS-feeds/">RSS feeds</a>
+ <a class="" href="../../RSS-feeds/">RSS feeds</a>
</li>
<li class="">
- <a class="" href="../REST-API/">REST API</a>
+ <a class="" href="../../REST-API/">REST API</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
+ <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
</li>
<li class="">
- <a class="" href="../Various-hacks/">Various hacks</a>
+ <a class="" href="../../Various-hacks/">Various hacks</a>
</li>
</ul>
</li>
<li class="toctree-l1">
- <a class="" href="../Troubleshooting/">Troubleshooting</a>
+ <a class="" href="../../Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Development-guidelines/">Development guidelines</a>
+ <a class="" href="../../Development-guidelines/">Development guidelines</a>
</li>
<li class="">
- <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
+ <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a>
</li>
<li class="">
- <a class="" href="../GnuPG-signature/">GnuPG signature</a>
+ <a class="" href="../../GnuPG-signature/">GnuPG signature</a>
</li>
<li class="">
- <a class="" href="../Coding-guidelines/">Coding guidelines</a>
+ <a class="" href="../../Coding-guidelines/">Coding guidelines</a>
</li>
<li class="">
- <a class="" href="../Directory-structure/">Directory structure</a>
+ <a class="" href="../../Directory-structure/">Directory structure</a>
</li>
<li class="">
- <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
+ <a class="" href="../../3rd-party-libraries/">3rd party libraries</a>
</li>
<li class="">
- <a class="" href="../Plugin-System/">Plugin System</a>
+ <a class="" href="../../Plugin-System/">Plugin System</a>
</li>
<li class="">
- <a class="" href="../Release-Shaarli/">Release Shaarli</a>
+ <a class="" href="../../Release-Shaarli/">Release Shaarli</a>
</li>
<li class="">
- <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
+ <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a>
</li>
<li class="">
- <a class="" href="../Security/">Security</a>
+ <a class="" href="../../Security/">Security</a>
</li>
<li class="">
- <a class="" href="../Static-analysis/">Static analysis</a>
+ <a class="" href="../../Static-analysis/">Static analysis</a>
</li>
<li class="">
- <a class="" href="../Theming/">Theming</a>
+ <a class="" href="../../Theming/">Theming</a>
</li>
<li class="">
- <a class="" href="../Unit-tests/">Unit tests</a>
+ <a class="" href="../../Unit-tests/">Unit tests</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../FAQ/">FAQ</a>
+ <a class="" href="../../FAQ/">FAQ</a>
</li>
<li class="">
- <a class="" href="../Community-&-Related-software/">Community & Related software</a>
+ <a class="" href="../../Community-&-Related-software/">Community & Related software</a>
</li>
</ul>
</li>
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="..">Shaarli Documentation</a>
+ <a href="../..">Shaarli Documentation</a>
</nav>
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="..">Docs</a> »</li>
+ <li><a href="../..">Docs</a> »</li>
<li>Docker 101</li>
<li class="wy-breadcrumbs-aside">
- <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Docker-101.md"
+ <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/docker-101.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../Shaarli-images/" class="btn btn-neutral float-right" title="Shaarli images">Next <span class="icon icon-circle-arrow-right"></span></a>
+ <a href="../shaarli-images/" class="btn btn-neutral float-right" title="Shaarli images">Next <span class="icon icon-circle-arrow-right"></span></a>
- <a href="../Plugins/" class="btn btn-neutral" title="Plugins"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+ <a href="../../Plugins/" class="btn btn-neutral" title="Plugins"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
- <span><a href="../Plugins/" style="color: #fcfcfc;">« Previous</a></span>
+ <span><a href="../../Plugins/" style="color: #fcfcfc;">« Previous</a></span>
- <span style="margin-left: 15px"><a href="../Shaarli-images/" style="color: #fcfcfc">Next »</a></span>
+ <span style="margin-left: 15px"><a href="../shaarli-images/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
- <script src="../js/theme.js"></script>
+ <script src="../../js/theme.js"></script>
</body>
</html>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <link rel="shortcut icon" href="../img/favicon.ico">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
<title>Docker resources - Shaarli Documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="../css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
- <link rel="stylesheet" href="../css/highlight.css">
- <link href="../github-markdown.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../github-markdown.css" rel="stylesheet">
<script>
// Current page data
var mkdocs_page_name = "Docker resources";
- var mkdocs_page_input_path = "Docker-resources.md";
- var mkdocs_page_url = "/Docker-resources/";
+ var mkdocs_page_input_path = "docker/resources.md";
+ var mkdocs_page_url = "/docker/resources/";
</script>
- <script src="../js/jquery-2.1.1.min.js"></script>
- <script src="../js/modernizr-2.8.3.min.js"></script>
- <script type="text/javascript" src="../js/highlight.pack.js"></script>
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
</head>
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
- <a href=".." class="icon icon-home"> Shaarli Documentation</a>
+ <a href="../.." class="icon icon-home"> Shaarli Documentation</a>
<div role="search">
- <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
<li class="toctree-l1">
- <a class="" href="..">Home</a>
+ <a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Download-and-Installation/">Download and Installation</a>
+ <a class="" href="../../Download-and-Installation/">Download and Installation</a>
</li>
<li class="">
- <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
+ <a class="" href="../../Upgrade-and-migration/">Upgrade and migration</a>
</li>
<li class="">
- <a class="" href="../Server-requirements/">Server requirements</a>
+ <a class="" href="../../Server-requirements/">Server requirements</a>
</li>
<li class="">
- <a class="" href="../Server-configuration/">Server configuration</a>
+ <a class="" href="../../Server-configuration/">Server configuration</a>
</li>
<li class="">
- <a class="" href="../Server-security/">Server security</a>
+ <a class="" href="../../Server-security/">Server security</a>
</li>
<li class="">
- <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
+ <a class="" href="../../Shaarli-configuration/">Shaarli configuration</a>
</li>
<li class="">
- <a class="" href="../Plugins/">Plugins</a>
+ <a class="" href="../../Plugins/">Plugins</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class=" current">
<ul class="subnav">
<li class="">
- <a class="" href="../Features/">Features</a>
+ <a class="" href="../../Features/">Features</a>
</li>
<li class="">
- <a class="" href="../Bookmarklet/">Bookmarklet</a>
+ <a class="" href="../../Bookmarklet/">Bookmarklet</a>
</li>
<li class="">
- <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
+ <a class="" href="../../Browsing-and-searching/">Browsing and searching</a>
</li>
<li class="">
- <a class="" href="../Firefox-share/">Firefox share</a>
+ <a class="" href="../../Firefox-share/">Firefox share</a>
</li>
<li class="">
- <a class="" href="../RSS-feeds/">RSS feeds</a>
+ <a class="" href="../../RSS-feeds/">RSS feeds</a>
</li>
<li class="">
- <a class="" href="../REST-API/">REST API</a>
+ <a class="" href="../../REST-API/">REST API</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
+ <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
</li>
<li class="">
- <a class="" href="../Various-hacks/">Various hacks</a>
+ <a class="" href="../../Various-hacks/">Various hacks</a>
</li>
</ul>
</li>
<li class="toctree-l1">
- <a class="" href="../Troubleshooting/">Troubleshooting</a>
+ <a class="" href="../../Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Development-guidelines/">Development guidelines</a>
+ <a class="" href="../../Development-guidelines/">Development guidelines</a>
</li>
<li class="">
- <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
+ <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a>
</li>
<li class="">
- <a class="" href="../GnuPG-signature/">GnuPG signature</a>
+ <a class="" href="../../GnuPG-signature/">GnuPG signature</a>
</li>
<li class="">
- <a class="" href="../Coding-guidelines/">Coding guidelines</a>
+ <a class="" href="../../Coding-guidelines/">Coding guidelines</a>
</li>
<li class="">
- <a class="" href="../Directory-structure/">Directory structure</a>
+ <a class="" href="../../Directory-structure/">Directory structure</a>
</li>
<li class="">
- <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
+ <a class="" href="../../3rd-party-libraries/">3rd party libraries</a>
</li>
<li class="">
- <a class="" href="../Plugin-System/">Plugin System</a>
+ <a class="" href="../../Plugin-System/">Plugin System</a>
</li>
<li class="">
- <a class="" href="../Release-Shaarli/">Release Shaarli</a>
+ <a class="" href="../../Release-Shaarli/">Release Shaarli</a>
</li>
<li class="">
- <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
+ <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a>
</li>
<li class="">
- <a class="" href="../Security/">Security</a>
+ <a class="" href="../../Security/">Security</a>
</li>
<li class="">
- <a class="" href="../Static-analysis/">Static analysis</a>
+ <a class="" href="../../Static-analysis/">Static analysis</a>
</li>
<li class="">
- <a class="" href="../Theming/">Theming</a>
+ <a class="" href="../../Theming/">Theming</a>
</li>
<li class="">
- <a class="" href="../Unit-tests/">Unit tests</a>
+ <a class="" href="../../Unit-tests/">Unit tests</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../FAQ/">FAQ</a>
+ <a class="" href="../../FAQ/">FAQ</a>
</li>
<li class="">
- <a class="" href="../Community-&-Related-software/">Community & Related software</a>
+ <a class="" href="../../Community-&-Related-software/">Community & Related software</a>
</li>
</ul>
</li>
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="..">Shaarli Documentation</a>
+ <a href="../..">Shaarli Documentation</a>
</nav>
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="..">Docs</a> »</li>
+ <li><a href="../..">Docs</a> »</li>
<li>Docker resources</li>
<li class="wy-breadcrumbs-aside">
- <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Docker-resources.md"
+ <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/resources.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../Features/" class="btn btn-neutral float-right" title="Features">Next <span class="icon icon-circle-arrow-right"></span></a>
+ <a href="../../Features/" class="btn btn-neutral float-right" title="Features">Next <span class="icon icon-circle-arrow-right"></span></a>
- <a href="../Reverse-proxy-configuration/" class="btn btn-neutral" title="Reverse proxy configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+ <a href="../reverse-proxy-configuration/" class="btn btn-neutral" title="Reverse proxy configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
- <span><a href="../Reverse-proxy-configuration/" style="color: #fcfcfc;">« Previous</a></span>
+ <span><a href="../reverse-proxy-configuration/" style="color: #fcfcfc;">« Previous</a></span>
- <span style="margin-left: 15px"><a href="../Features/" style="color: #fcfcfc">Next »</a></span>
+ <span style="margin-left: 15px"><a href="../../Features/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
- <script src="../js/theme.js"></script>
+ <script src="../../js/theme.js"></script>
</body>
</html>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <link rel="shortcut icon" href="../img/favicon.ico">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
<title>Reverse proxy configuration - Shaarli Documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="../css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
- <link rel="stylesheet" href="../css/highlight.css">
- <link href="../github-markdown.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../github-markdown.css" rel="stylesheet">
<script>
// Current page data
var mkdocs_page_name = "Reverse proxy configuration";
- var mkdocs_page_input_path = "Reverse-proxy-configuration.md";
- var mkdocs_page_url = "/Reverse-proxy-configuration/";
+ var mkdocs_page_input_path = "docker/reverse-proxy-configuration.md";
+ var mkdocs_page_url = "/docker/reverse-proxy-configuration/";
</script>
- <script src="../js/jquery-2.1.1.min.js"></script>
- <script src="../js/modernizr-2.8.3.min.js"></script>
- <script type="text/javascript" src="../js/highlight.pack.js"></script>
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
</head>
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
- <a href=".." class="icon icon-home"> Shaarli Documentation</a>
+ <a href="../.." class="icon icon-home"> Shaarli Documentation</a>
<div role="search">
- <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
<li class="toctree-l1">
- <a class="" href="..">Home</a>
+ <a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Download-and-Installation/">Download and Installation</a>
+ <a class="" href="../../Download-and-Installation/">Download and Installation</a>
</li>
<li class="">
- <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
+ <a class="" href="../../Upgrade-and-migration/">Upgrade and migration</a>
</li>
<li class="">
- <a class="" href="../Server-requirements/">Server requirements</a>
+ <a class="" href="../../Server-requirements/">Server requirements</a>
</li>
<li class="">
- <a class="" href="../Server-configuration/">Server configuration</a>
+ <a class="" href="../../Server-configuration/">Server configuration</a>
</li>
<li class="">
- <a class="" href="../Server-security/">Server security</a>
+ <a class="" href="../../Server-security/">Server security</a>
</li>
<li class="">
- <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
+ <a class="" href="../../Shaarli-configuration/">Shaarli configuration</a>
</li>
<li class="">
- <a class="" href="../Plugins/">Plugins</a>
+ <a class="" href="../../Plugins/">Plugins</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="../Shaarli-images/">Shaarli images</a>
+ <a class="" href="../shaarli-images/">Shaarli images</a>
</li>
<li class=" current">
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Features/">Features</a>
+ <a class="" href="../../Features/">Features</a>
</li>
<li class="">
- <a class="" href="../Bookmarklet/">Bookmarklet</a>
+ <a class="" href="../../Bookmarklet/">Bookmarklet</a>
</li>
<li class="">
- <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
+ <a class="" href="../../Browsing-and-searching/">Browsing and searching</a>
</li>
<li class="">
- <a class="" href="../Firefox-share/">Firefox share</a>
+ <a class="" href="../../Firefox-share/">Firefox share</a>
</li>
<li class="">
- <a class="" href="../RSS-feeds/">RSS feeds</a>
+ <a class="" href="../../RSS-feeds/">RSS feeds</a>
</li>
<li class="">
- <a class="" href="../REST-API/">REST API</a>
+ <a class="" href="../../REST-API/">REST API</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
+ <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
</li>
<li class="">
- <a class="" href="../Various-hacks/">Various hacks</a>
+ <a class="" href="../../Various-hacks/">Various hacks</a>
</li>
</ul>
</li>
<li class="toctree-l1">
- <a class="" href="../Troubleshooting/">Troubleshooting</a>
+ <a class="" href="../../Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Development-guidelines/">Development guidelines</a>
+ <a class="" href="../../Development-guidelines/">Development guidelines</a>
</li>
<li class="">
- <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
+ <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a>
</li>
<li class="">
- <a class="" href="../GnuPG-signature/">GnuPG signature</a>
+ <a class="" href="../../GnuPG-signature/">GnuPG signature</a>
</li>
<li class="">
- <a class="" href="../Coding-guidelines/">Coding guidelines</a>
+ <a class="" href="../../Coding-guidelines/">Coding guidelines</a>
</li>
<li class="">
- <a class="" href="../Directory-structure/">Directory structure</a>
+ <a class="" href="../../Directory-structure/">Directory structure</a>
</li>
<li class="">
- <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
+ <a class="" href="../../3rd-party-libraries/">3rd party libraries</a>
</li>
<li class="">
- <a class="" href="../Plugin-System/">Plugin System</a>
+ <a class="" href="../../Plugin-System/">Plugin System</a>
</li>
<li class="">
- <a class="" href="../Release-Shaarli/">Release Shaarli</a>
+ <a class="" href="../../Release-Shaarli/">Release Shaarli</a>
</li>
<li class="">
- <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
+ <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a>
</li>
<li class="">
- <a class="" href="../Security/">Security</a>
+ <a class="" href="../../Security/">Security</a>
</li>
<li class="">
- <a class="" href="../Static-analysis/">Static analysis</a>
+ <a class="" href="../../Static-analysis/">Static analysis</a>
</li>
<li class="">
- <a class="" href="../Theming/">Theming</a>
+ <a class="" href="../../Theming/">Theming</a>
</li>
<li class="">
- <a class="" href="../Unit-tests/">Unit tests</a>
+ <a class="" href="../../Unit-tests/">Unit tests</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../FAQ/">FAQ</a>
+ <a class="" href="../../FAQ/">FAQ</a>
</li>
<li class="">
- <a class="" href="../Community-&-Related-software/">Community & Related software</a>
+ <a class="" href="../../Community-&-Related-software/">Community & Related software</a>
</li>
</ul>
</li>
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="..">Shaarli Documentation</a>
+ <a href="../..">Shaarli Documentation</a>
</nav>
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="..">Docs</a> »</li>
+ <li><a href="../..">Docs</a> »</li>
<li>Reverse proxy configuration</li>
<li class="wy-breadcrumbs-aside">
- <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Reverse-proxy-configuration.md"
+ <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/reverse-proxy-configuration.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../Docker-resources/" class="btn btn-neutral float-right" title="Docker resources">Next <span class="icon icon-circle-arrow-right"></span></a>
+ <a href="../resources/" class="btn btn-neutral float-right" title="Docker resources">Next <span class="icon icon-circle-arrow-right"></span></a>
- <a href="../Shaarli-images/" class="btn btn-neutral" title="Shaarli images"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+ <a href="../shaarli-images/" class="btn btn-neutral" title="Shaarli images"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
- <span><a href="../Shaarli-images/" style="color: #fcfcfc;">« Previous</a></span>
+ <span><a href="../shaarli-images/" style="color: #fcfcfc;">« Previous</a></span>
- <span style="margin-left: 15px"><a href="../Docker-resources/" style="color: #fcfcfc">Next »</a></span>
+ <span style="margin-left: 15px"><a href="../resources/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
- <script src="../js/theme.js"></script>
+ <script src="../../js/theme.js"></script>
</body>
</html>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <link rel="shortcut icon" href="../img/favicon.ico">
+ <link rel="shortcut icon" href="../../img/favicon.ico">
<title>Shaarli images - Shaarli Documentation</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="../css/theme.css" type="text/css" />
- <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
- <link rel="stylesheet" href="../css/highlight.css">
- <link href="../github-markdown.css" rel="stylesheet">
+ <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../../css/highlight.css">
+ <link href="../../github-markdown.css" rel="stylesheet">
<script>
// Current page data
var mkdocs_page_name = "Shaarli images";
- var mkdocs_page_input_path = "Shaarli-images.md";
- var mkdocs_page_url = "/Shaarli-images/";
+ var mkdocs_page_input_path = "docker/shaarli-images.md";
+ var mkdocs_page_url = "/docker/shaarli-images/";
</script>
- <script src="../js/jquery-2.1.1.min.js"></script>
- <script src="../js/modernizr-2.8.3.min.js"></script>
- <script type="text/javascript" src="../js/highlight.pack.js"></script>
+ <script src="../../js/jquery-2.1.1.min.js"></script>
+ <script src="../../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../../js/highlight.pack.js"></script>
</head>
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
- <a href=".." class="icon icon-home"> Shaarli Documentation</a>
+ <a href="../.." class="icon icon-home"> Shaarli Documentation</a>
<div role="search">
- <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
<li class="toctree-l1">
- <a class="" href="..">Home</a>
+ <a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Download-and-Installation/">Download and Installation</a>
+ <a class="" href="../../Download-and-Installation/">Download and Installation</a>
</li>
<li class="">
- <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
+ <a class="" href="../../Upgrade-and-migration/">Upgrade and migration</a>
</li>
<li class="">
- <a class="" href="../Server-requirements/">Server requirements</a>
+ <a class="" href="../../Server-requirements/">Server requirements</a>
</li>
<li class="">
- <a class="" href="../Server-configuration/">Server configuration</a>
+ <a class="" href="../../Server-configuration/">Server configuration</a>
</li>
<li class="">
- <a class="" href="../Server-security/">Server security</a>
+ <a class="" href="../../Server-security/">Server security</a>
</li>
<li class="">
- <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
+ <a class="" href="../../Shaarli-configuration/">Shaarli configuration</a>
</li>
<li class="">
- <a class="" href="../Plugins/">Plugins</a>
+ <a class="" href="../../Plugins/">Plugins</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Docker-101/">Docker 101</a>
+ <a class="" href="../docker-101/">Docker 101</a>
</li>
<li class=" current">
</li>
<li class="">
- <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="../reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="../Docker-resources/">Docker resources</a>
+ <a class="" href="../resources/">Docker resources</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Features/">Features</a>
+ <a class="" href="../../Features/">Features</a>
</li>
<li class="">
- <a class="" href="../Bookmarklet/">Bookmarklet</a>
+ <a class="" href="../../Bookmarklet/">Bookmarklet</a>
</li>
<li class="">
- <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
+ <a class="" href="../../Browsing-and-searching/">Browsing and searching</a>
</li>
<li class="">
- <a class="" href="../Firefox-share/">Firefox share</a>
+ <a class="" href="../../Firefox-share/">Firefox share</a>
</li>
<li class="">
- <a class="" href="../RSS-feeds/">RSS feeds</a>
+ <a class="" href="../../RSS-feeds/">RSS feeds</a>
</li>
<li class="">
- <a class="" href="../REST-API/">REST API</a>
+ <a class="" href="../../REST-API/">REST API</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
+ <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
</li>
<li class="">
- <a class="" href="../Various-hacks/">Various hacks</a>
+ <a class="" href="../../Various-hacks/">Various hacks</a>
</li>
</ul>
</li>
<li class="toctree-l1">
- <a class="" href="../Troubleshooting/">Troubleshooting</a>
+ <a class="" href="../../Troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1">
<ul class="subnav">
<li class="">
- <a class="" href="../Development-guidelines/">Development guidelines</a>
+ <a class="" href="../../Development-guidelines/">Development guidelines</a>
</li>
<li class="">
- <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
+ <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a>
</li>
<li class="">
- <a class="" href="../GnuPG-signature/">GnuPG signature</a>
+ <a class="" href="../../GnuPG-signature/">GnuPG signature</a>
</li>
<li class="">
- <a class="" href="../Coding-guidelines/">Coding guidelines</a>
+ <a class="" href="../../Coding-guidelines/">Coding guidelines</a>
</li>
<li class="">
- <a class="" href="../Directory-structure/">Directory structure</a>
+ <a class="" href="../../Directory-structure/">Directory structure</a>
</li>
<li class="">
- <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
+ <a class="" href="../../3rd-party-libraries/">3rd party libraries</a>
</li>
<li class="">
- <a class="" href="../Plugin-System/">Plugin System</a>
+ <a class="" href="../../Plugin-System/">Plugin System</a>
</li>
<li class="">
- <a class="" href="../Release-Shaarli/">Release Shaarli</a>
+ <a class="" href="../../Release-Shaarli/">Release Shaarli</a>
</li>
<li class="">
- <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
+ <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a>
</li>
<li class="">
- <a class="" href="../Security/">Security</a>
+ <a class="" href="../../Security/">Security</a>
</li>
<li class="">
- <a class="" href="../Static-analysis/">Static analysis</a>
+ <a class="" href="../../Static-analysis/">Static analysis</a>
</li>
<li class="">
- <a class="" href="../Theming/">Theming</a>
+ <a class="" href="../../Theming/">Theming</a>
</li>
<li class="">
- <a class="" href="../Unit-tests/">Unit tests</a>
+ <a class="" href="../../Unit-tests/">Unit tests</a>
</li>
</ul>
</li>
<ul class="subnav">
<li class="">
- <a class="" href="../FAQ/">FAQ</a>
+ <a class="" href="../../FAQ/">FAQ</a>
</li>
<li class="">
- <a class="" href="../Community-&-Related-software/">Community & Related software</a>
+ <a class="" href="../../Community-&-Related-software/">Community & Related software</a>
</li>
</ul>
</li>
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="..">Shaarli Documentation</a>
+ <a href="../..">Shaarli Documentation</a>
</nav>
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="..">Docs</a> »</li>
+ <li><a href="../..">Docs</a> »</li>
<li>Shaarli images</li>
<li class="wy-breadcrumbs-aside">
- <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Shaarli-images.md"
+ <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/shaarli-images.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
<ul>
<li><code>latest</code>: master branch (tarball release)</li>
<li><code>stable</code>: stable branch (tarball release)</li>
-<li><code>dev</code>: master branch (Git clone)</li>
</ul>
<p>All images rely on:
- <a href="https://hub.docker.com/_/debian/">Debian 8 Jessie</a>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../Reverse-proxy-configuration/" class="btn btn-neutral float-right" title="Reverse proxy configuration">Next <span class="icon icon-circle-arrow-right"></span></a>
+ <a href="../reverse-proxy-configuration/" class="btn btn-neutral float-right" title="Reverse proxy configuration">Next <span class="icon icon-circle-arrow-right"></span></a>
- <a href="../Docker-101/" class="btn btn-neutral" title="Docker 101"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+ <a href="../docker-101/" class="btn btn-neutral" title="Docker 101"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
- <span><a href="../Docker-101/" style="color: #fcfcfc;">« Previous</a></span>
+ <span><a href="../docker-101/" style="color: #fcfcfc;">« Previous</a></span>
- <span style="margin-left: 15px"><a href="../Reverse-proxy-configuration/" style="color: #fcfcfc">Next »</a></span>
+ <span style="margin-left: 15px"><a href="../reverse-proxy-configuration/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
- <script src="../js/theme.js"></script>
+ <script src="../../js/theme.js"></script>
</body>
</html>
<ul class="subnav">
<li class="">
- <a class="" href="Docker-101/">Docker 101</a>
+ <a class="" href="docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="Shaarli-images/">Shaarli images</a>
+ <a class="" href="docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="Docker-resources/">Docker resources</a>
+ <a class="" href="docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<!--
MkDocs version : 0.16.3
-Build Date UTC : 2017-07-04 19:29:47
+Build Date UTC : 2017-07-29 13:33:00
-->
},
{
"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"
},
<ul class="subnav">
<li class="">
- <a class="" href="Docker-101/">Docker 101</a>
+ <a class="" href="docker/docker-101/">Docker 101</a>
</li>
<li class="">
- <a class="" href="Shaarli-images/">Shaarli images</a>
+ <a class="" href="docker/shaarli-images/">Shaarli images</a>
</li>
<li class="">
- <a class="" href="Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ <a class="" href="docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
</li>
<li class="">
- <a class="" href="Docker-resources/">Docker resources</a>
+ <a class="" href="docker/resources/">Docker resources</a>
</li>
</ul>
</li>
<url>
<loc>/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Download-and-Installation/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Upgrade-and-migration/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Server-requirements/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Server-configuration/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Server-security/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Shaarli-configuration/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Plugins/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
- <loc>/Docker-101/</loc>
- <lastmod>2017-07-04</lastmod>
+ <loc>/docker/docker-101/</loc>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
- <loc>/Shaarli-images/</loc>
- <lastmod>2017-07-04</lastmod>
+ <loc>/docker/shaarli-images/</loc>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
- <loc>/Reverse-proxy-configuration/</loc>
- <lastmod>2017-07-04</lastmod>
+ <loc>/docker/reverse-proxy-configuration/</loc>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
- <loc>/Docker-resources/</loc>
- <lastmod>2017-07-04</lastmod>
+ <loc>/docker/resources/</loc>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Features/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Bookmarklet/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Browsing-and-searching/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Firefox-share/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/RSS-feeds/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/REST-API/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Backup,-restore,-import-and-export/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Various-hacks/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Troubleshooting/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Development-guidelines/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Continuous-integration-tools/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/GnuPG-signature/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Coding-guidelines/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Directory-structure/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/3rd-party-libraries/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Plugin-System/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Release-Shaarli/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Versioning-and-Branches/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Security/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Static-analysis/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Theming/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Unit-tests/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/FAQ/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Community-&-Related-software/</loc>
- <lastmod>2017-07-04</lastmod>
+ <lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
### Available image tags
- `latest`: master branch (tarball release)
- `stable`: stable branch (tarball release)
-- `dev`: master branch (Git clone)
All images rely on:
- [Debian 8 Jessie](https://hub.docker.com/_/debian/)
+++ /dev/null
-FROM debian:jessie
-MAINTAINER Shaarli Community
-
-ENV TERM dumb
-RUN apt-get update \
- && apt-get install --no-install-recommends -y \
- ca-certificates \
- nginx-light \
- php5-curl \
- php5-fpm \
- php5-gd \
- php5-intl \
- supervisor \
- git \
- nano \
- && apt-get clean
-
-RUN sed -i 's/post_max_size.*/post_max_size = 10M/' /etc/php5/fpm/php.ini
-RUN sed -i 's/upload_max_filesize.*/upload_max_filesize = 10M/' /etc/php5/fpm/php.ini
-COPY nginx.conf /etc/nginx/nginx.conf
-COPY supervised.conf /etc/supervisor/conf.d/supervised.conf
-
-ADD https://getcomposer.org/composer.phar /usr/local/bin/composer
-RUN chmod 755 /usr/local/bin/composer
-
-WORKDIR /var/www
-RUN git clone https://github.com/shaarli/Shaarli.git shaarli \
- && cd shaarli \
- && composer --prefer-dist install
-RUN rm -rf html \
- && echo "<?php phpinfo(); ?>" > index.php \
- && chown -R www-data:www-data .
-
-VOLUME /var/www/shaarli/data
-
-EXPOSE 80
-
-CMD ["/usr/bin/supervisord", "-n", "-c", "/etc/supervisor/supervisord.conf"]
+++ /dev/null
-## shaarli:dev
-- [Debian 8 Jessie](https://hub.docker.com/_/debian/)
-- [PHP5-FPM](http://php-fpm.org/)
-- [Nginx](http://nginx.org/)
-- [Shaarli](https://github.com/shaarli/Shaarli)
-
-### Development tools
-- [composer](https://getcomposer.org/)
-- [git](http://git-scm.com/)
-- [nano](http://www.nano-editor.org/)
+++ /dev/null
-user www-data www-data;
-daemon off;
-worker_processes 4;
-
-events {
- worker_connections 768;
-}
-
-http {
- include mime.types;
- default_type application/octet-stream;
- keepalive_timeout 20;
-
- client_max_body_size 10m;
-
- index index.html index.php;
-
- server {
- listen 80;
- root /var/www/shaarli;
-
- access_log /var/log/nginx/shaarli.access.log;
- error_log /var/log/nginx/shaarli.error.log;
-
- location /phpinfo/ {
- # add a PHP info page for convenience
- fastcgi_pass unix:/var/run/php5-fpm.sock;
- fastcgi_index index.php;
- fastcgi_param SCRIPT_FILENAME /var/www/index.php;
- include fastcgi_params;
- }
-
- location ~ /\. {
- # deny access to dotfiles
- access_log off;
- log_not_found off;
- deny all;
- }
-
- location ~ ~$ {
- # deny access to temp editor files, e.g. "script.php~"
- access_log off;
- log_not_found off;
- deny all;
- }
-
- location ~* \.(?:ico|css|js|gif|jpe?g|png)$ {
- # cache static assets
- expires max;
- add_header Pragma public;
- add_header Cache-Control "public, must-revalidate, proxy-revalidate";
- }
-
- location = /favicon.ico {
- # serve the Shaarli favicon from its custom location
- alias /var/www/shaarli/images/favicon.ico;
- }
-
- location / {
- # Slim - rewrite URLs
- try_files $uri /index.php$is_args$args;
- }
-
- location ~ (index)\.php$ {
- # Slim - split URL path into (script_filename, path_info)
- try_files $uri =404;
- fastcgi_split_path_info ^(.+\.php)(/.+)$;
-
- # filter and proxy PHP requests to PHP-FPM
- fastcgi_pass unix:/var/run/php5-fpm.sock;
- fastcgi_index index.php;
- include fastcgi.conf;
- }
-
- location ~ \.php$ {
- # deny access to all other PHP scripts
- deny all;
- }
- }
-}
+++ /dev/null
-[program:php5-fpm]
-command=/usr/sbin/php5-fpm -F
-priority=5
-autostart=true
-autorestart=true
-
-[program:nginx]
-command=/usr/sbin/nginx
-priority=10
-autostart=true
-autorestart=true
-stdout_events_enabled=true
-stderr_events_enabled=true
- Shaarli configuration: Shaarli-configuration.md
- Plugins: Plugins.md
- Docker:
- - Docker 101: Docker-101.md
- - Shaarli images: Shaarli-images.md
- - Reverse proxy configuration: Reverse-proxy-configuration.md
- - Docker resources: Docker-resources.md
+ - Docker 101: docker/docker-101.md
+ - Shaarli images: docker/shaarli-images.md
+ - Reverse proxy configuration: docker/reverse-proxy-configuration.md
+ - Docker resources: docker/resources.md
- Usage:
- Features: Features.md
- Bookmarklet: Bookmarklet.md