doc/md/Download-and-Installation.md

   1 To install Shaarli, simply place the files in a directory under your webserver's
   2 Document Root (or directly at the document root).
   3
   4 Also, please make sure your server meets the [requirements](Server-requirements)
   5 and is properly [configured](Server-configuration).
   6
   7 Multiple releases branches are available:
   8
   9 - latest (last release)
  10 - stable (previous major release)
  11 - master (development)
  12
  13 Using one of the following methods:
  14
  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)
  19
  20 --------------------------------------------------------------------------------
  21
  22 ## Latest release (recommended)
  23
  24 ### Download as an archive
  25
  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.
  27
  28 The current latest released version is `v0.9.7`
  29
  30 ```bash
  31 $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.7/shaarli-v0.9.7-full.zip
  32 $ unzip shaarli-v0.9.7-full.zip
  33 $ mv Shaarli /path/to/shaarli/
  34 ```
  35
  36 ### Using git
  37
  38 Cloning using `git` or downloading Github branches as zip files requires additional steps:
  39
  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.
  43
  44 ```
  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
  48 $ make build_frontend
  49 $ make translate
  50 $ make htmldoc
  51 ```
  52
  53 --------------------------------------------------------------------------------
  54
  55 ## Stable version
  56
  57 The stable version has been experienced by Shaarli users, and will receive security updates.
  58
  59
  60 ### Download as an archive
  61
  62 As a .zip archive:
  63
  64 ```bash
  65 $ wget https://github.com/shaarli/Shaarli/archive/stable.zip
  66 $ unzip stable.zip
  67 $ mv Shaarli-stable /path/to/shaarli/
  68 ```
  69
  70 As a .tar.gz archive :
  71
  72 ```bash
  73 $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
  74 $ tar xvf stable.tar.gz
  75 $ mv Shaarli-stable /path/to/shaarli/
  76 ```
  77
  78 ### Using git
  79
  80 Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
  81
  82 ```bash
  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
  87 ```
  88
  89
  90 --------------------------------------------------------------------------------
  91
  92 ## Development version (mainline)
  93
  94 _Use at your own risk!_
  95
  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.
  99
 100 To get the latest changes from the `master` branch:
 101
 102 ```bash
 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
 109 $ make translate
 110 $ make htmldoc
 111 ```
 112
 113 -------------------------------------------------------------------------------
 114
 115 ## Finish Installation
 116
 117 Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
 118
 119 ![install screenshot](images/install-shaarli.png)
 120
 121 Setup your Shaarli installation, and it's ready to use!
 122
 123 ## Updating Shaarli
 124
 125 See [Upgrade and Migration](Upgrade-and-migration)