diff options
Diffstat (limited to 'doc/md/Download-and-Installation.md')
-rw-r--r-- | doc/md/Download-and-Installation.md | 46 |
1 files changed, 34 insertions, 12 deletions
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md index e5e929ef..bbbfc26d 100644 --- a/doc/md/Download-and-Installation.md +++ b/doc/md/Download-and-Installation.md | |||
@@ -4,44 +4,57 @@ Document Root (or directly at the document root). | |||
4 | Also, please make sure your server meets the [requirements](Server-requirements) | 4 | Also, please make sure your server meets the [requirements](Server-requirements) |
5 | and is properly [configured](Server-configuration). | 5 | and is properly [configured](Server-configuration). |
6 | 6 | ||
7 | Several releases are available: | 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: | ||
8 | 14 | ||
9 | - by downloading full release archives including all dependencies | 15 | - by downloading full release archives including all dependencies |
10 | - by downloading Github archives | 16 | - by downloading Github archives |
11 | - by cloning the Git repository | 17 | - by cloning the Git repository |
18 | - using Docker: [see the documentation](docker/shaarli-images.md) | ||
12 | 19 | ||
13 | --- | 20 | -------------------------------------------------------------------------------- |
14 | 21 | ||
15 | ## Latest release (recommended) | 22 | ## Latest release (recommended) |
23 | |||
16 | ### Download as an archive | 24 | ### Download as an archive |
17 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. | ||
18 | 25 | ||
19 | **Download our *shaarli-full* archive** to include dependencies. | 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. |
20 | 27 | ||
21 | The current latest released version is `v0.9.1` | 28 | The current latest released version is `v0.9.1` |
22 | 29 | ||
23 | Or in command lines: | ||
24 | |||
25 | ```bash | 30 | ```bash |
26 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip | 31 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip |
27 | $ unzip shaarli-v0.9.1-full.zip | 32 | $ unzip shaarli-v0.9.1-full.zip |
28 | $ mv Shaarli /path/to/shaarli/ | 33 | $ mv Shaarli /path/to/shaarli/ |
29 | ``` | 34 | ``` |
30 | 35 | ||
31 | 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).| | ||
32 | |||
33 | ### Using git | 36 | ### Using git |
34 | 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 | |||
35 | ``` | 43 | ``` |
36 | $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ | 44 | $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ |
37 | $ git clone -b v0.9 https://github.com/shaarli/Shaarli.git . | 45 | $ git clone -b latest https://github.com/shaarli/Shaarli.git . |
38 | $ composer install --no-dev --prefer-dist | 46 | $ composer install --no-dev --prefer-dist |
47 | $ make translate | ||
48 | $ make htmldoc | ||
39 | ``` | 49 | ``` |
40 | 50 | ||
51 | -------------------------------------------------------------------------------- | ||
52 | |||
41 | ## Stable version | 53 | ## Stable version |
42 | 54 | ||
43 | The stable version has been experienced by Shaarli users, and will receive security updates. | 55 | The stable version has been experienced by Shaarli users, and will receive security updates. |
44 | 56 | ||
57 | |||
45 | ### Download as an archive | 58 | ### Download as an archive |
46 | 59 | ||
47 | As a .zip archive: | 60 | As a .zip archive: |
@@ -60,9 +73,9 @@ $ tar xvf stable.tar.gz | |||
60 | $ mv Shaarli-stable /path/to/shaarli/ | 73 | $ mv Shaarli-stable /path/to/shaarli/ |
61 | ``` | 74 | ``` |
62 | 75 | ||
63 | ### Clone with Git | 76 | ### Using git |
64 | 77 | ||
65 | [Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. | 78 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. |
66 | 79 | ||
67 | ```bash | 80 | ```bash |
68 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | 81 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ |
@@ -71,10 +84,15 @@ $ cd /path/to/shaarli/ | |||
71 | $ composer install --no-dev --prefer-dist | 84 | $ composer install --no-dev --prefer-dist |
72 | ``` | 85 | ``` |
73 | 86 | ||
87 | |||
88 | -------------------------------------------------------------------------------- | ||
89 | |||
74 | ## Development version (mainline) | 90 | ## Development version (mainline) |
75 | 91 | ||
76 | _Use at your own risk!_ | 92 | _Use at your own risk!_ |
77 | 93 | ||
94 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. | ||
95 | |||
78 | To get the latest changes from the `master` branch: | 96 | To get the latest changes from the `master` branch: |
79 | 97 | ||
80 | ```bash | 98 | ```bash |
@@ -83,13 +101,17 @@ $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ | |||
83 | # install/update third-party dependencies | 101 | # install/update third-party dependencies |
84 | $ cd /path/to/shaarli | 102 | $ cd /path/to/shaarli |
85 | $ composer install --no-dev --prefer-dist | 103 | $ composer install --no-dev --prefer-dist |
104 | $ make translate | ||
105 | $ make htmldoc | ||
86 | ``` | 106 | ``` |
87 | 107 | ||
108 | ------------------------------------------------------------------------------- | ||
109 | |||
88 | ## Finish Installation | 110 | ## Finish Installation |
89 | 111 | ||
90 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. | 112 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. |
91 | 113 | ||
92 | ![install screenshot](http://i.imgur.com/wuMpDSN.png) | 114 | ![install screenshot](images/install-shaarli.png) |
93 | 115 | ||
94 | Setup your Shaarli installation, and it's ready to use! | 116 | Setup your Shaarli installation, and it's ready to use! |
95 | 117 | ||