diff options
author | nodiscc <nodiscc@gmail.com> | 2020-05-16 12:54:51 +0200 |
---|---|---|
committer | nodiscc <nodiscc@gmail.com> | 2020-09-12 14:31:45 +0200 |
commit | 91a21c272960889afd4eaa431a3d29b7785b6efc (patch) | |
tree | 26e3ba62319964c5fd48d93fdfe47813d5dc9bf5 /doc/md/Installation.md | |
parent | 6128ab6a55430a2b705be31ff417c0c552a0db1f (diff) | |
download | Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.tar.gz Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.tar.zst Shaarli-91a21c272960889afd4eaa431a3d29b7785b6efc.zip |
**General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization**
- standardize page names, rework documentation structure, update TOC
- use same example paths everywhere
- level 1 titles on all pages
- fix broken links
- .md suffix on all page links (works both from readthedocs and github repository views)
**Server:**
A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration.
- server: move most server-related info to server-configuration.md, cleanup/shorten
- server: update list of php dependencies/libraries, link to composer.json
- server: installation: support 3 install methods (from release zip, from sources, using docker)
- server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not
- server: add example/basic usage of certbot
- server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root
- server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example
- server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files
- server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section
- server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here
- server: simplify phpinfo documentation
- server: move backup and restore information to dedicated page
- docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet
- troubleshooting: move all troubleshooting documentation to troubleshooting.md
**Usage:**
- index: add getting started section on index page
- features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list
- shaarli configuration: add note about configuring from web interface
**Removed:**
- remove obsolete/orphan images
- remove obsolete shaarchiver example
- remove outdated "decode datastore content" snippet
**Development:**
- development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory
- development: Merge several pages to development.md
- **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag)
- **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details
- development: directory structure: add note about required file permissions
- .travis-ci.yml: add comments
- .htaccess: add comment
Diffstat (limited to 'doc/md/Installation.md')
-rw-r--r-- | doc/md/Installation.md | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/md/Installation.md b/doc/md/Installation.md new file mode 100644 index 00000000..1286a6b2 --- /dev/null +++ b/doc/md/Installation.md | |||
@@ -0,0 +1,84 @@ | |||
1 | # Installation | ||
2 | |||
3 | Once your server is [configured](Server-configuration.md), install Shaarli: | ||
4 | |||
5 | ## From release ZIP | ||
6 | |||
7 | To install Shaarli, simply place the files from the latest [release .zip archive](https://github.com/shaarli/Shaarli/releases) under your webserver's document root (directly at the document root, or in a subdirectory). Download the **shaarli-vX.X.X-full** archive to include dependencies. | ||
8 | |||
9 | ```bash | ||
10 | wget https://github.com/shaarli/Shaarli/releases/download/v0.10.4/shaarli-v0.10.4-full.zip | ||
11 | unzip shaarli-v0.10.4-full.zip | ||
12 | sudo rsync -avP Shaarli/ /var/www/shaarli.mydomain.org/ | ||
13 | ``` | ||
14 | |||
15 | ## From sources | ||
16 | |||
17 | These components are required to build Shaarli: | ||
18 | |||
19 | - [Composer](dev/Development.md#install-composer) to manage third-party [PHP dependencies](dev/Development#third-party-libraries). | ||
20 | - [yarn](https://yarnpkg.com/lang/en/docs/install/) to build frontend dependencies. | ||
21 | - [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build local HTML documentation. | ||
22 | |||
23 | Clone the repository, either pointing to: | ||
24 | |||
25 | - any [tagged release](https://github.com/shaarli/Shaarli/releases) | ||
26 | - `latest`: the latest tagged release | ||
27 | - `master`: development branch | ||
28 | |||
29 | ```bash | ||
30 | # clone the branch/tag of your choice | ||
31 | $ git clone -b latest https://github.com/shaarli/Shaarli.git /home/me/Shaarli | ||
32 | # OR download/extract the tar.gz/zip: wget https://github.com/shaarli/Shaarli/archive/latest.tar.gz... | ||
33 | |||
34 | # enter the directory | ||
35 | $ cd /home/me/Shaarli | ||
36 | # install 3rd-party PHP dependencies | ||
37 | $ composer install --no-dev --prefer-dist | ||
38 | # build frontend static assets | ||
39 | $ make build_frontend | ||
40 | # build translations | ||
41 | $ make translate | ||
42 | # build HTML documentation | ||
43 | $ make htmldoc | ||
44 | # copy the resulting shaarli directory under your webserver's document root | ||
45 | $ rsync -avP /home/me/Shaarli/ /var/www/shaarli.mydomain.org/ | ||
46 | ``` | ||
47 | |||
48 | ## Set file permissions | ||
49 | |||
50 | Regardless of the installation method, appropriate [file permissions](dev/Development.md#directory-structure) must be set: | ||
51 | |||
52 | ```bash | ||
53 | # by default, deny access to everything to the web server | ||
54 | sudo chown -R root:www-data /var/www/shaarli.mydomain.org | ||
55 | sudo chmod -R u=rwX /var/www/shaarli.mydomain.org | ||
56 | # allow read-only access to these files/directories | ||
57 | sudo chmod -R g+rX /var/www/shaarli.mydomain.org/{index.php,application/,plugins/,inc/} | ||
58 | # allow read/write access to these directories | ||
59 | sudo chmod -R g+rwX /var/www/shaarli.mydomain.org/{cache/,data/,pagecache/,tmp/} | ||
60 | ``` | ||
61 | |||
62 | |||
63 | ## Using Docker | ||
64 | |||
65 | [See the documentation](Docker.md) | ||
66 | |||
67 | |||
68 | |||
69 | ## Finish Installation | ||
70 | |||
71 | Once Shaarli is downloaded and files have been placed at the correct location, open this location your web browser. | ||
72 | |||
73 | Enter basic settings for your Shaarli installation, and it's ready to use! | ||
74 | |||
75 | ![](images/07-installation.jpg) | ||
76 | |||
77 | Congratulations! Your Shaarli is now available at `https://shaarli.mydomain.org`. | ||
78 | |||
79 | You can further [configure Shaarli](Shaarli-configuration.md), setup [Plugins](Plugins.md) or [additional software](Community-and-related-software.md). | ||
80 | |||
81 | |||
82 | ## Upgrading Shaarli | ||
83 | |||
84 | See [Upgrade and Migration](Upgrade-and-migration) | ||