aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Server-configuration.md
Commit message (Collapse)AuthorAgeFilesLines
* Fix: nginx - add rule to disable url-rewriting for the docsArthurHoaro2020-10-211-0/+5
| | | | Related to #1603
* Doc: typoArthurHoaro2020-10-161-1/+1
|
* Support using Shaarli without URL rewritingArthurHoaro2020-10-161-0/+16
| | | | | | | | | - Shaarli can be fully used by prefixing any URL with /index.php/ - {$base_path} used in templates already works with this configuration - Assets path (outside of theme's assets) must be prefixed with {$root_url}/ - Documentation section in « Server configuration » Fixes #1590
* Doc: add PHP 7.4 and 8.0 as supported versionArthurHoaro2020-10-151-2/+4
|
* doc: nginx config: document ipv4 and ipv6 listen directivesnodiscc2020-09-121-1/+4
|
* doc: serve configuration/reverse proxy: fix apache mod_md configuration, ↵nodiscc2020-09-121-40/+38
| | | | move reference links to their respective sections, shorten
* doc: server configuration: fix apache restart commandnodiscc2020-09-121-1/+1
|
* doc: server configuration: enable mod_headersnodiscc2020-09-121-0/+3
|
* doc: server configuration: fix apache site config file namenodiscc2020-09-121-1/+1
|
* doc: server configuration: add reminder to change the example domain namenodiscc2020-09-121-2/+2
|
* doc: server configuration: add asciicast of server configuration procedure ↵nodiscc2020-09-121-0/+7
| | | | (asciinema)
* doc: reverse proxy: update HTTP->HTTPS redirect configuration, remove ↵nodiscc2020-09-121-2/+1
| | | | logging options
* doc: fail2Ban: add note about restarting fail2bannodiscc2020-09-121-0/+2
|
* doc: apache: add example configuration for mod_mdnodiscc2020-09-121-4/+9
|
* doc: server configuration: apache: add note about mod_mdnodiscc2020-09-121-1/+7
|
* doc: server configuration: update apache configuration 2.2 -> 2.4nodiscc2020-09-121-2/+1
| | | | https://httpd.apache.org/docs/current/upgrading.html
* doc: troubleshooting: add procedure to clear shaarli cachesnodiscc2020-09-121-0/+1
|
* doc: server configuration: remove apache logging optionsnodiscc2020-09-121-12/+0
| | | | see https://github.com/nodiscc/xsrv/blob/master/roles/apache/templates/etc_apache2_conf-available_logging.conf.j2 for an example server-wide logging configuration
* doc: server configuration: formatting/add commentnodiscc2020-09-121-3/+2
|
* doc: server configuration: add note on required firewall/NAT for Let's ↵nodiscc2020-09-121-1/+2
| | | | Encrypt certificates
* doc: server configuration: php requirements: add php-simplexmlnodiscc2020-09-121-1/+2
| | | | ref. https://github.com/shaarli/Shaarli/pull/1476
* doc: nginx: add let's encrypt ssl configurationnodiscc2020-09-121-0/+8
|
* doc: nginx: reordernodiscc2020-09-121-3/+3
|
* apache: fix let's encrypt configuration , copy it directly from reference filenodiscc2020-09-121-2/+7
| | | | including options-ssl-apache.conf requires python3-certbot-apache which pulls a lot of dependencies
* doc: php compatibility: add php 7.3nodiscc2020-09-121-0/+1
|
* server-configuration: move firewall/NAT requirements to Network sectionnodiscc2020-09-121-0/+4
|
* fix markdown syntaxnodiscc2020-09-121-1/+1
|
* formatting/emphasisnodiscc2020-09-121-1/+1
|
* **General rewording, proof-reading, deduplication, shortening, reordering, ↵nodiscc2020-09-121-304/+278
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: use obvious <PHP_VERSION> placeholdernodiscc2020-03-091-1/+1
| | | Co-Authored-By: Aurélien Tamisier <virtualtam+github@flibidi.net>
* doc: fix references to php5, use new directory structurenodiscc2020-01-191-1/+1
|
* doc: add explanation of php-json requirementnodiscc2019-11-091-1/+1
|
* Added php-json as required PHP modulerfolo9li2019-11-091-1/+1
| | | | | | | | | | | | Without php-json the installation stops with a white screen and the following error: > 09-Nov-2019 14:05:46 UTC] PHP Fatal error: Uncaught Error: Call to undefined function Shaarli\Config\json_encode() in /var/www/html/shaarli/application/config/ConfigJson.php:48 > Stack trace: > #0 /var/www/html/shaarli/application/config/ConfigManager.php(239): Shaarli\Config\ConfigJson->write('data/config.jso...', Array) > #1 /var/www/html/shaarli/index.php(1835): Shaarli\Config\ConfigManager->write(false) > #2 /var/www/html/shaarli/index.php(178): install(Object(Shaarli\Config\ConfigManager), Object(Shaarli\Security\SessionManager), Object(Shaarli\Security\LoginManager)) > #3 {main} > thrown in /var/www/html/shaarli/application/config/ConfigJson.php on line 48 Tested with Shaarli 0.10.4 on CentOS 8 with Httpd 2.4.37 and PHP 7.2.11.
* Merge pull request #1273 from ArthurHoaro/feature/ban-managerArthurHoaro2019-05-251-0/+2
|\ | | | | Rewrite IP ban management
| * Rewrite IP ban managementArthurHoaro2019-02-091-0/+2
| | | | | | | | | | | | | | This adds a dedicated manager class to handle all ban interactions, which is instantiated and handled by LoginManager. IPs are now stored in the same format as the datastore, through FileUtils. Fixes #1032 #587
* | Documentation: drop PHP 7.0 compatibility in Shaarli 11.xArthurHoaro2019-02-091-1/+1
|/ | | | related to #1249
* doc: update PHP compatibility tabledoc-update-php-compatnodiscc2018-12-091-1/+1
| | | Ref https://github.com/shaarli/Shaarli/issues/1249
* doc: server config: basic usage of robots.txt/HTML robots meta-tag/crawler ↵nodiscc2018-09-091-0/+7
| | | | control mechanisms
* Take code review into accountArthurHoaro2018-07-051-1/+1
| | | | Upgrade web-thumbnailer and display thumbs right after download
* Improve documentation (#598, #1105)nodiscc2018-06-171-92/+119
| | | | | | | | | | | | | | | | * 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
* documentation: fix rendering and internal referencesVirtualTam2017-08-051-14/+28
| | | | | | | | | | | | | | | | | | | 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/+392
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