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 meets the [requirements](Server-requirements)
5 and is properly [configured](Server-configuration).
7 Multiple releases branches are available:
9 - latest (last release)
10 - stable (previous major release)
11 - master (development)
13 Using one of the following methods:
15 - by downloading full release archives including all dependencies
16 - by downloading Github archives
17 - by cloning the Git repository
18 - using Docker: [see the documentation](docker/shaarli-images)
22 ## Latest release (recommended)
23 ### Download as an archive
24 Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page.
26 **Download our *shaarli-full* archive** to include dependencies.
28 The current latest released version is `v0.9.1`
33 $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip
34 $ unzip shaarli-v0.9.1-full.zip
35 $ mv Shaarli /path/to/shaarli/
38 In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page.
39 Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).
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 The stable version has been experienced by Shaarli users, and will receive security updates.
54 ### Download as an archive
59 $ wget https://github.com/shaarli/Shaarli/archive/stable.zip
61 $ mv Shaarli-stable /path/to/shaarli/
64 As a .tar.gz archive :
67 $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
68 $ tar xvf stable.tar.gz
69 $ mv Shaarli-stable /path/to/shaarli/
74 [Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git.
77 $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
78 # install/update third-party dependencies
79 $ cd /path/to/shaarli/
80 $ composer install --no-dev --prefer-dist
83 ## Development version (mainline)
85 _Use at your own risk!_
87 To get the latest changes from the `master` branch:
90 # clone the repository
91 $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
92 # install/update third-party dependencies
94 $ composer install --no-dev --prefer-dist
98 ## Finish Installation
100 Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
102 ![install screenshot](images/install-shaarli.png)
104 Setup your Shaarli installation, and it's ready to use!
108 See [Upgrade and Migration](Upgrade-and-migration)