]>
Commit | Line | Data |
---|---|---|
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 | ### Download as an archive | |
24 | Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. | |
25 | ||
26 | **Download our *shaarli-full* archive** to include dependencies. | |
27 | ||
28 | The current latest released version is `v0.9.1` | |
29 | ||
30 | Or in command lines: | |
31 | ||
32 | ```bash | |
33 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.1/shaarli-v0.9.1-full.zip | |
34 | $ unzip shaarli-v0.9.1-full.zip | |
35 | $ mv Shaarli /path/to/shaarli/ | |
36 | ``` | |
37 | ||
38 | In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. | |
39 | Cloning using `git` or downloading Github branches as zip files requires additional steps (see below). | |
40 | ||
41 | ### Using git | |
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 | ``` | |
49 | ||
50 | ## Stable version | |
51 | ||
52 | The stable version has been experienced by Shaarli users, and will receive security updates. | |
53 | ||
54 | ### Download as an archive | |
55 | ||
56 | As a .zip archive: | |
57 | ||
58 | ```bash | |
59 | $ wget https://github.com/shaarli/Shaarli/archive/stable.zip | |
60 | $ unzip stable.zip | |
61 | $ mv Shaarli-stable /path/to/shaarli/ | |
62 | ``` | |
63 | ||
64 | As a .tar.gz archive : | |
65 | ||
66 | ```bash | |
67 | $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz | |
68 | $ tar xvf stable.tar.gz | |
69 | $ mv Shaarli-stable /path/to/shaarli/ | |
70 | ``` | |
71 | ||
72 | ### Clone with Git | |
73 | ||
74 | [Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. | |
75 | ||
76 | ```bash | |
77 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | |
78 | # install/update third-party dependencies | |
79 | $ cd /path/to/shaarli/ | |
80 | $ composer install --no-dev --prefer-dist | |
81 | ``` | |
82 | ||
83 | ## Development version (mainline) | |
84 | ||
85 | _Use at your own risk!_ | |
86 | ||
87 | To get the latest changes from the `master` branch: | |
88 | ||
89 | ```bash | |
90 | # clone the repository | |
91 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ | |
92 | # install/update third-party dependencies | |
93 | $ cd /path/to/shaarli | |
94 | $ composer install --no-dev --prefer-dist | |
95 | $ make translate | |
96 | ``` | |
97 | ||
98 | ## Finish Installation | |
99 | ||
100 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. | |
101 | ||
102 | ![install screenshot](images/install-shaarli.png) | |
103 | ||
104 | Setup your Shaarli installation, and it's ready to use! | |
105 | ||
106 | ## Updating Shaarli | |
107 | ||
108 | See [Upgrade and Migration](Upgrade-and-migration) |