aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* Merge pull request #1566 from nodiscc/makefile-composer-installArthurHoaro2020-09-301-10/+5
|\ | | | | doc/Makefile: remove references to composer update
| * doc/Makefile: remove references to composer updatenodiscc2020-09-241-10/+5
| | | | | | | | | | | | - add make composer_dependencies_dev Makefile target and use this instead - fix composer initial installation procedure - fix php-xdebug install instructions
* | Merge pull request #1558 from ArthurHoaro/fix/plugins-base-pathArthurHoaro2020-09-251-0/+14
|\ \ | |/ |/| Fix plugin base path in core plugins
| * Fix plugin base path in core pluginsArthurHoaro2020-09-221-0/+14
| | | | | | | | | | | | | | Also fix note check in archiveorg plugin, and regression on vintage template. Documentation regarding relative path has been added. Fixes #1548
* | Add manual configuration for root URLArthurHoaro2020-09-121-35/+36
|/ | | | | | This new setting under 'general.root_url' allows to override automatic discovery of Shaarli instance's URL. Fixes #1339
* doc: Docker minor improvementsArthurHoaro2020-09-121-19/+40
|
* Add 2 plugins to the 3rd party plugin listImmánuel!2020-09-121-1/+3
| | | | Besides adding 2 new plugins, also reordered the list by ABC and fixed some discrepancies in the details to restore balance in the force
* doc: nginx config: document ipv4 and ipv6 listen directivesnodiscc2020-09-121-1/+4
|
* doc: apache config: remove useless documentroot directive in HTTP-only ↵nodiscc2020-09-121-1/+0
| | | | virtualhost (only used for redirects)
* doc: serve configuration/reverse proxy: fix apache mod_md configuration, ↵nodiscc2020-09-122-47/+66
| | | | 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: updagrde/migration: simplify permissions setupnodiscc2020-09-121-4/+2
|
* doc: installation: simplify permissions setupnodiscc2020-09-121-7/+1
|
* doc: docker: update docker-compose to 1.26.2nodiscc2020-09-121-1/+1
|
* doc: installation: bump version to 0.11.1nodiscc2020-09-121-2/+2
|
* doc: reverse proxy: update HTTP->HTTPS redirect configuration, remove ↵nodiscc2020-09-122-8/+12
| | | | 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: Community-and-related-software.md: order plugins alphabeticallynodiscc2020-09-121-6/+6
|
* doc: plugins: remove doc about deprecated ↵nodiscc2020-09-121-17/+1
| | | | $GLOBALS['config']['ENABLED_PLUGINS'] array
* doc: troubleshooting: add procedure to clear shaarli cachesnodiscc2020-09-122-0/+11
|
* 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
* Removing dead link in docLucas Cimon2020-09-121-1/+1
| | | As it currently redirects to https://www.lgblog.fr
* doc: document dev.debug configuration ettingnodiscc2020-09-121-0/+3
| | | | ref. https://github.com/shaarli/Shaarli/pull/779
* add shaarli-default-dark to the themes listowen bell2020-09-121-0/+1
|
* Added links to doc section "Articles and social media discussions"Lucas Cimon2020-09-121-3/+10
|
* doc: server configuration: php requirements: add php-simplexmlnodiscc2020-09-121-1/+2
| | | | ref. https://github.com/shaarli/Shaarli/pull/1476
* doc: Community-and-related-software: add shaarli-webhooks pluginnodiscc2020-09-121-0/+1
|
* doc: add note about importing browser bookmarks folder structure to shaarli tagsnodiscc2020-09-121-0/+1
| | | | ref. https://github.com/shaarli/Shaarli/issues/1449
* doc: troubleshooting: improve compatibility with PHP 5.6/FTP upload limitsnodiscc2020-09-121-6/+11
| | | | ref. https://github.com/shaarli/Shaarli/issues/1469
* doc: usage: active filters/clear search filtersnodiscc2020-09-121-1/+2
|
* 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
|
* doc: docker.md: fix stray code blocknodiscc2020-09-121-2/+1
|
* **General rewording, proof-reading, deduplication, shortening, reordering, ↵nodiscc2020-09-1254-2408/+1794
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-29 14:47:06 +0000