From 91a21c272960889afd4eaa431a3d29b7785b6efc Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 16 May 2020 12:54:51 +0200 Subject: **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 --- doc/md/Download-and-Installation.md | 124 ------------------------------------ 1 file changed, 124 deletions(-) delete mode 100644 doc/md/Download-and-Installation.md (limited to 'doc/md/Download-and-Installation.md') 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 @@ -To install Shaarli, simply place the files in a directory under your webserver's -Document Root (or directly at the document root). - -Also, please make sure your server is properly [configured](Server-configuration.md). - -Multiple releases branches are available: - -- latest (last release) -- stable (previous major release) -- master (development) - -Using one of the following methods: - -- by downloading full release archives including all dependencies -- by downloading Github archives -- by cloning the Git repository -- using Docker: [see the documentation](docker/shaarli-images.md) - --------------------------------------------------------------------------------- - -## Latest release (recommended) - -### Download as an archive - -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. - -The current latest released version is `v0.10.4` - -```bash -$ wget https://github.com/shaarli/Shaarli/releases/download/v0.10.4/shaarli-v0.10.4-full.zip -$ unzip shaarli-v0.10.4-full.zip -$ mv Shaarli /path/to/shaarli/ -``` - -### Using git - -Cloning using `git` or downloading Github branches as zip files requires additional steps: - - * Install [Composer](Unit-tests.md#install_composer) to manage third-party [PHP dependencies](3rd-party-libraries.md#composer). - * Install [yarn](https://yarnpkg.com/lang/en/docs/install/) to build the frontend dependencies. - * Install [python3-virtualenv](https://pypi.python.org/pypi/virtualenv) to build the local HTML documentation. - -``` -$ mkdir -p /path/to/shaarli && cd /path/to/shaarli/ -$ git clone -b latest https://github.com/shaarli/Shaarli.git . -$ composer install --no-dev --prefer-dist -$ make build_frontend -$ make translate -$ make htmldoc -``` - --------------------------------------------------------------------------------- - -## Stable version - -The stable version has been experienced by Shaarli users, and will receive security updates. - - -### Download as an archive - -As a .zip archive: - -```bash -$ wget https://github.com/shaarli/Shaarli/archive/stable.zip -$ unzip stable.zip -$ mv Shaarli-stable /path/to/shaarli/ -``` - -As a .tar.gz archive : - -```bash -$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz -$ tar xvf stable.tar.gz -$ mv Shaarli-stable /path/to/shaarli/ -``` - -### Using git - -Install [Composer](Unit-tests.md#install_composer) to manage Shaarli dependencies. - -```bash -$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ -# install/update third-party dependencies -$ cd /path/to/shaarli/ -$ composer install --no-dev --prefer-dist -``` - - --------------------------------------------------------------------------------- - -## Development version (mainline) - -_Use at your own risk!_ - -Install [Composer](Unit-tests.md#install_composer) to manage Shaarli PHP dependencies, -and [yarn](https://yarnpkg.com/lang/en/docs/install/) -for front-end dependencies. - -To get the latest changes from the `master` branch: - -```bash -# clone the repository -$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ -# install/update third-party dependencies -$ cd /path/to/shaarli -$ composer install --no-dev --prefer-dist -$ make build_frontend -$ make translate -$ make htmldoc -``` - -------------------------------------------------------------------------------- - -## Finish Installation - -Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. - -![install screenshot](images/install-shaarli.png) - -Setup your Shaarli installation, and it's ready to use! - -## Updating Shaarli - -See [Upgrade and Migration](Upgrade-and-migration) -- cgit v1.2.3