Commit graph

304 commits

Author SHA1 Message Date
nodiscc
8c4c408072
doc: shaarli configuration: update thumbnails-related configuration settings/examples
- remove obsolete config keys
2022-09-04 12:23:08 +02:00
nodiscc
fdfc09f73f
tests: update base alpine image to v3.16 in test Dockerfiles 2022-08-10 20:15:21 +02:00
nodiscc
febe0a6487 doc: installation/tests: clarify build tools installation procedure
- don't repeat link to getcomposer.org
- add an example of installing build dependencies on Debian
2022-04-06 19:29:35 +02:00
nodiscc
7ae4b2f8b0
doc: add "formatter" key to example config.json.php
- fixes https://github.com/shaarli/Shaarli/issues/1680
2021-10-10 15:11:38 +02:00
nodiscc
df0ca43873
doc: remove duplicate "general" key in example config.php.json
- ref. https://github.com/shaarli/Shaarli/issues/1680
2021-10-10 15:09:57 +02:00
nodiscc
e0f4fd4537
doc: fix homepage title/icon rendering
- fixes https://github.com/shaarli/Shaarli/issues/1774
2021-09-26 21:53:41 +02:00
Keith Carangelo
a7d43caccb Added support for OR (~) and optional AND (+) operators for tag searches. 2021-09-08 15:26:58 -04:00
ToM
63fe4881cc doc: remove the markdown plugin from the plugins list
The plugin is now part of core since v0.12.0
2021-08-01 16:44:31 +02:00
nodiscc
a79707258f
Merge pull request #1768 from nodiscc/doc-proxy-subdirectory
doc: add notice about nginx location directive when shaarli is installed in a subdirectory
2021-07-19 17:02:29 +00:00
nodiscc
1a36e314ba
Merge pull request #1769 from nodiscc/doc-php-ldap
doc: LDAP login support, update php requirements list
2021-07-19 17:02:14 +00:00
nodiscc
4cfaa67e07
Merge pull request #1767 from nodiscc/doc-bookmarklet
doc: bookmarklet is now working on github.com
2021-07-19 17:02:05 +00:00
nodiscc
4a63c2bbb4
doc: LDAP login support, update php requirements list
- fixes https://github.com/shaarli/Shaarli/issues/1677
2021-06-17 17:57:07 +02:00
nodiscc
f841121a6e
doc: add notice about nginx location directive when shaarli is installed in a subdirectory
- fixes https://github.com/shaarli/Shaarli/issues/1679
2021-06-17 17:50:56 +02:00
nodiscc
2a569f1e93
doc: bookmarklet is now working on github.com
- left generic paragraph about this problem in place, since the problem may still be present on other sites
- closes https://github.com/shaarli/Shaarli/issues/1730
2021-06-17 17:46:00 +02:00
nodiscc
eeaabc05a7
build and push docker images using github actions
- push images to https://hub.docker.com/r/shaarli/shaarli/tags using a personal access token (access tokens are not available for organizations)
- push an image tagged :latest for builds on master
- push an image with the same tag as the git tag for v*.*.* tags, and for the "release" branch
- update documentation (remove references to Travis/Drone CI
- deprecate stable and master Docker tags (ref. https://github.com/shaarli/Shaarli/issues/1453)
- add deprecation notices to CHANGELOG.md
2021-06-15 20:35:36 +02:00
nodiscc
d4da270289
doc: update CI documentation
- use cloud.drone.io badges for builds on the master branch
- stable/0.x badges will need to be updated when the next stable/0.x release is published
2021-05-13 14:28:25 +02:00
ArthurHoaro
e660450a2b Fix documentation build
- pages parameters has been deprecated and renamed by nav
  - the build fails with an empty extra_css array
2021-05-13 11:36:37 +02:00
Alexander Railean
060e6d9498 Correct HTTP status code 206->406 2021-04-12 21:05:21 +02:00
Alexander Railean
e00b9dc099 Add '206 not acceptable' to the Troubleshooting section 2021-04-12 21:03:43 +02:00
nodiscc
9700d9ea3e
doc: plugins.md: fix link casing
fixes https://github.com/shaarli/Shaarli/issues/1737
2021-04-12 18:15:58 +00:00
nodiscc
9f87e82cdb
Merge pull request #1734 from ArthurHoaro/doc/php-extensions
Documentation: include all PHP extensions installed in our official Docker image
2021-04-05 10:52:37 +00:00
ArthurHoaro
5bf3deb815
Merge pull request #1733 from ArthurHoaro/feature/phpcs-tests 2021-04-05 11:34:03 +02:00
ArthurHoaro
ba4fa9460a Documentation: include all PHP extensions installed in our official Docker image
Fixes #1700
2021-04-05 11:27:45 +02:00
ArthurHoaro
44b0825860 Coding style: update documentation (static analysis section)
Related to #95
2021-04-05 11:08:02 +02:00
nodiscc
8b8ed23ae1
Merge pull request #1718 from shaarli/doc-apache-directoryindex
doc: apache: explicitly set index.php as DirectoryIndex
2021-03-27 14:17:40 +00:00
nodiscc
3bb6205e7f
doc: apache: explicitely ste index.php as DirectoryIndex
WIthout this directive apache will try other default/global DirectoryIndex files resulting in useless file access/error messages in logs

```
[Sun Mar 07 14:04:25.383960 2021] [authz_core:error] [pid 946:tid 139985284290304] [client 10.0.0.1:42616] AH01630: client denied by server configuration: /var/www/links.example.org/index.html
[Sun Mar 07 14:04:25.384293 2021] [authz_core:error] [pid 946:tid 139985284290304] [client 10.0.0.1:42616] AH01630: client denied by server configuration: /var/www/links.example.org/index.cgi
[Sun Mar 07 14:04:25.384465 2021] [authz_core:error] [pid 946:tid 139985284290304] [client 10.0.0.1:42616] AH01630: client denied by server configuration: /var/www/links.example.org/index.pl
```
2021-03-07 13:08:31 +00:00
jalr
94dadd85a0
Fix typo 2021-03-07 10:58:15 +00:00
ArthurHoaro
bcba6bd353 New plugin hook: ability to add custom filters to Shaarli search engine
A new plugin hook has been added: hook_test_filter_search_entry
This hook allows to filter out bookmark with custom plugin code when a search is performed.

Related to #143
2021-02-04 11:02:50 +01:00
leyrer
151fa1e450 Typo fix line 76 'Authentication' -> Authorization 2020-12-26 13:45:01 +01:00
ArthurHoaro
bd11879018
Merge pull request #1645 from ArthurHoaro/feature/plugin-register-route
Plugin system: allow plugins to provide custom routes
2020-12-16 16:04:15 +01:00
ArthurHoaro
a6e9c08499 Plugin system: allow plugins to provide custom routes
- each route will be prefixed by `/plugin/<plugin_name>`
  - add a new template for plugins rendering
  - add a live example in the demo_plugin

Check out the "Plugin System" documentation for more detail.

Related to #143
2020-11-15 12:41:43 +01:00
ArthurHoaro
831e974ea5 Doc: fix missing merge on Release page 2020-11-12 13:16:20 +01:00
ArthurHoaro
302662797c
Merge pull request #1635 from ArthurHoaro/feature/phpcs 2020-11-10 10:46:04 +01:00
ArthurHoaro
7e78237fc9
Merge pull request #1630 from ArthurHoaro/fix/apache-config
Reviewed Apache configuration
2020-11-10 10:45:05 +01:00
ArthurHoaro
325cc8adad
Merge pull request #1634 from ArthurHoaro/fix/docker-compose
Docker-compose: fix SSL certificate + add parameter for Docker tag
2020-11-10 10:44:50 +01:00
ArthurHoaro
8affa22431
Merge pull request #1628 from ArthurHoaro/fix/nginx-config
Reviewed nginx configuration
2020-11-10 10:44:29 +01:00
ArthurHoaro
2f4df75304 Update Static Analysis documentation 2020-11-09 12:17:40 +01:00
ArthurHoaro
b7c50a58de Docker-compose: fix SSL certificate + add parameter for Docker tag
Use envvar SHAARLI_VIRTUAL_HOST for Traefik's docker.domain parameter instead of localhost (I'm not sure if did work at some point).

Add an environment variable to choose which Docker tag to use instead of using master by default.

Fixes #1632
2020-11-09 10:36:13 +01:00
ArthurHoaro
8a9796014c Reviewed Apache configuration
(in documentation)

For security purpose, block access to any static file not matching the list of allowed extensions.
It allows us to remove the specific retriction on dotfiles, and fix Apache part of #1608.
2020-11-08 13:13:13 +01:00
ArthurHoaro
ce901a5828 Reviewed nginx configuration
Both in documentation and Docker image.

For security purpose, it no longer allow to access static files through
the main nginx *location*. Static files are served if their extension
matches the whitelist.

As a side effect, we no longer need specific restrictions, and
therefore it fixes the nginx part of #1608.
2020-11-07 14:27:49 +01:00
ArthurHoaro
b3bd8c3e8d Feature: support any tag separator
So it allows to have multiple words tags.

Breaking change: commas ',' are no longer a default separator.

Fixes #594
2020-11-05 17:54:42 +01:00
ArthurHoaro
740b32b520 Default formatter: add a setting to disable auto-linkification
+ update documentation
  + single parameter for both URL and hashtags

Fixes #1094
2020-11-03 12:43:35 +01:00
ArthurHoaro
2f87bfdc69 Fix: nginx - add rule to disable url-rewriting for the docs
Related to #1603
2020-10-21 15:23:30 +02:00
ArthurHoaro
9b3c1270bc
Merge pull request #1567 from ArthurHoaro/feature/async-title-retrieval 2020-10-20 10:14:28 +02:00
ArthurHoaro
7836ed9b2e Doc: typo 2020-10-16 19:20:45 +02:00
ArthurHoaro
3adbdc2a83 Inject ROOT_PATH in plugin instead of regenerating it everywhere 2020-10-16 13:06:06 +02:00
ArthurHoaro
7f5250421b Support using Shaarli without URL rewriting
- 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
2020-10-16 12:47:11 +02:00
ArthurHoaro
4cf3564d28 Add a setting to retrieve bookmark metadata asynchrounously
- There is a new standalone script (metadata.js) which requests
    a new controller to get bookmark metadata and fill the form async
  - This feature is enabled with the new setting: general.enable_async_metadata
    (enabled by default)
  - general.retrieve_description is now enabled by default
  - A small rotating loader animation has a been added to bookmark inputs
    when metadata is being retrieved (default template)
  - Custom JS htmlentities has been removed and  mathiasbynens/he
    library is used instead

Fixes #1563
2020-10-15 09:08:46 +02:00
ArthurHoaro
ec45749187 Doc: add PHP 7.4 and 8.0 as supported version 2020-10-15 09:01:41 +02:00
ArthurHoaro
769a28833b
Merge pull request #1566 from nodiscc/makefile-composer-install
doc/Makefile: remove references to composer update
2020-09-30 11:12:17 +02:00