Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #906 from virtualtam/docker/cleanup

Browse source 
docker: remove `dev` image, update documentation
This commit is contained in:
VirtualTam 2017-07-29 16:17:09 +02:00 committed by GitHub
commit fccfa09df8
53 changed files with 463 additions and 970 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
AUTHORS
View file

@ -1,6 +1,6 @@
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,15 +8,18 @@
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>
@ -38,4 +41,3 @@
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>

158
doc/Docker.md
View file

@ -1,158 +0,0 @@
#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)

105
doc/REST-API.md
View file

@ -1,105 +0,0 @@
#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);
```

76
doc/Versioning-and-Branches.md
View file

@ -1,76 +0,0 @@
#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`
```

39
doc/_Sidebar.md
View file

@ -1,39 +0,0 @@
#_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)

8
doc/html/3rd-party-libraries/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Backup,-restore,-import-and-export/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Bookmarklet/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Browsing-and-searching/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Coding-guidelines/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Community-&-Related-software/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Continuous-integration-tools/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Development-guidelines/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Directory-structure/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Download-and-Installation/index.html
View file

@ -128,19 +128,19 @@
<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>

8
doc/html/FAQ/index.html
View file

@ -94,19 +94,19 @@
<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>

12
doc/html/Features/index.html
View file

@ -94,19 +94,19 @@
<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>
@ -318,7 +318,7 @@ <h3 id="using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notep
<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>
@ -346,7 +346,7 @@ <h3 id="using-shaarli-as-a-blog-notepad-pastebin">Using Shaarli as a blog, notep
<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;">&laquo; Previous</a></span>
<span><a href="../docker/resources/" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../Bookmarklet/" style="color: #fcfcfc">Next &raquo;</a></span>

8
doc/html/Firefox-share/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/GnuPG-signature/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Plugin-System/index.html
View file

@ -94,19 +94,19 @@
<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>

12
doc/html/Plugins/index.html
View file

@ -115,19 +115,19 @@
<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>
@ -358,7 +358,7 @@ <h4 id="third-party-plugins">Third party plugins</h4>
<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>
@ -392,7 +392,7 @@ <h4 id="third-party-plugins">Third party plugins</h4>
<span><a href="../Shaarli-configuration/" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../Docker-101/" style="color: #fcfcfc">Next &raquo;</a></span>
<span style="margin-left: 15px"><a href="../docker/docker-101/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>

8
doc/html/REST-API/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/RSS-feeds/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Release-Shaarli/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Security/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Server-configuration/index.html
View file

@ -149,19 +149,19 @@
<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>

8
doc/html/Server-requirements/index.html
View file

@ -112,19 +112,19 @@
<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>

8
doc/html/Server-security/index.html
View file

@ -118,19 +118,19 @@
<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>

60
doc/html/Shaarli-configuration/index.html
View file

@ -134,19 +134,19 @@
<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>
@ -323,26 +323,38 @@ <h2 id="foreword">Foreword</h2>
<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>

8
doc/html/Static-analysis/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Theming/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Troubleshooting/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Unit-tests/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Upgrade-and-migration/index.html
View file

@ -133,19 +133,19 @@
<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>

8
doc/html/Various-hacks/index.html
View file

@ -94,19 +94,19 @@
<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>

8
doc/html/Versioning-and-Branches/index.html
View file

@ -94,19 +94,19 @@
<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>

110
doc/html/Docker-101/index.html → doc/html/docker/docker-101/index.html
View file

@ -7,25 +7,25 @@
<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>
@ -36,9 +36,9 @@
<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>
@ -50,7 +50,7 @@
<li class="toctree-l1">
<a class="" href="..">Home</a>
<a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
@ -59,31 +59,31 @@
<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>
@ -114,15 +114,15 @@
</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>
@ -133,27 +133,27 @@
<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>
@ -164,18 +164,18 @@
<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">
@ -184,55 +184,55 @@
<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>
@ -243,11 +243,11 @@
<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>
@ -262,7 +262,7 @@
<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>
@ -270,7 +270,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li><a href="../..">Docs</a> &raquo;</li>
@ -281,7 +281,7 @@
<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>
@ -354,10 +354,10 @@ <h3 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h3>
<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>
@ -385,14 +385,14 @@ <h3 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h3>
<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;">&laquo; Previous</a></span>
<span><a href="../../Plugins/" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../Shaarli-images/" style="color: #fcfcfc">Next &raquo;</a></span>
<span style="margin-left: 15px"><a href="../shaarli-images/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../js/theme.js"></script>
<script src="../../js/theme.js"></script>
</body>
</html>

110
doc/html/Docker-resources/index.html → doc/html/docker/resources/index.html
View file

@ -7,25 +7,25 @@
<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>
@ -36,9 +36,9 @@
<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>
@ -50,7 +50,7 @@
<li class="toctree-l1">
<a class="" href="..">Home</a>
<a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
@ -59,31 +59,31 @@
<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>
@ -94,15 +94,15 @@
<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">
@ -129,27 +129,27 @@
<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>
@ -160,18 +160,18 @@
<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">
@ -180,55 +180,55 @@
<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>
@ -239,11 +239,11 @@
<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>
@ -258,7 +258,7 @@
<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>
@ -266,7 +266,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li><a href="../..">Docs</a> &raquo;</li>
@ -277,7 +277,7 @@
<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>
@ -314,10 +314,10 @@ <h3 id="service-management">Service management</h3>
<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>
@ -345,14 +345,14 @@ <h3 id="service-management">Service management</h3>
<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;">&laquo; Previous</a></span>
<span><a href="../reverse-proxy-configuration/" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../Features/" style="color: #fcfcfc">Next &raquo;</a></span>
<span style="margin-left: 15px"><a href="../../Features/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../js/theme.js"></script>
<script src="../../js/theme.js"></script>
</body>
</html>

110
doc/html/Reverse-proxy-configuration/index.html → doc/html/docker/reverse-proxy-configuration/index.html
View file

@ -7,25 +7,25 @@
<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>
@ -36,9 +36,9 @@
<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>
@ -50,7 +50,7 @@
<li class="toctree-l1">
<a class="" href="..">Home</a>
<a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
@ -59,31 +59,31 @@
<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>
@ -94,11 +94,11 @@
<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">
@ -115,7 +115,7 @@
</li>
<li class="">
<a class="" href="../Docker-resources/">Docker resources</a>
<a class="" href="../resources/">Docker resources</a>
</li>
</ul>
</li>
@ -126,27 +126,27 @@
<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>
@ -157,18 +157,18 @@
<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">
@ -177,55 +177,55 @@
<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>
@ -236,11 +236,11 @@
<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>
@ -255,7 +255,7 @@
<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>
@ -263,7 +263,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li><a href="../..">Docs</a> &raquo;</li>
@ -274,7 +274,7 @@
<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>
@ -294,10 +294,10 @@ <h2 id="nginx">Nginx</h2>
<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>
@ -325,14 +325,14 @@ <h2 id="nginx">Nginx</h2>
<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;">&laquo; Previous</a></span>
<span><a href="../shaarli-images/" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../Docker-resources/" style="color: #fcfcfc">Next &raquo;</a></span>
<span style="margin-left: 15px"><a href="../resources/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../js/theme.js"></script>
<script src="../../js/theme.js"></script>
</body>
</html>

111
doc/html/Shaarli-images/index.html → doc/html/docker/shaarli-images/index.html
View file

@ -7,25 +7,25 @@
<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>
@ -36,9 +36,9 @@
<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>
@ -50,7 +50,7 @@
<li class="toctree-l1">
<a class="" href="..">Home</a>
<a class="" href="../..">Home</a>
</li>
<li class="toctree-l1">
@ -59,31 +59,31 @@
<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>
@ -94,7 +94,7 @@
<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">
@ -122,11 +122,11 @@
</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>
@ -137,27 +137,27 @@
<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>
@ -168,18 +168,18 @@
<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">
@ -188,55 +188,55 @@
<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>
@ -247,11 +247,11 @@
<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>
@ -266,7 +266,7 @@
<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>
@ -274,7 +274,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li><a href="../..">Docs</a> &raquo;</li>
@ -285,7 +285,7 @@
<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>
@ -303,7 +303,6 @@ <h3 id="available-image-tags">Available image tags</h3>
<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>
@ -369,10 +368,10 @@ <h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3>
<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>
@ -400,14 +399,14 @@ <h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3>
<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;">&laquo; Previous</a></span>
<span><a href="../docker-101/" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../Reverse-proxy-configuration/" style="color: #fcfcfc">Next &raquo;</a></span>
<span style="margin-left: 15px"><a href="../reverse-proxy-configuration/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script src="../js/theme.js"></script>
<script src="../../js/theme.js"></script>
</body>
</html>

10
doc/html/index.html
View file

@ -110,19 +110,19 @@
<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>
@ -441,5 +441,5 @@ <h3 id="license">License</h3>
<!--
MkDocs version : 0.16.3
Build Date UTC : 2017-07-04 19:29:47
Build Date UTC : 2017-07-29 13:33:00
-->

46
doc/html/mkdocs/search_index.json
View file

File diff suppressed because one or more lines are too long

8
doc/html/search.html
View file

@ -90,19 +90,19 @@
<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>

80
doc/html/sitemap.xml
View file

@ -4,7 +4,7 @@
<url>
<loc>/</loc>
<lastmod>2017-07-04</lastmod>
<lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
@ -13,43 +13,43 @@
<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>
@ -58,26 +58,26 @@
<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>
@ -87,37 +87,37 @@
<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>
@ -127,13 +127,13 @@
<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>
@ -142,7 +142,7 @@
<url>
<loc>/Troubleshooting/</loc>
<lastmod>2017-07-04</lastmod>
<lastmod>2017-07-29</lastmod>
<changefreq>daily</changefreq>
</url>
@ -151,79 +151,79 @@
<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>
@ -233,13 +233,13 @@
<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>

0
doc/md/Docker-101.md → doc/md/docker/docker-101.md
View file

0
doc/md/Docker-resources.md → doc/md/docker/resources.md
View file

0
doc/md/Reverse-proxy-configuration.md → doc/md/docker/reverse-proxy-configuration.md
View file

1
doc/md/Shaarli-images.md → doc/md/docker/shaarli-images.md
View file

@ -7,7 +7,6 @@ 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/)

38
docker/development/Dockerfile
View file

@ -1,38 +0,0 @@
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"]

10
docker/development/IMAGE.md
View file

@ -1,10 +0,0 @@
## 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/)

80
docker/development/nginx.conf
View file

@ -1,80 +0,0 @@
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;
}
}
}

13
docker/development/supervised.conf
View file

@ -1,13 +0,0 @@
[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

8
mkdocs.yml
View file

@ -16,10 +16,10 @@ pages:
- 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