aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Download-and-Installation.md
diff options
context:
space:
mode:
authorVirtualTam <virtualtam+github@flibidi.net>2017-08-06 16:15:32 +0200
committerGitHub <noreply@github.com>2017-08-06 16:15:32 +0200
commitc7fcea1347e81072c5b77c1b3c2c6fb13f02c16f (patch)
tree03e4d7bbdcfebdb704266caf4b5c0d87e90c02ce /doc/md/Download-and-Installation.md
parent4758c18164f8168be0b3e422c4af86827c913390 (diff)
parentf320efd689f17737ccbdef46cdc430d9e637b807 (diff)
downloadShaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.gz
Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.tar.zst
Shaarli-c7fcea1347e81072c5b77c1b3c2c6fb13f02c16f.zip
Merge pull request #917 from virtualtam/documentation/fixes+improvements
Documentation fixes, improvements and additions
Diffstat (limited to 'doc/md/Download-and-Installation.md')
-rw-r--r--doc/md/Download-and-Installation.md39
1 files changed, 19 insertions, 20 deletions
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md
index 7880aef4..135f0633 100644
--- a/doc/md/Download-and-Installation.md
+++ b/doc/md/Download-and-Installation.md
@@ -1,8 +1,16 @@
1To 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](Server-requirements) is properly [configured](Server-configuration). 1To install Shaarli, simply place the files in a directory under your webserver's
2Document Root (or directly at the document root).
3
4Also, please make sure your server meets the [requirements](Server-requirements)
5and is properly [configured](Server-configuration).
2 6
3Several releases are available: 7Several releases are available:
4 8
5-------------------------------------------------------- 9- by downloading full release archives including all dependencies
10- by downloading Github archives
11- by cloning the Git repository
12
13---
6 14
7## Latest release (recommended) 15## Latest release (recommended)
8### Download as an archive 16### Download as an archive
@@ -10,29 +18,26 @@ Get the latest released version from the [releases](https://github.com/shaarli/S
10 18
11**Download our *shaarli-full* archive** to include dependencies. 19**Download our *shaarli-full* archive** to include dependencies.
12 20
13The current latest released version is `v0.8.4` 21The current latest released version is `v0.9.0`
14 22
15Or in command lines: 23Or in command lines:
16 24
17```bash 25```bash
18$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip 26$ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.0/shaarli-v0.9.0-full.zip
19$ unzip shaarli-v0.8.4-full.zip 27$ unzip shaarli-v0.9.0-full.zip
20$ mv Shaarli /path/to/shaarli/ 28$ mv Shaarli /path/to/shaarli/
21``` 29```
22 30
23| ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).| 31In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).|
24|-----|--------------------------|
25 32
26### Using git 33### Using git
27 34
28``` 35```
29mkdir -p /path/to/shaarli && cd /path/to/shaarli/ 36$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/
30git clone -b v0.8 https://github.com/shaarli/Shaarli.git . 37$ git clone -b v0.9 https://github.com/shaarli/Shaarli.git .
31composer install --no-dev 38$ composer install --no-dev --prefer-dist
32``` 39```
33 40
34--------------------------------------------------------
35
36## Stable version 41## Stable version
37 42
38The stable version has been experienced by Shaarli users, and will receive security updates. 43The stable version has been experienced by Shaarli users, and will receive security updates.
@@ -63,11 +68,9 @@ $ mv Shaarli-stable /path/to/shaarli/
63$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ 68$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/
64# install/update third-party dependencies 69# install/update third-party dependencies
65$ cd /path/to/shaarli/ 70$ cd /path/to/shaarli/
66$ composer install --no-dev 71$ composer install --no-dev --prefer-dist
67``` 72```
68 73
69--------------------------------------------------------
70
71## Development version (mainline) 74## Development version (mainline)
72 75
73_Use at your own risk!_ 76_Use at your own risk!_
@@ -79,11 +82,9 @@ To get the latest changes from the `master` branch:
79$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ 82$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/
80# install/update third-party dependencies 83# install/update third-party dependencies
81$ cd /path/to/shaarli 84$ cd /path/to/shaarli
82$ composer install --no-dev 85$ composer install --no-dev --prefer-dist
83``` 86```
84 87
85--------------------------------------------------------
86
87## Finish Installation 88## Finish Installation
88 89
89Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. 90Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser.
@@ -92,8 +93,6 @@ Once Shaarli is downloaded and files have been placed at the correct location, o
92 93
93Setup your Shaarli installation, and it's ready to use! 94Setup your Shaarli installation, and it's ready to use!
94 95
95--------------------------------------------------------
96
97## Updating Shaarli 96## Updating Shaarli
98 97
99See [Upgrade and Migration](Upgrade-and-migration) 98See [Upgrade and Migration](Upgrade-and-migration)