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.md)
20 --------------------------------------------------------------------------------
22 ## Latest release (recommended)
24 ### Download as an archive
26 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.
28 The current latest released version is `v0.9.6`
31 $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.6/shaarli-v0.9.6-full.zip
32 $ unzip shaarli-v0.9.6-full.zip
33 $ mv Shaarli /path/to/shaarli/
38 Cloning using `git` or downloading Github branches as zip files requires additional steps:
40 * Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
41 * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies.
42 * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation.
45 $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/
46 $ git clone -b latest https://github.com/shaarli/Shaarli.git .
47 $ composer install --no-dev --prefer-dist
53 --------------------------------------------------------------------------------
57 The stable version has been experienced by Shaarli users, and will receive security updates.
60 ### Download as an archive
65 $ wget https://github.com/shaarli/Shaarli/archive/stable.zip
67 $ mv Shaarli-stable /path/to/shaarli/
70 As a .tar.gz archive :
73 $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
74 $ tar xvf stable.tar.gz
75 $ mv Shaarli-stable /path/to/shaarli/
80 Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
83 $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
84 # install/update third-party dependencies
85 $ cd /path/to/shaarli/
86 $ composer install --no-dev --prefer-dist
90 --------------------------------------------------------------------------------
92 ## Development version (mainline)
94 _Use at your own risk!_
96 Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies,
97 and [yarn](https://yarnpkg.com/lang/en/docs/install/)
98 for front-end dependencies.
100 To get the latest changes from the `master` branch:
103 # clone the repository
104 $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
105 # install/update third-party dependencies
106 $ cd /path/to/shaarli
107 $ composer install --no-dev --prefer-dist
108 $ make build_frontend
113 -------------------------------------------------------------------------------
115 ## Finish Installation
117 Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
119 ![install screenshot](images/install-shaarli.png)
121 Setup your Shaarli installation, and it's ready to use!
125 See [Upgrade and Migration](Upgrade-and-migration)