aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Download-and-Installation.md
Commit message (Collapse)AuthorAgeFilesLines
* **General rewording, proof-reading, deduplication, shortening, reordering, ↵nodiscc2020-09-121-124/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: fix broken markdown linknodiscc2019-08-011-1/+1
| | | | fixes https://github.com/shaarli/Shaarli/issues/1330
* Update README, CHANGELOG and AUTHORS for v0.10.4VirtualTam2019-04-161-3/+3
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Update badges, changelog and documentation for v0.10.3VirtualTam2019-02-241-3/+3
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Merge pull request #1155 from shaarli/doc-improvementsnodiscc2018-06-211-4/+3
|\ | | | | Improve documentation (#598, #1105)
| * Improve documentation (#598, #1105)nodiscc2018-06-171-4/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* | Update version badges and installation instructionsVirtualTam2018-06-201-4/+4
|/ | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Webpack / Documentation updateArthurHoaro2018-03-281-1/+6
|
* Documentation: release v0.9.6VirtualTam2018-03-251-3/+3
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Update CHANGELOG, README badges and installation instructionsVirtualTam2018-01-041-4/+4
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* doc: fix docker documentation linknodiscc2017-12-091-1/+1
|
* documentation cleanupnodiscc2017-11-181-10/+22
| | | | | | | * In preparation of #930 work * Remove/reorder duplicate documentation from Makefile/Unit-tests.md/Download-and-Installation.md (composer information is now in Unit-tests.md) * Installation using git: add composer requirement to all git installation procedures, add python3-virtualenv requirement * Styling (horizontal rulers, spacing, descriptive headers)
* Merge pull request #1002 from ArthurHoaro/doc/install-dockerArthurHoaro2017-10-221-3/+11
|\ | | | | Docs: mention Docker in the download & install page
| * Doc: mention Docker docs in the download & install pageArthurHoaro2017-10-221-3/+11
| |
* | Translation documentationArthurHoaro2017-10-221-1/+3
|/
* documentation: update installation instructions for 0.9.1VirtualTam2017-08-231-3/+3
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: update release download and usage informationVirtualTam2017-08-051-4/+4
| | | | Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* documentation: fix rendering and internal referencesVirtualTam2017-08-051-17/+16
| | | | | | | | | | | | | | | | | | | This is mainly cleanup after switching from Github-flavoured Markdown rendered by Github Pages, to standard Markdown rendered by MkDocs. Changed: - rephrase some section titles Fixed: - list rendering (items, sub-items)) - code rendering - quotes - dead links Removed: - extraneous navigational elements Signed-off-by: VirtualTam <virtualtam@flibidi.net>
* Generate HTML documentation using MkDocs (WIP)nodiscc2017-06-181-0/+99
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-06 10:08:49 +0000