diff options
author | nodiscc <nodiscc@gmail.com> | 2020-09-12 12:38:05 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-12 12:38:05 +0000 |
commit | e809908f9e593b2cec11f72849caa1dae6394451 (patch) | |
tree | b26f77ec59b7c25800599d751212db72cfc65870 /doc/md/Download-and-Installation.md | |
parent | 6128ab6a55430a2b705be31ff417c0c552a0db1f (diff) | |
parent | 97870f35121bed42ac126652d81bc43416b44356 (diff) | |
download | Shaarli-e809908f9e593b2cec11f72849caa1dae6394451.tar.gz Shaarli-e809908f9e593b2cec11f72849caa1dae6394451.tar.zst Shaarli-e809908f9e593b2cec11f72849caa1dae6394451.zip |
Merge pull request #1389 from shaarli/doc-rework-setup
doc: rework installation/setup guides, general refactoring
Diffstat (limited to 'doc/md/Download-and-Installation.md')
-rw-r--r-- | doc/md/Download-and-Installation.md | 124 |
1 files changed, 0 insertions, 124 deletions
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md deleted file mode 100644 index ec68762e..00000000 --- a/doc/md/Download-and-Installation.md +++ /dev/null | |||
@@ -1,124 +0,0 @@ | |||
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 is properly [configured](Server-configuration.md). | ||
5 | |||
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: | ||
13 | |||
14 | - by downloading full release archives including all dependencies | ||
15 | - by downloading Github archives | ||
16 | - by cloning the Git repository | ||
17 | - using Docker: [see the documentation](docker/shaarli-images.md) | ||
18 | |||
19 | -------------------------------------------------------------------------------- | ||
20 | |||
21 | ## Latest release (recommended) | ||
22 | |||
23 | ### Download as an archive | ||
24 | |||
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. | ||
26 | |||
27 | The current latest released version is `v0.10.4` | ||
28 | |||
29 | ```bash | ||
30 | $ wget https://github.com/shaarli/Shaarli/releases/download/v0.10.4/shaarli-v0.10.4-full.zip | ||
31 | $ unzip shaarli-v0.10.4-full.zip | ||
32 | $ mv Shaarli /path/to/shaarli/ | ||
33 | ``` | ||
34 | |||
35 | ### Using git | ||
36 | |||
37 | Cloning using `git` or downloading Github branches as zip files requires additional steps: | ||
38 | |||
39 | * Install [Composer](Unit-tests.md#install_composer) to manage third-party [PHP dependencies](3rd-party-libraries.md#composer). | ||
40 | * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend 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 build_frontend | ||
48 | $ make translate | ||
49 | $ make htmldoc | ||
50 | ``` | ||
51 | |||
52 | -------------------------------------------------------------------------------- | ||
53 | |||
54 | ## Stable version | ||
55 | |||
56 | The stable version has been experienced by Shaarli users, and will receive security updates. | ||
57 | |||
58 | |||
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 | |||
77 | ### Using git | ||
78 | |||
79 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. | ||
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/ | ||
85 | $ composer install --no-dev --prefer-dist | ||
86 | ``` | ||
87 | |||
88 | |||
89 | -------------------------------------------------------------------------------- | ||
90 | |||
91 | ## Development version (mainline) | ||
92 | |||
93 | _Use at your own risk!_ | ||
94 | |||
95 | Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies, | ||
96 | and [yarn](https://yarnpkg.com/lang/en/docs/install/) | ||
97 | for front-end dependencies. | ||
98 | |||
99 | To get the latest changes from the `master` branch: | ||
100 | |||
101 | ```bash | ||
102 | # clone the repository | ||
103 | $ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ | ||
104 | # install/update third-party dependencies | ||
105 | $ cd /path/to/shaarli | ||
106 | $ composer install --no-dev --prefer-dist | ||
107 | $ make build_frontend | ||
108 | $ make translate | ||
109 | $ make htmldoc | ||
110 | ``` | ||
111 | |||
112 | ------------------------------------------------------------------------------- | ||
113 | |||
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 | |||
118 | ![install screenshot](images/install-shaarli.png) | ||
119 | |||
120 | Setup your Shaarli installation, and it's ready to use! | ||
121 | |||
122 | ## Updating Shaarli | ||
123 | |||
124 | See [Upgrade and Migration](Upgrade-and-migration) | ||