Commit graph

213 commits

Author SHA1 Message Date
nodiscc 30255b794a doc: php compatibility: add php 7.3 2020-09-12 14:31:45 +02:00
nodiscc 41b93897f3 server-configuration: move firewall/NAT requirements to Network section 2020-09-12 14:31:45 +02:00
nodiscc 6384447d1d fix markdown syntax 2020-09-12 14:31:45 +02:00
nodiscc a32e6665d0 formatting/emphasis 2020-09-12 14:31:45 +02:00
nodiscc fe007f94e4 doc: docker.md: fix stray code block 2020-09-12 14:31:45 +02:00
nodiscc 91a21c2729 **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
2020-09-12 14:31:45 +02:00
ArthurHoaro 80b708a878 Inject BookmarkServiceInterface in plugins data
Related discussion: ilesinge/shaarli-related#7
2020-09-03 15:08:08 +02:00
ArthurHoaro 8e9169ceba Update French translation 2020-07-23 21:19:21 +02:00
ArthurHoaro 1a8ac737e5 Process main page (linklist) through Slim controller
Including a bunch of improvements on the container,
and helper used across new controllers.
2020-07-23 21:19:21 +02:00
ArthurHoaro 1b8620b1ad Process plugins administration page through Slim controllers 2020-07-23 21:19:21 +02:00
ArthurHoaro 78657347c5 Process bookmarks import through Slim controller 2020-07-23 21:19:21 +02:00
ArthurHoaro c70ff64a61 Process bookmark exports through Slim controllers 2020-07-23 21:19:21 +02:00
ArthurHoaro 9c75f87793 Use multi-level routes for existing controllers instead of 1 level everywhere
Also prefix most admin routes with /admin/
2020-07-23 21:19:21 +02:00
ArthurHoaro c22fa57a55 Handle shaare creation/edition/deletion through Slim controllers 2020-07-23 21:19:21 +02:00
ArthurHoaro 66063ed1a1 Process configure page through Slim controller 2020-07-23 21:19:21 +02:00
ArthurHoaro ba43064ddb Process tools page through Slim controller 2020-07-23 21:19:21 +02:00
ArthurHoaro 2899ebb5b5 Initialize admin Slim controllers
- Reorganize visitor controllers
  - Fix redirection with Slim's requests base path
  - Fix daily links
2020-07-23 21:19:21 +02:00
ArthurHoaro 7b2ba6ef82 RSS/ATOM feeds: process through Slim controller 2020-07-23 21:19:21 +02:00
ArthurHoaro 60ae241251 Process tag list page through Slim controller 2020-07-23 21:19:21 +02:00
ArthurHoaro c266a89d0f Process tag cloud page through Slim controller 2020-07-23 21:19:21 +02:00
ArthurHoaro 485b168a96 Process picwall rendering through Slim controller + UT 2020-07-23 21:19:21 +02:00
ArthurHoaro 78c2f122e0
Merge pull request #1428 from pipoprods/feat/ldap-auth 2020-06-25 16:53:18 +02:00
flow.gunso 50c9543f7b Add an example for the description variable to the meta file 2020-05-15 22:47:19 +02:00
flow.gunso 8f6202deb0 Document about the .meta file at the plugin creation/initialization 2020-05-15 22:17:48 +02:00
nodiscc 752bc4c5e6
Merge pull request #1403 from shaarli/doc-composer
doc: simplify composer installation procedure, merge Unit tests related pages, reword/shorten, fix references to old php versions
2020-04-11 13:06:30 +00:00
nodiscc 2dd6ecb126 doc: composer update should actually be removed as it alters the Composer lock file 2020-04-11 13:53:15 +02:00
nodiscc dbbcb0c6cf
doc: use <PHP_VERSION>, fix php.ini path
Co-Authored-By: Aurélien Tamisier <virtualtam+github@flibidi.net>
2020-03-09 17:44:12 +00:00
nodiscc 273453900a
doc: use obvious <PHP_VERSION> placeholder
Co-Authored-By: Aurélien Tamisier <virtualtam+github@flibidi.net>
2020-03-09 17:43:45 +00:00
nodiscc 1ea8aeef76
doc: fix php.ini path
Co-Authored-By: Aurélien Tamisier <virtualtam+github@flibidi.net>
2020-03-09 17:43:09 +00:00
Sébastien NOBILI cc2ded54e1 ldap authentication, fixes shaarli/Shaarli#1343 2020-03-02 17:13:18 +01:00
ArthurHoaro 9e4cc28e29 Fix all existing links and redirection to ?do=login 2020-01-26 11:34:14 +01:00
nodiscc 04a816f648 doc: fix references to php5, use new directory structure 2020-01-19 13:52:03 +01:00
nodiscc 3b04d19a62 doc: fix reference to old version of php-xdebug package 2020-01-19 13:49:48 +01:00
nodiscc 54ab5636e3 doc: merge unit tests/docker unit tests pages, simplfy, reword 2020-01-19 13:18:29 +01:00
nodiscc a8a38401f0 doc: reword simplify xdebug installation/unit tests 2020-01-19 13:11:11 +01:00
nodiscc 7a7a523782 doc: simplify unit tests documentation 2020-01-19 13:09:23 +01:00
nodiscc 6fa3c87d32 doc: simplify composer installation procedure 2020-01-19 13:05:21 +01:00
Sebastien Wains fecfc73b3f
Ulauncher Extension 2020-01-18 15:22:49 +01:00
ArthurHoaro cf92b4dd15 Apply the new system (Bookmark + Service) to the whole code base
See https://github.com/shaarli/Shaarli/issues/1307
2020-01-18 09:55:59 +01:00
ArthurHoaro ef02885753
Merge pull request #1358 from shaarli/doc-add-screenshots
Doc: add screenshots of all pages
2020-01-17 18:27:42 +01:00
nodiscc 74c1d02079 doc: siplify troubleshooting, link to reference docs, reorder 2020-01-04 00:28:04 +01:00
nodiscc 5256f83d02 doc: troubleshooting: add note about error 500/internal server error caused by apache 2.2 and no mod_version 2020-01-04 00:19:25 +01:00
nodiscc eb0a0f77cc
doc: remove obsolete link 2019-11-27 19:28:26 +00:00
nodiscc af8a03d1ab
doc: remove obsolete link 2019-11-27 19:28:06 +00:00
Guillaume Virlet 72539044fb Fix #1382 - update documentation related to docker images base image and PHP version used 2019-11-26 22:12:34 +01:00
nodiscc 3575fe5bcf
doc: add explanation of php-json requirement 2019-11-09 15:40:53 +00:00
rfolo9li 54b065c253
Added php-json as required PHP module
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.
2019-11-09 15:24:10 +01:00
nodiscc f4c6625962
Merge pull request #1366 from shaarli/doc-setuptools-mkdocs
doc: CI/dev tools: add paragraph about documentation/mkdocs
2019-10-02 19:57:59 +00:00
nodiscc b4665de89b
fix typo 2019-10-02 19:57:40 +00:00
Neros bda0d35a51
emojione & twemoji removed
Since emojis are in every web browsers now, these plugins have no purpose anymore. And they are very outdated.
2019-09-25 20:03:58 +02:00