1 To install Shaarli, simply place the files in a directory under your webserver's
2 Document Root (or directly at the document root).
4 Also, please make sure your server is properly [configured](Server-configuration).
6 Multiple releases branches are available:
8 - latest (last release)
9 - stable (previous major release)
10 - master (development)
12 Using one of the following methods:
14 - by downloading full release archives including all dependencies
15 - by downloading Github archives
16 - by cloning the Git repository
17 - using Docker: [see the documentation](docker/shaarli-images.md)
19 --------------------------------------------------------------------------------
21 ## Latest release (recommended)
23 ### Download as an archive
25 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.
27 The current latest released version is `v0.9.7`
30 $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.7/shaarli-v0.9.7-full.zip
31 $ unzip shaarli-v0.9.7-full.zip
32 $ mv Shaarli /path/to/shaarli/
37 Cloning using `git` or downloading Github branches as zip files requires additional steps:
39 * Install [Composer](Unit-tests.md#install_composer) to manage third-party [PHP dependencies](3rd-party-libraries.md#composer).
40 * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies.
41 * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation.
44 $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/
45 $ git clone -b latest https://github.com/shaarli/Shaarli.git .
46 $ composer install --no-dev --prefer-dist
52 --------------------------------------------------------------------------------
56 The stable version has been experienced by Shaarli users, and will receive security updates.
59 ### Download as an archive
64 $ wget https://github.com/shaarli/Shaarli/archive/stable.zip
66 $ mv Shaarli-stable /path/to/shaarli/
69 As a .tar.gz archive :
72 $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
73 $ tar xvf stable.tar.gz
74 $ mv Shaarli-stable /path/to/shaarli/
79 Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
82 $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
83 # install/update third-party dependencies
84 $ cd /path/to/shaarli/
85 $ composer install --no-dev --prefer-dist
89 --------------------------------------------------------------------------------
91 ## Development version (mainline)
93 _Use at your own risk!_
95 Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies,
96 and [yarn](https://yarnpkg.com/lang/en/docs/install/)
97 for front-end dependencies.
99 To get the latest changes from the `master` branch:
102 # clone the repository
103 $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
104 # install/update third-party dependencies
105 $ cd /path/to/shaarli
106 $ composer install --no-dev --prefer-dist
107 $ make build_frontend
112 -------------------------------------------------------------------------------
114 ## Finish Installation
116 Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
118 ![install screenshot](images/install-shaarli.png)
120 Setup your Shaarli installation, and it's ready to use!
124 See [Upgrade and Migration](Upgrade-and-migration)