To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root).
Also, please make sure your server is properly configured.
Multiple releases branches are available:
Using one of the following methods:
In most cases, you should download the latest Shaarli release from the releases page. Download our shaarli-full archive to include dependencies.
The current latest released version is v0.9.7
$ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.7/shaarli-v0.9.7-full.zip
$ unzip shaarli-v0.9.7-full.zip
$ mv Shaarli /path/to/shaarli/
Cloning using git
or downloading Github branches as zip files requires additional steps:
Install python3-virtualenv to build the local HTML documentation.
$ 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
The stable version has been experienced by Shaarli users, and will receive security updates.
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/
Install Composer to manage Shaarli dependencies.
$ 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 --prefer-dist
Use at your own risk!
Install Composer to manage Shaarli PHP dependencies, and yarn for front-end dependencies.
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 --prefer-dist
$ make build_frontend
$ make translate
$ make htmldoc
Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
Setup your Shaarli installation, and it's ready to use!