aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Download-and-Installation.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2018-04-20 23:16:59 +0200
committernodiscc <nodiscc@gmail.com>2018-06-17 18:56:00 +0200
commitbdfb967ca2f9d75791a2da2bb189d63df33638cc (patch)
tree877d38339e2648e18390bf6cd1deeaa8c42c6185 /doc/md/Download-and-Installation.md
parent26b0b2022870a540c1a6d54e949c4bdc1486daed (diff)
downloadShaarli-bdfb967ca2f9d75791a2da2bb189d63df33638cc.tar.gz
Shaarli-bdfb967ca2f9d75791a2da2bb189d63df33638cc.tar.zst
Shaarli-bdfb967ca2f9d75791a2da2bb189d63df33638cc.zip
Improve documentation (#598, #1105)
* rework/simplify server configuration/requirements pages (consolidate/simplify SSL/TLS/apache configuration) * update index.md introduction * remove external images (badges) * Fix COPYING link and documentation links * Update features list * dedpulicate information * remove server-requirements.md and move relevant doc to other files * TODO: rework nginx configuration (single configuration example, with commented out blocks for special cases) * TODO: consolidate download/install/configuration pages * remove blank lighttpd configuration section * remove Required? column for composer packages, all libraries are mandatory * php 7.2 compatibilty * clarify that certbot binary and paths may vary depending on install method
Diffstat (limited to 'doc/md/Download-and-Installation.md')
-rw-r--r--doc/md/Download-and-Installation.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md
index 20138f49..ebda2e8a 100644
--- a/doc/md/Download-and-Installation.md
+++ b/doc/md/Download-and-Installation.md
@@ -1,8 +1,7 @@
1To install Shaarli, simply place the files in a directory under your webserver's 1To install Shaarli, simply place the files in a directory under your webserver's
2Document Root (or directly at the document root). 2Document Root (or directly at the document root).
3 3
4Also, please make sure your server meets the [requirements](Server-requirements) 4Also, please make sure your server is properly [configured](Server-configuration).
5and is properly [configured](Server-configuration).
6 5
7Multiple releases branches are available: 6Multiple releases branches are available:
8 7
@@ -23,7 +22,7 @@ Using one of the following methods:
23 22
24### Download as an archive 23### Download as an archive
25 24
26In 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. 25In 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.
27 26
28The current latest released version is `v0.9.6` 27The current latest released version is `v0.9.6`
29 28
@@ -37,7 +36,7 @@ $ mv Shaarli /path/to/shaarli/
37 36
38Cloning using `git` or downloading Github branches as zip files requires additional steps: 37Cloning using `git` or downloading Github branches as zip files requires additional steps:
39 38
40 * Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. 39 * Install [Composer](Unit-tests.md#install_composer) to manage third-party [PHP dependencies](3rd-party-libraries.md#composer).
41 * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies. 40 * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies.
42 * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation. 41 * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation.
43 42