]>
Commit | Line | Data |
---|---|---|
43ad7c8e V |
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 | ||
bdfb967c | 4 | Also, please make sure your server is properly [configured](Server-configuration). |
fdf88d19 | 5 | |
cfcc3819 A |
6 | Multiple releases branches are available: |
7 | ||
8 | - latest (last release) | |
9 | - stable (previous major release) | |
10 | - master (development) | |
11 | ||
12 | Using one of the following methods: | |
fdf88d19 | 13 | |
43ad7c8e V |
14 | - by downloading full release archives including all dependencies |
15 | - by downloading Github archives | |
16 | - by cloning the Git repository | |
7a205fb2 | 17 | - using Docker: [see the documentation](docker/shaarli-images.md) |
43ad7c8e | 18 | |
76c3a4db | 19 | -------------------------------------------------------------------------------- |
fdf88d19 A |
20 | |
21 | ## Latest release (recommended) | |
76c3a4db | 22 | |
3cc8c898 | 23 | ### Download as an archive |
fdf88d19 | 24 | |
bdfb967c | 25 | 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. |
fdf88d19 | 26 | |
6e1df601 | 27 | The current latest released version is `v0.9.7` |
fdf88d19 | 28 | |
fdf88d19 | 29 | ```bash |
6e1df601 V |
30 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.9.7/shaarli-v0.9.7-full.zip |
31 | $ unzip shaarli-v0.9.7-full.zip | |
3cc8c898 | 32 | $ mv Shaarli /path/to/shaarli/ |
fdf88d19 A |
33 | ``` |
34 | ||
3cc8c898 | 35 | ### Using git |
fdf88d19 | 36 | |
76c3a4db | 37 | Cloning using `git` or downloading Github branches as zip files requires additional steps: |
38 | ||
bdfb967c | 39 | * Install [Composer](Unit-tests.md#install_composer) to manage third-party [PHP dependencies](3rd-party-libraries.md#composer). |
d7eb06bd | 40 | * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies. |
76c3a4db | 41 | * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation. |
42 | ||
3cc8c898 | 43 | ``` |
43ad7c8e | 44 | $ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ |
cfcc3819 | 45 | $ git clone -b latest https://github.com/shaarli/Shaarli.git . |
43ad7c8e | 46 | $ composer install --no-dev --prefer-dist |
d7eb06bd | 47 | $ make build_frontend |
1a47014f | 48 | $ make translate |
76c3a4db | 49 | $ make htmldoc |
3cc8c898 | 50 | ``` |
fdf88d19 | 51 | |
76c3a4db | 52 | -------------------------------------------------------------------------------- |
53 | ||
fdf88d19 A |
54 | ## Stable version |
55 | ||
56 | The stable version has been experienced by Shaarli users, and will receive security updates. | |
57 | ||
76c3a4db | 58 | |
fdf88d19 A |
59 | ### Download as an archive |
60 | ||
61 | As a .zip archive: | |
62 | ||
63 | ```bash | |
64 | $ wget https://github.com/shaarli/Shaarli/archive/stable.zip | |
65 | $ unzip stable.zip | |
66 | $ mv Shaarli-stable /path/to/shaarli/ | |
67 | ``` | |
68 | ||
69 | As a .tar.gz archive : | |
70 | ||
71 | ```bash | |
72 | $ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz | |
73 | $ tar xvf stable.tar.gz | |
74 | $ mv Shaarli-stable /path/to/shaarli/ | |
75 | ``` | |
76 | ||
76c3a4db | 77 | ### Using git |
fdf88d19 | 78 | |
76c3a4db | 79 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. |
fdf88d19 A |
80 | |
81 | ```bash | |
82 | $ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ | |
83 | # install/update third-party dependencies | |
84 | $ cd /path/to/shaarli/ | |
43ad7c8e | 85 | $ composer install --no-dev --prefer-dist |
fdf88d19 A |
86 | ``` |
87 | ||
76c3a4db | 88 | |
89 | -------------------------------------------------------------------------------- | |
90 | ||
fdf88d19 A |
91 | ## Development version (mainline) |
92 | ||
93 | _Use at your own risk!_ | |
94 | ||
d7eb06bd | 95 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies, |
6e1df601 | 96 | and [yarn](https://yarnpkg.com/lang/en/docs/install/) |
d7eb06bd | 97 | for front-end dependencies. |
76c3a4db | 98 | |
fdf88d19 A |
99 | To get the latest changes from the `master` branch: |
100 | ||
101 | ```bash | |
f452d3c4 | 102 | # clone the repository |
b230bf20 | 103 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ |
fdf88d19 A |
104 | # install/update third-party dependencies |
105 | $ cd /path/to/shaarli | |
43ad7c8e | 106 | $ composer install --no-dev --prefer-dist |
d7eb06bd | 107 | $ make build_frontend |
1a47014f | 108 | $ make translate |
76c3a4db | 109 | $ make htmldoc |
fdf88d19 A |
110 | ``` |
111 | ||
76c3a4db | 112 | ------------------------------------------------------------------------------- |
113 | ||
fdf88d19 A |
114 | ## Finish Installation |
115 | ||
116 | Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. | |
117 | ||
1a47014f | 118 | ![install screenshot](images/install-shaarli.png) |
fdf88d19 A |
119 | |
120 | Setup your Shaarli installation, and it's ready to use! | |
121 | ||
fdf88d19 A |
122 | ## Updating Shaarli |
123 | ||
53ed6d7d | 124 | See [Upgrade and Migration](Upgrade-and-migration) |