+
+ +

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 is properly configured.

+

Several releases are available:

+
+ +

Download as an archive

+

Get the latest released version from the releases page.

+

Download our shaarli-full archive to include dependencies.

+

The current latest released version is v0.8.4

+

Or in command lines:

+
$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip
+$ unzip shaarli-v0.8.4-full.zip
+$ mv Shaarli /path/to/shaarli/
+
+ + + + + + + + + +
!In most cases, download Shaarli from the releases page. Cloning using git or downloading Github branches as zip files requires additional steps (see below).
+

Using git

+
mkdir -p /path/to/shaarli && cd /path/to/shaarli/
+git clone -b v0.8 https://github.com/shaarli/Shaarli.git .
+composer install --no-dev
+
+ +
+

Stable version

+

The stable version has been experienced by Shaarli users, and will receive security updates.

+

Download as an archive

+

As a .zip archive:

+
$ wget https://github.com/shaarli/Shaarli/archive/stable.zip
+$ unzip stable.zip
+$ mv Shaarli-stable /path/to/shaarli/
+
+ +

As a .tar.gz archive :

+
$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
+$ tar xvf stable.tar.gz
+$ mv Shaarli-stable /path/to/shaarli/
+
+ +

Clone with Git

+

Composer is required to build a functional Shaarli installation when pulling from git.

+
$ 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
+
+ +
+

Development version (mainline)

+

Use at your own risk!

+

To get the latest changes from the master branch:

+
# 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
+
+ +
+

Finish Installation

+

Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.

+

install screenshot

+

Setup your Shaarli installation, and it's ready to use!

+
+

Updating Shaarli

+

See Upgrade and Migration

+ +
+