-To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your [server](Server-requirements) is properly [configured](Server-configuration).
+To install Shaarli, simply place the files in a directory under your webserver's
+Document Root (or directly at the document root).
-Several releases are available:
+Also, please make sure your server is properly [configured](Server-configuration).
---------------------------------------------------------
+Multiple releases branches are available:
+
+- latest (last release)
+- stable (previous major release)
+- master (development)
+
+Using one of the following methods:
+
+- by downloading full release archives including all dependencies
+- by downloading Github archives
+- by cloning the Git repository
+- using Docker: [see the documentation](docker/shaarli-images.md)
+
+--------------------------------------------------------------------------------
## Latest release (recommended)
-### Download as an archive
-Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.
-**Download our *shaarli-full* archive** to include dependencies.
+### Download as an archive
-The current latest released version is `v0.8.4`
+In most cases, you should download the latest Shaarli release from the [releases](https://github.com/shaarli/Shaarli/releases) page. Download our **shaarli-full** archive to include dependencies.
-Or in command lines:
+The current latest released version is `v0.10.3`
```bash
-$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
-$ unzip shaarli-v0.8.4-full.zip
+$ wget https://github.com/shaarli/Shaarli/releases/download/v0.10.3/shaarli-v0.10.3-full.zip
+$ unzip shaarli-v0.10.3-full.zip
$ mv Shaarli /path/to/shaarli/
```
-| ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).|
-|-----|--------------------------|
-
### Using git
+Cloning using `git` or downloading Github branches as zip files requires additional steps:
+
+ * Install [Composer](Unit-tests.md#install_composer) to manage third-party [PHP dependencies](3rd-party-libraries.md#composer).
+ * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies.
+ * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation.
+
```
-mkdir -p /path/to/shaarli && cd /path/to/shaarli/
-git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
-composer install --no-dev
+$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/
+$ git clone -b latest https://github.com/shaarli/Shaarli.git .
+$ composer install --no-dev --prefer-dist
+$ make build_frontend
+$ make translate
+$ make htmldoc
```
---------------------------------------------------------
+--------------------------------------------------------------------------------
## Stable version
The stable version has been experienced by Shaarli users, and will receive security updates.
+
### Download as an archive
As a .zip archive:
$ mv Shaarli-stable /path/to/shaarli/
```
-### Clone with Git
+### Using git
-[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.
+Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
```bash
$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
# install/update third-party dependencies
$ cd /path/to/shaarli/
-$ composer install --no-dev
+$ composer install --no-dev --prefer-dist
```
---------------------------------------------------------
+
+--------------------------------------------------------------------------------
## Development version (mainline)
_Use at your own risk!_
+Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies,
+and [yarn](https://yarnpkg.com/lang/en/docs/install/)
+for front-end dependencies.
+
To get the latest changes from the `master` branch:
```bash
-# clone the repository
+# clone the repository
$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
# install/update third-party dependencies
$ cd /path/to/shaarli
-$ composer install --no-dev
+$ composer install --no-dev --prefer-dist
+$ make build_frontend
+$ make translate
+$ make htmldoc
```
---------------------------------------------------------
+-------------------------------------------------------------------------------
## Finish Installation
Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
-![install screenshot](http://i.imgur.com/wuMpDSN.png)
+![install screenshot](images/install-shaarli.png)
Setup your Shaarli installation, and it's ready to use!
---------------------------------------------------------
-
## Updating Shaarli
See [Upgrade and Migration](Upgrade-and-migration)