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)
  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.1`
  29
  30 ```bash
  31 $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip
  32 $ unzip shaarli-v0.9.1-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 [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation.
  42
  43 ```
  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
  47 $ make translate
  48 $ make htmldoc
  49 ```
  50
  51 --------------------------------------------------------------------------------
  52
  53 ## Stable version
  54
  55 The stable version has been experienced by Shaarli users, and will receive security updates.
  56
  57
  58 ### Download as an archive
  59
  60 As a .zip archive:
  61
  62 ```bash
  63 $ wget https://github.com/shaarli/Shaarli/archive/stable.zip
  64 $ unzip stable.zip
  65 $ mv Shaarli-stable /path/to/shaarli/
  66 ```
  67
  68 As a .tar.gz archive :
  69
  70 ```bash
  71 $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz
  72 $ tar xvf stable.tar.gz
  73 $ mv Shaarli-stable /path/to/shaarli/
  74 ```
  75
  76 ### Using git
  77
  78 Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
  79
  80 ```bash
  81 $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
  82 # install/update third-party dependencies
  83 $ cd /path/to/shaarli/
  84 $ composer install --no-dev --prefer-dist
  85 ```
  86
  87
  88 --------------------------------------------------------------------------------
  89
  90 ## Development version (mainline)
  91
  92 _Use at your own risk!_
  93
  94 Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies.
  95
  96 To get the latest changes from the `master` branch:
  97
  98 ```bash
  99 # clone the repository
 100 $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
 101 # install/update third-party dependencies
 102 $ cd /path/to/shaarli
 103 $ composer install --no-dev --prefer-dist
 104 $ make translate
 105 $ make htmldoc
 106 ```
 107
 108 -------------------------------------------------------------------------------
 109
 110 ## Finish Installation
 111
 112 Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
 113
 114 ![install screenshot](images/install-shaarli.png)
 115
 116 Setup your Shaarli installation, and it's ready to use!
 117
 118 ## Updating Shaarli
 119
 120 See [Upgrade and Migration](Upgrade-and-migration)