From 53ed6d7d1e678d7486337ce67a2f17b30bac21ac Mon Sep 17 00:00:00 2001 From: nodiscc Date: Thu, 26 Jan 2017 18:52:54 +0100 Subject: Generate HTML documentation using MkDocs (WIP) 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 --- doc/md/3rd-party-libraries.md | 13 + doc/md/Backup,-restore,-import-and-export.md | 63 ++ doc/md/Bookmarklet.md | 30 + doc/md/Browsing-and-searching.md | 23 + doc/md/Coding-guidelines.md | 5 + doc/md/Community-&-Related-software.md | 60 ++ doc/md/Continuous-integration-tools.md | 24 + ...g-installation-over-SSH-and-serve-it-locally.md | 66 ++ .../Create-and-serve-multiple-Shaarlis-(farm).md | 57 ++ doc/md/Datastore-hacks.md | 25 + doc/md/Development-guidelines.md | 9 + doc/md/Directory-structure.md | 34 + doc/md/Docker-101.md | 62 ++ doc/md/Docker-resources.md | 19 + doc/md/Download-CSS-styles-from-an-OPML-list.md | 154 +++++ doc/md/Download-and-Installation.md | 99 +++ .../Example-patch---add-new-via-field-for-links.md | 189 ++++++ doc/md/FAQ.md | 43 ++ doc/md/Features.md | 24 + doc/md/Firefox-share.md | 15 + doc/md/GnuPG-signature.md | 76 +++ doc/md/Plugin-System.md | 710 +++++++++++++++++++++ doc/md/Plugins.md | 75 +++ doc/md/REST-API.md | 104 +++ doc/md/RSS-feeds.md | 26 + doc/md/Release-Shaarli.md | 168 +++++ doc/md/Reverse-proxy-configuration.md | 6 + doc/md/Security.md | 27 + doc/md/Server-configuration.md | 392 ++++++++++++ doc/md/Server-requirements.md | 40 ++ doc/md/Server-security.md | 73 +++ doc/md/Shaarli-configuration.md | 215 +++++++ doc/md/Shaarli-images.md | 72 +++ doc/md/Static-analysis.md | 11 + doc/md/Theming.md | 84 +++ doc/md/Troubleshooting.md | 123 ++++ doc/md/Unit-tests.md | 152 +++++ doc/md/Upgrade-and-migration.md | 194 ++++++ doc/md/Versioning-and-Branches.md | 75 +++ doc/md/_Footer.md | 1 + doc/md/_Sidebar.md | 45 ++ doc/md/config.json | 6 + doc/md/github-markdown.css | 287 +++++++++ doc/md/images/bookmarklet.png | Bin 0 -> 53346 bytes doc/md/images/doc-logo.png | Bin 0 -> 19543 bytes doc/md/images/doc-logo.svg | 522 +++++++++++++++ doc/md/images/firefoxshare.png | Bin 0 -> 757 bytes doc/md/images/rss-filter-1.png | Bin 0 -> 18682 bytes doc/md/images/rss-filter-2.png | Bin 0 -> 15604 bytes doc/md/index.md | 11 + 50 files changed, 4509 insertions(+) create mode 100644 doc/md/3rd-party-libraries.md create mode 100644 doc/md/Backup,-restore,-import-and-export.md create mode 100644 doc/md/Bookmarklet.md create mode 100644 doc/md/Browsing-and-searching.md create mode 100644 doc/md/Coding-guidelines.md create mode 100644 doc/md/Community-&-Related-software.md create mode 100644 doc/md/Continuous-integration-tools.md create mode 100644 doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md create mode 100644 doc/md/Create-and-serve-multiple-Shaarlis-(farm).md create mode 100644 doc/md/Datastore-hacks.md create mode 100644 doc/md/Development-guidelines.md create mode 100644 doc/md/Directory-structure.md create mode 100644 doc/md/Docker-101.md create mode 100644 doc/md/Docker-resources.md create mode 100644 doc/md/Download-CSS-styles-from-an-OPML-list.md create mode 100644 doc/md/Download-and-Installation.md create mode 100644 doc/md/Example-patch---add-new-via-field-for-links.md create mode 100644 doc/md/FAQ.md create mode 100644 doc/md/Features.md create mode 100644 doc/md/Firefox-share.md create mode 100644 doc/md/GnuPG-signature.md create mode 100644 doc/md/Plugin-System.md create mode 100644 doc/md/Plugins.md create mode 100644 doc/md/REST-API.md create mode 100644 doc/md/RSS-feeds.md create mode 100644 doc/md/Release-Shaarli.md create mode 100644 doc/md/Reverse-proxy-configuration.md create mode 100644 doc/md/Security.md create mode 100644 doc/md/Server-configuration.md create mode 100644 doc/md/Server-requirements.md create mode 100644 doc/md/Server-security.md create mode 100644 doc/md/Shaarli-configuration.md create mode 100644 doc/md/Shaarli-images.md create mode 100644 doc/md/Static-analysis.md create mode 100644 doc/md/Theming.md create mode 100644 doc/md/Troubleshooting.md create mode 100644 doc/md/Unit-tests.md create mode 100644 doc/md/Upgrade-and-migration.md create mode 100644 doc/md/Versioning-and-Branches.md create mode 100644 doc/md/_Footer.md create mode 100644 doc/md/_Sidebar.md create mode 100644 doc/md/config.json create mode 100644 doc/md/github-markdown.css create mode 100644 doc/md/images/bookmarklet.png create mode 100644 doc/md/images/doc-logo.png create mode 100644 doc/md/images/doc-logo.svg create mode 100644 doc/md/images/firefoxshare.png create mode 100644 doc/md/images/rss-filter-1.png create mode 100644 doc/md/images/rss-filter-2.png create mode 100644 doc/md/index.md (limited to 'doc/md') diff --git a/doc/md/3rd-party-libraries.md b/doc/md/3rd-party-libraries.md new file mode 100644 index 00000000..ebab7a46 --- /dev/null +++ b/doc/md/3rd-party-libraries.md @@ -0,0 +1,13 @@ +## CSS +- Yahoo UI [CSS Reset](http://yuilibrary.com/yui/docs/cssreset/) + - resets default CSS properties for all HTML elements (overriding browsers' default values) + - ensures custom CSS stylessheets will provide the same results on all browsers + +## Javascript +- [Awesomeplete](https://leaverou.github.io/awesomplete/) ([GitHub](https://github.com/LeaVerou/awesomplete)) - autocompletion in input forms +- [bLazy](http://dinbror.dk/blazy/) ([GitHub](https://github.com/dinbror/blazy)) - lazy loading for thumbnails +- [qr.js](http://neocotic.com/qr.js/) ([GitHub](https://github.com/neocotic/qr.js)) - QR code generation + +## PHP +- [shaarli/netscape-bookmark-parser](https://github.com/shaarli/netscape-bookmark-parser) - Netscape bookmark parser +- [RainTPL](https://github.com/rainphp/raintpl) - HTML templating for PHP diff --git a/doc/md/Backup,-restore,-import-and-export.md b/doc/md/Backup,-restore,-import-and-export.md new file mode 100644 index 00000000..d3252226 --- /dev/null +++ b/doc/md/Backup,-restore,-import-and-export.md @@ -0,0 +1,63 @@ + + * [Backup and restore the datastore file](#backup-and-restore-the-datastore-file) + * [Export links as...](#export-links-as) + * [Import links from...](#import-links-from) + * [Import Shaarli links to Firefox](#import-shaarli-links-to-firefox) + +---------------------- + +## Backup and restore the datastore file + +Backup the file `data/datastore.php` (by FTP or SSH). Restore by putting the file back in place. + +Example command: +```bash +rsync -avzP my.server.com:/var/www/shaarli/data/datastore.php datastore-$(date +%Y-%m-%d_%H%M).php +``` + +## Export links as... + +To export links as an HTML file, under _Tools > Export_, choose: +- _Export all_ to export both public and private links +- _Export public_ to export public links only +- _Export private_ to export private links only + +Restore by using the `Import` feature. +* This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool. + +Example command: +```bash +./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all +``` + +## Import links from... + +### Diigo + +If you export your bookmark from Diigo, make sure you use the Delicious export, not the Netscape export. (Their Netscape export is broken, and they don't seem to be interested in fixing it.) + +### Mister Wong + +See [this issue](https://github.com/sebsauvage/Shaarli/issues/146) for import tweaks. + +### SemanticScuttle + +To correctly import the tags from a [SemanticScuttle](http://semanticscuttle.sourceforge.net/) HTML export, edit the HTML file before importing and replace all occurences of `tags=` (lowercase) to `TAGS=` (uppercase). + +### Scuttle + +Shaarli cannot import data directly from [Scuttle](https://github.com/scronide/scuttle). However, you can use this third party tool: https://github.com/q2apro/scuttle-to-shaarli to export the Scuttle database to the Netscape HTML format compatible with the Shaarli importer. + +## Import Shaarli links to Firefox + + * Export your Shaarli links as described above. + * For compatibility reasons, check `Prepend note permalinks with this Shaarli instance's URL (useful to import bookmarks in a web browser)` + * In Firefox, open the bookmark manager (not the sidebar! `Bookmarks menu > Show all bookmarks` or `Ctrl+Shift+B`) + * Select `Import and Backup > Import bookmarks in HTML format` + +Your bookmarks will be imported in Firefox, ready to use, with tags and descriptions retained. "Self" (notes) shaares will still point to the Shaarli instance you exported them from, but the note text can be viewed directly in the bookmark properties inside your browser. Depending on the number of bookmarks, the import can take some time. + +You may be interested in these Firefox addons to manage links imported from Shaarli + + * [Bookmark Deduplicator](https://addons.mozilla.org/en-US/firefox/addon/bookmark-deduplicator/) - provides an easy way to deduplicate your bookmarks + * [TagSieve](https://addons.mozilla.org/en-US/firefox/addon/tagsieve/) - browse your bookmarks by their tags diff --git a/doc/md/Bookmarklet.md b/doc/md/Bookmarklet.md new file mode 100644 index 00000000..265ced44 --- /dev/null +++ b/doc/md/Bookmarklet.md @@ -0,0 +1,30 @@ +### Add the sharing button (_bookmarklet_) to your browser + + * Open your Shaarli and `Login` + * Click the `Tools` button in the top bar + * Drag the **`✚Shaare link` button**, and drop it to your browser's bookmarks bar. + +_This bookmarklet button is compatible with Firefox, Opera, Chrome and Safari. Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar._ + +![](images/bookmarklet.png) + +### Share links using the _bookmarklet_ + + * When you are visiting a webpage you would like to share with Shaarli, click the _bookmarklet_ you just added. + * A window opens. + * You can freely edit title, description, tags... to find it later using the text search or tag filtering. + * You will be able to edit this link later using the ![](https://raw.githubusercontent.com/shaarli/Shaarli/master/images/edit_icon.png) edit button. + * You can also check the “Private” box so that the link is saved but only visible to you. + * Click `Save`.**Voilà! Your link is now shared.** + +### Troubleshooting: The bookmarklet doesn't work with a few website (e.g. Github.com) + +Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunatly, there is nothing Shaarli can do about it. + +See [#196](https://github.com/shaarli/Shaarli#196). + +There is an open bug for both Firefox and Chromium: + + * https://bugzilla.mozilla.org/show_bug.cgi?id=866522 + * https://code.google.com/p/chromium/issues/detail?id=233903 + diff --git a/doc/md/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md new file mode 100644 index 00000000..ad62c2f0 --- /dev/null +++ b/doc/md/Browsing-and-searching.md @@ -0,0 +1,23 @@ +## Plain text search + +Use the `Search text` field to search in _any_ of the fields of all links (Title, URL, Description...) + +**Exclude text/tags:** Use the `-` operator before a word or tag (example `-uninteresting`) to prevent entries containing (or tagged) `uninteresting` from showing up in the search results. + +**Exact text search:** Use double-quotes (example `"exact search"`) to search for the exact expression. + +Both exclude patterns and exact searches can be combined with normal searches (example `"exact search" term otherterm -notthis "very exact" stuff -notagain`) + +## Tags search + +Use the `Filter by tags` field to restrict displayed links to entries tagged with one or multiple tags (use space to separate tags). + +**Hidden tags:** Tags starting with a dot `.` (example `.secret`) are private. They can only be seen and searched when logged in. + +Alternatively you can use the `Tag cloud` to discover all tags and click on any of them to display related links. + +To search for links that are not tagged, enter `""` in the tag search field. + +## Filtering RSS feeds/Picture wall + +RSS feeds can also be restricted to only return items matching a text/tag search: see [[RSS feeds]]. diff --git a/doc/md/Coding-guidelines.md b/doc/md/Coding-guidelines.md new file mode 100644 index 00000000..da47c498 --- /dev/null +++ b/doc/md/Coding-guidelines.md @@ -0,0 +1,5 @@ +## WIP + +This topic is currently being discussed here: +- [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95) +- [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130) diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md new file mode 100644 index 00000000..6ff7ed45 --- /dev/null +++ b/doc/md/Community-&-Related-software.md @@ -0,0 +1,60 @@ +_Unofficial but related work on Shaarli. If you maintain one of these, please get in touch with us to help us find a way to adapt your work to our fork._ + +_TODO: contact repos owners to see if they'd like to standardize their work with the community fork._ + +## Community +- [Liens en vrac de sebsauvage](http://sebsauvage.net/links/) - the original Shaarli +- [A large list of Shaarlis](http://porneia.free.fr/pub/links/ou-est-shaarli.html) +- [A list of working Shaarli aggregators](https://raw.githubusercontent.com/Oros42/find_shaarlis/master/annuaires.json) +- [A list of some known Shaarlis](https://github.com/Oros42/shaarlis_list) +- [Adieu Delicious, Diigo et StumbleUpon. Salut Shaarli ! - sebsauvage.net](http://sebsauvage.net/rhaa/index.php?2011/09/16/09/29/58-adieu-delicious-diigo-et-stumbleupon-salut-shaarli-) (fr) _16/09/2011 - the original post about Shaarli_ +- [Original ideas/fixme/TODO page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:ideas) +- [Original discussion page](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion) (fr) +- [Original revisions history](http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history) +- [Shaarli.fr/my](https://www.shaarli.fr/my.php) - Unofficial, unsupported (old fork) hosted Shaarlis provider, courtesy of [DMeloni](https://github.com/DMeloni) + +### Articles and social media discussions +- 2016-09-22 - Hacker News - https://news.ycombinator.com/item?id=12552176 +- 2015-08-15 - Reddit - [Question about migrating from WordPress to Shaarli.](https://www.reddit.com/r/selfhosted/comments/3h3zwh/question_about_migrating_from_wordpress_to_shaarli/) +- 2015-06-22 - Hacker News - https://news.ycombinator.com/item?id=9755366 +- 2015-05-12 - Reddit - [shaarli - Self hosted Bookmarking / Delicious (PHP, MySQL)](https://www.reddit.com/r/selfhosted/comments/35pkkc/shaarli_self_hosted_bookmarking_delicious_php/) + +### Third party plugins + + + * [autosave](https://github.com/kalvn/shaarli-plugin-autosave) by [@kalvn](https://github.com/kalvn): Automatically saves data when editing a link to avoid any loss in case of crash or unexpected shutdown. + * [Code Coloration](https://github.com/ArthurHoaro/code-coloration) by [@ArthurHoaro](https://github.com/ArthurHoaro): client side code syntax highlighter. + * [Disqus](https://github.com/kalvn/shaarli-plugin-disqus) by [@kalvn](https://github.com/kalvn): Adds Disqus comment system to your Shaarli. + * [emojione](https://github.com/NerosTie/emojione) by [@NerosTie](https://github.com/NerosTie): Add colorful emojis to your Shaarli. + * [google analytics](https://github.com/ericjuden/Shaarli-Google-Analytics-Plugin) by [@ericjuden](http://github.com/ericjuden): Adds Google Analytics tracking support + * [launch](https://github.com/ArthurHoaro/launch-plugin) - Launch Plugin is a plugin designed to enhance and customize Launch Theme for Shaarli. + * [related](https://github.com/ilesinge/shaarli-related) by [@ilesinge](https://github.com/ilesinge) - Show related links based on the number of identical tags. + * [social](https://github.com/alexisju/social) by [@alexisju](https://github.com/alexisju): share links to social networks. + * [shaarli2twitter](https://github.com/ArthurHoaro/shaarli2twitter) by [@ArthurHoaro](https://github.com/ArthurHoaro) - Automatically tweet your shared links from Shaarli + + +### Themes +See [[Theming]] for the list of community-contributed themes, and an installation guide. + +### Server apps +- [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content +- [shaarli-river](https://github.com/mknexen/shaarli-river) - An aggregator for shaarlis with many features +- [Shaarlo](https://github.com/DMeloni/shaarlo) - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: [shaarli.fr](http://shaarli.fr/)) +- [Shaarlimages](https://github.com/BoboTiG/shaarlimages) - An image-oriented aggregator for Shaarlis +- [mknexen/shaarli-api](https://github.com/mknexen/shaarli-api) - A REST API for Shaarli +- [Self dead link](https://github.com/qwertygc/shaarli-dev-code/blob/master/self-dead-link.php) - Detect dead links on shaarli. This version use the database of shaarli. [Another version](https://github.com/qwertygc/shaarli-dev-code/blob/master/dead-link.php), can be used for other shaarli instances (but is more resource consuming). +- [Bookmark Archiver](https://github.com/pirate/bookmark-archiver) - Save an archived copy of all websites starred using browser bookmarks/Shaarli/Delicious/Instapaper/Unmark.it/Pocket/Pinboard. Outputs browseable html. + +### Mobile Apps +- [ShaarliOS](https://github.com/mro/ShaarliOS) iOS share extension - see [#308](https://github.com/shaarli/Shaarli/issues/308#issuecomment-184592070) for some promo codes, +- [Shaarli for Android](http://sebsauvage.net/links/?ZAyDzg) - Android application that adds Shaarli as a sharing provider +- [Shaarlier for Android](https://github.com/dimtion/Shaarlier) - Android application to simply add links directly into your Shaarli + +## Integration with other platforms +- [tt-rss-shaarli](https://github.com/jcsaaddupuy/tt-rss-shaarli) - [Tiny-Tiny RSS](http://tt-rss.org/) plugin that adds support for sharing articles with Shaarli +- [octopress-shaarli](https://github.com/ahmet2mir/octopress-shaarli) - Octopress plugin to retrieve Shaarli links on the sidebar +- [Scuttle to Shaarli](https://github.com/q2apro/scuttle-to-shaarli) - Import bookmarks from Scuttle + +## Alternatives to Shaarli + +See the [bookmarks & link sharing](https://github.com/Kickball/awesome-selfhosted/#bookmarks--link-sharing) section on [awesome-selfhosted](https://github.com/Kickball/awesome-selfhosted/). diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md new file mode 100644 index 00000000..30dc474d --- /dev/null +++ b/doc/md/Continuous-integration-tools.md @@ -0,0 +1,24 @@ +## Local development +A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: +- Documentation - generate a local HTML copy of the GitHub wiki +- [[Static analysis]] - check that the code is compliant to PHP conventions +- [[Unit tests]] - ensure there are no regressions introduced by new commits + +## Automatic builds +[Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: +- each time a commit is merged to the mainline (`master` branch) +- each time a Pull Request is submitted or updated + +A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). + +Each build job: +- updates Composer +- installs 3rd-party test dependencies with Composer +- runs [[Unit tests]] + +After all jobs have finished, Travis returns the results to GitHub: +- a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) +- Pull Requests are updated with the Travis result + - Green: all tests have passed + - Red: some tests failed + - Orange: tests are pending diff --git a/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md b/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md new file mode 100644 index 00000000..7583c9ea --- /dev/null +++ b/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md @@ -0,0 +1,66 @@ +Example bash script: + +```bash +#!/bin/bash +#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli +#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally. +#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli +#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed +#Usage: ./local-shaarli.sh +#Author: nodiscc (nodiscc@gmail.com) +#License: MIT (http://opensource.org/licenses/MIT) +set -o errexit +set -o nounset + +##### CONFIG ################# +#The port used by php's local server +php_local_port=7431 + +#Name of the SSH server and path where Shaarli is installed +#TODO: pass these as command-line arguments +remotehost="my.ssh.server" +remote_shaarli_dir="/var/www/shaarli" + + +###### FUNCTIONS ############# +_main() { + _CBSyncShaarli + _CBServeShaarli +} + +_CBSyncShaarli() { + remote_temp_dir=$(ssh $remotehost mktemp -d) + remote_ssh_user=$(ssh $remotehost whoami) + ssh -t "$remotehost" sudo cp -r "$remote_shaarli_dir" "$remote_temp_dir" + ssh -t "$remotehost" sudo chown -R "$remote_ssh_user":"$remote_ssh_user" "$remote_temp_dir" + scp -rq "$remotehost":"$remote_temp_dir" local-shaarli + ssh "$remotehost" rm -r "$remote_temp_dir" +} + +_CBServeShaarli() { + #TODO: allow serving a previously downloaded Shaarli + #TODO: ask before overwriting local copy, if it exists + cd local-shaarli/ + php -S localhost:${php_local_port} + echo "Please go to http://localhost:${php_local_port}" +} + + +##### MAIN ################# + +_main +``` + +This outputs: + +```bash +$ ./local-shaarli.sh +PHP 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014 +Listening on http://localhost:7431 +Document root is /home/user/local-shaarli/shaarli +Press Ctrl-C to quit. + +[Mon Sep 1 21:56:27 2014] ::1:57868 [200]: / +[Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html +[Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /... +``` diff --git a/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md b/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md new file mode 100644 index 00000000..d0d812a3 --- /dev/null +++ b/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md @@ -0,0 +1,57 @@ +Example bash script (creates multiple shaarli instances and generates an HTML index of them) + +```bash +#!/bin/bash +set -o errexit +set -o nounset + +#config +shaarli_base_dir='/var/www/shaarli' +accounts='bob john whatever username' +shaarli_repo_url='https://github.com/shaarli/Shaarli' +ref="master" + +#clone multiple shaarli instances +if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi + +for account in $accounts; do + if [ -d "$shaarli_base_dir/$account" ]; + then echo "[info] account $account already exists, skipping"; + else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi +done + +#generate html index of shaarlis +htmlhead=' + + + + + My Shaarli farm + + + +
+

My Shaarli farm

+ +
+ +' + + + +for account in $accounts; do accountlinks="$accountlinks\n
  • $account
    • "; done +if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi +echo "[info] generating new index of shaarlis" +echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html" +echo '[info] done.' +echo "[info] list of accounts: $accounts" +echo "[info] contents of $shaarli_base_dir:" +tree -a -L 1 "$shaarli_base_dir" +``` + +This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like [Ansible](https://www.ansible.com/) \ No newline at end of file diff --git a/doc/md/Datastore-hacks.md b/doc/md/Datastore-hacks.md new file mode 100644 index 00000000..78baa005 --- /dev/null +++ b/doc/md/Datastore-hacks.md @@ -0,0 +1,25 @@ +### Decode datastore content + +To display the array representing the data saved in `data/datastore.php`, use the following snippet: + +```php +$data = "tZNdb9MwFIb... "; +$out = unserialize(gzinflate(base64_decode($data))); +echo "
    "; // Pretty printing is love, pretty printing is life
+print_r($out);
+echo "
    "; +exit; +``` +This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). + +Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed): +``` +php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . +``` + +### Changing the timestamp for a link + +* Look for `` in `tpl/editlink.tpl` (line 14) +* Replace `type="hidden"` with `type="text"` from this line +* A new date/time field becomes available in the edit/new link dialog. +* You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. diff --git a/doc/md/Development-guidelines.md b/doc/md/Development-guidelines.md new file mode 100644 index 00000000..1480ec89 --- /dev/null +++ b/doc/md/Development-guidelines.md @@ -0,0 +1,9 @@ +## Development guidelines + +Please have a look at the following pages: +- [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md) +- [[Static analysis]] - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: + - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard + - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide +- [[Unit tests]] +- [[GnuPG signature]] for tags/releases diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md new file mode 100644 index 00000000..eb50965b --- /dev/null +++ b/doc/md/Directory-structure.md @@ -0,0 +1,34 @@ +TODO: This page is out of date + +Here is the directory structure of Shaarli and the purpose of the different files: + +```bash + index.php # Main program + application/ # Shaarli classes + ├── LinkDB.php + └── Utils.php + tests/ # Shaarli unitary & functional tests + ├── LinkDBTest.php + ├── utils # utilities to ease testing + │ └── ReferenceLinkDB.php + └── UtilsTest.php + COPYING # Shaarli license + inc/ # static assets and 3rd party libraries + ├── awesomplete.* # tags autocompletion library + ├── blazy.* # picture wall lazy image loading library + ├── shaarli.css, reset.css # Shaarli stylesheet. + ├── qr.* # qr code generation library + └──rain.tpl.class.php # RainTPL templating library + tpl/ # RainTPL templates for Shaarli. They are used to build the pages. + images/ # Images and icons used in Shaarli + data/ # data storage: bookmark database, configuration, logs, banlist… + ├── config.php # Shaarli configuration (login, password, timezone, title…) + ├── datastore.php # Your link database (compressed). + ├── ipban.php # IP address ban system data + ├── lastupdatecheck.txt # Update check timestamp file + └──log.txt # login/IPban log. + cache/ # thumbnails cache + # This directory is automatically created. You can erase it anytime you want. + tmp/ # Temporary directory for compiled RainTPL templates. + # This directory is automatically created. You can erase it anytime you want. +``` diff --git a/doc/md/Docker-101.md b/doc/md/Docker-101.md new file mode 100644 index 00000000..b02dd149 --- /dev/null +++ b/doc/md/Docker-101.md @@ -0,0 +1,62 @@ +## Basics +Install [Docker](https://www.docker.com/), by following the instructions relevant +to your OS / distribution, and start the service. + +### Search an image on [DockerHub](https://hub.docker.com/) + +```bash +$ docker search debian + +NAME DESCRIPTION STARS OFFICIAL AUTOMATED +ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK] +debian Debian is a Linux distribution that's comp... 603 [OK] +google/debian 47 [OK] +``` + +### Show available tags for a repository +```bash +$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool + +% Total % Received % Xferd Average Speed Time Time Time Current +Dload Upload Total Spent Left Speed +100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433 +``` + +Sample output: +```json +[ + { + "layer": "85a02782", + "name": "stretch" + }, + { + "layer": "59abecbc", + "name": "testing" + }, + { + "layer": "bf0fd686", + "name": "unstable" + }, + { + "layer": "60c52dbe", + "name": "wheezy" + }, + { + "layer": "c5b806fe", + "name": "wheezy-backports" + } +] + +``` + +### Pull an image from DockerHub +```bash +$ docker pull repository[:tag] + +$ docker pull debian:wheezy +wheezy: Pulling from debian +4c8cbfd2973e: Pull complete +60c52dbe9d91: Pull complete +Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe +Status: Downloaded newer image for debian:wheezy +``` diff --git a/doc/md/Docker-resources.md b/doc/md/Docker-resources.md new file mode 100644 index 00000000..082d4a46 --- /dev/null +++ b/doc/md/Docker-resources.md @@ -0,0 +1,19 @@ +### Docker + +- [Interactive Docker training portal](https://www.katacoda.com/courses/docker/) on [Katakoda](https://www.katacoda.com/) +- [Where are Docker images stored?](http://blog.thoward37.me/articles/where-are-docker-images-stored/) +- [Dockerfile reference](https://docs.docker.com/reference/builder/) +- [Dockerfile best practices](https://docs.docker.com/articles/dockerfile_best-practices/) +- [Volumes](https://docs.docker.com/userguide/dockervolumes/) + +### DockerHub + +- [Repositories](https://docs.docker.com/userguide/dockerrepos/) +- [Teams and organizations](https://docs.docker.com/docker-hub/orgs/) +- [GitHub automated build](https://docs.docker.com/docker-hub/github/) + +### Service management + +- [Using supervisord](https://docs.docker.com/articles/using_supervisord/) +- [Nginx in the foreground](http://nginx.org/en/docs/ngx_core_module.html#daemon) +- [supervisord](http://supervisord.org/) diff --git a/doc/md/Download-CSS-styles-from-an-OPML-list.md b/doc/md/Download-CSS-styles-from-an-OPML-list.md new file mode 100644 index 00000000..26b7fb3e --- /dev/null +++ b/doc/md/Download-CSS-styles-from-an-OPML-list.md @@ -0,0 +1,154 @@ +###Download CSS styles for shaarlis listed in an opml file +Example php script: + +```php + + + + +/** + * Source: https://github.com/Riduidel + * Download css styles for shaarlis listed in an opml file + */ +define("SHAARLI_RSS_OPML", "https://www.ecirtam.net/shaarlirss/custom/people.opml"); + +define("THEMES_TEMP_FOLDER", "new_themes"); + +if(!file_exists(THEMES_TEMP_FOLDER)) { + mkdir(THEMES_TEMP_FOLDER); +} + +function siteUrl($pathInSite) { + $indexPos = strpos($pathInSite, "index.php"); + if(!$indexPos) { + return $pathInSite; + } else { + return substr($pathInSite, 0, $indexPos); + } +} + +function createShaarliHashFromOPMLL($opmlFile) { + $result = array(); + $opml = file_get_contents($opmlFile); + $opmlXml = simplexml_load_string($opml); + $outlineElements = $opmlXml->xpath("body/outline"); + foreach($outlineElements as $site) { + $siteUrl = siteUrl((string) $site['htmlUrl']); + $result[$siteUrl]=((string) $site['text']); + } + return $result; +} + +function getSiteFolder($url) { + $domain = parse_url($url, PHP_URL_HOST); + return THEMES_TEMP_FOLDER."/".str_replace(".", "_", $domain); +} + +function get_http_response_code($theURL) { + $headers = get_headers($theURL); + return substr($headers[0], 9, 3); +} + +/** + * This makes the code PHP-5 only (particularly the call to "get_headers") + */ +function copyUserStyleFrom($url, $name, $knownStyles) { + $userStyle = $url."inc/user.css"; + if(in_array($url, $knownStyles)) { + // TODO add log message + } else { + $statusCode = get_http_response_code($userStyle); + if(intval($statusCode)<300) { + $styleSheet = file_get_contents($userStyle); + $siteFolder = getSiteFolder($url); + if(!file_exists($siteFolder)) { + mkdir($siteFolder); + } + if(!file_exists($siteFolder.'/user.css')) { + // Copy stylesheet + file_put_contents($siteFolder.'/user.css', $styleSheet); + } + if(!file_exists($siteFolder.'/README.md')) { + // Then write a readme.md file + file_put_contents($siteFolder.'/README.md', + "User style from ".$name."\n" + ."=============================" + ."\n\n" + ."This stylesheet was downloaded from ".$userStyle." on ".date(DATE_RFC822) + ); + } + if(!file_exists($siteFolder.'/config.ini')) { + // Write a config file containing useful informations + file_put_contents($siteFolder.'/config.ini', + "site_url=".$url."\n" + ."site_name=".$name."\n" + ); + } + if(!file_exists($siteFolder.'/home.png')) { + // And finally copy generated thumbnail + $homeThumb = $siteFolder.'/home.png'; + file_put_contents($siteFolder.'/home.png', file_get_contents(getThumbnailUrl($url))); + } + echo 'Theme have been downloaded from '.$url.' into '.$siteFolder + .'. It looks like
    '; + } + } +} + +function getThumbnailUrl($url) { + return 'http://api.webthumbnail.org/?url='.$url; +} + +function copyUserStylesFrom($urlToNames, $knownStyles) { + foreach($urlToNames as $url => $name) { + copyUserStyleFrom($url, $name, $knownStyles); + } +} + +/** + * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/ + * @param directory the directory we want to list files of + * @return a simple array containing the list of absolute file paths. Notice that current file (".") and parent one("..") + * are not listed here + */ +function getDirectoryList ($directory) { + $realPath = realpath($directory); + // create an array to hold directory list + $results = array(); + // create a handler for the directory + $handler = opendir($directory); + // open directory and walk through the filenames + while ($file = readdir($handler)) { + // if file isn't this directory or its parent, add it to the results + if ($file != "." && $file != "..") { + $results[] = realpath($realPath . "/" . $file); + } + } + // tidy up: close the handler + closedir($handler); + // done! + return $results; +} + +/** + * Start in themes folder and look in all subfolders for config.ini files. + * These config.ini files allow us not to download styles again and again + */ +function findKnownStyles() { + $result = array(); + $subFolders = getDirectoryList("themes"); + foreach($subFolders as $folder) { + $configFile = $folder."/config.ini"; + if(file_exists($configFile)) { + $iniParameters = parse_ini_file($configFile); + array_push($result, $iniParameters['site_url']); + } + } + return $result; +} + +$knownStyles = findKnownStyles(); +copyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles); + + +``` \ No newline at end of file diff --git a/doc/md/Download-and-Installation.md b/doc/md/Download-and-Installation.md new file mode 100644 index 00000000..7880aef4 --- /dev/null +++ b/doc/md/Download-and-Installation.md @@ -0,0 +1,99 @@ +To install Shaarli, simply place the files in a directory under your webserver's Document Root (or directly at the document root). Make sure your [server](Server-requirements) is properly [configured](Server-configuration). + +Several releases are available: + +-------------------------------------------------------- + +## Latest release (recommended) +### Download as an archive +Get the latest released version from the [releases](https://github.com/shaarli/Shaarli/releases) page. + +**Download our *shaarli-full* archive** to include dependencies. + +The current latest released version is `v0.8.4` + +Or in command lines: + +```bash +$ wget https://github.com/shaarli/Shaarli/releases/download/v0.8.4/shaarli-v0.8.4-full.zip +$ unzip shaarli-v0.8.4-full.zip +$ mv Shaarli /path/to/shaarli/ +``` + +| ! |In most cases, download Shaarli from the [releases](https://github.com/shaarli/Shaarli/releases) page. Cloning using `git` or downloading Github branches as zip files requires additional steps (see below).| +|-----|--------------------------| + +### Using git + +``` +mkdir -p /path/to/shaarli && cd /path/to/shaarli/ +git clone -b v0.8 https://github.com/shaarli/Shaarli.git . +composer install --no-dev +``` + +-------------------------------------------------------- + +## Stable version + +The stable version has been experienced by Shaarli users, and will receive security updates. + +### Download as an archive + +As a .zip archive: + +```bash +$ wget https://github.com/shaarli/Shaarli/archive/stable.zip +$ unzip stable.zip +$ mv Shaarli-stable /path/to/shaarli/ +``` + +As a .tar.gz archive : + +```bash +$ wget https://github.com/shaarli/Shaarli/archive/stable.tar.gz +$ tar xvf stable.tar.gz +$ mv Shaarli-stable /path/to/shaarli/ +``` + +### Clone with Git + +[Composer](https://getcomposer.org/) is required to build a functional Shaarli installation when pulling from git. + +```bash +$ git clone https://github.com/shaarli/Shaarli.git -b stable /path/to/shaarli/ +# install/update third-party dependencies +$ cd /path/to/shaarli/ +$ composer install --no-dev +``` + +-------------------------------------------------------- + +## Development version (mainline) + +_Use at your own risk!_ + +To get the latest changes from the `master` branch: + +```bash +# clone the repository +$ git clone https://github.com/shaarli/Shaarli.git -b master /path/to/shaarli/ +# install/update third-party dependencies +$ cd /path/to/shaarli +$ composer install --no-dev +``` + +-------------------------------------------------------- + +## Finish Installation + +Once Shaarli is downloaded and files have been placed at the correct location, open it this location your favorite browser. + +![install screenshot](http://i.imgur.com/wuMpDSN.png) + +Setup your Shaarli installation, and it's ready to use! + +-------------------------------------------------------- + +## Updating Shaarli + +See [Upgrade and Migration](Upgrade-and-migration) diff --git a/doc/md/Example-patch---add-new-via-field-for-links.md b/doc/md/Example-patch---add-new-via-field-for-links.md new file mode 100644 index 00000000..d84ef25a --- /dev/null +++ b/doc/md/Example-patch---add-new-via-field-for-links.md @@ -0,0 +1,189 @@ +Example patch to add a new field ("via") for links, an input field to set the "via" property from the "edit link" dialog, and display the "via" field in the link list display. **Untested, use at your own risk** + +Thanks to @Knah-Tsaeb in https://github.com/sebsauvage/Shaarli/pull/158 + +``` +From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001 +From: Knah Tsaeb +Date: Fri, 11 Oct 2013 15:18:37 +0200 +Subject: [PATCH] Add a "via"/origin property for links, add new input in "edit link" dialog +Thanks to: +* https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4 +* https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813 +* https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96 + +--- + index.php | 43 ++++++++++++++++++++++++++++++++----------- + tpl/editlink.html | 1 + + tpl/linklist.html | 1 + + 3 files changed, 34 insertions(+), 11 deletions(-) + +diff --git a/index.php b/index.php +index 6fae2f8..53f798e 100644 +--- a/index.php ++++ b/index.php +@@ -436,6 +436,12 @@ if (isset($_POST['login'])) + // ------------------------------------------------------------------------------------------ + // Misc utility functions: + ++// Try to get just domain for @via ++function getJustDomain($url){ ++ $parts = parse_url($url); ++ return trim($parts['host']); ++ } ++ + // Returns the server URL (including port and http/https), without path. + // e.g. "http://myserver.com:8080" + // You can append $_SERVER['SCRIPT_NAME'] to get the current script URL. +@@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess + $found= (strpos(strtolower($l['title']),$s)!==false) + || (strpos(strtolower($l['description']),$s)!==false) + || (strpos(strtolower($l['url']),$s)!==false) +- || (strpos(strtolower($l['tags']),$s)!==false); ++ || (strpos(strtolower($l['tags']),$s)!==false) ++ || (!empty($l['via']) && (strpos(strtolower($l['via']),$s)!==false)); + if ($found) $filtered[$l['linkdate']] = $l; + } + krsort($filtered); +@@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess + $t = str_replace(',',' ',($casesensitive?$tags:strtolower($tags))); + $searchtags=explode(' ',$t); + $filtered=array(); +- foreach($this->links as $l) ++ foreach($this-> links as $l) + { + $linktags = explode(' ',($casesensitive?$l['tags']:strtolower($l['tags']))); + if (count(array_intersect($linktags,$searchtags)) == count($searchtags)) +@@ -905,7 +912,7 @@ function showRSS() + else $linksToDisplay = $LINKSDB; + $nblinksToDisplay = 50; // Number of links to display. + if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links. +- { ++ { + $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ; + } + +@@ -944,7 +951,12 @@ function showRSS() + // If user wants permalinks first, put the final link in description + if ($usepermalinks===true) $descriptionlink = '(Link)'; + if (strlen($link['description'])>0) $descriptionlink = '
    '.$descriptionlink; +- echo ''."\n\n"; ++ if(!empty($link['via'])){ ++ $via = '
    Origine => '.htmlspecialchars(getJustDomain($link['via'])).''; ++ } else { ++ $via = ''; ++ } ++ echo ''."\n\n"; + $i++; + } + echo ''; +@@ -980,7 +992,7 @@ function showATOM() + else $linksToDisplay = $LINKSDB; + $nblinksToDisplay = 50; // Number of links to display. + if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links. +- { ++ { + $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ; + } + +@@ -1006,11 +1018,16 @@ function showATOM() + + // Add permalink in description + $descriptionlink = htmlspecialchars('(Permalink)'); ++ if(isset($link['via']) && !empty($link['via'])){ ++ $via = htmlspecialchars('
    Origine => '.getJustDomain($link['via']).''); ++ } else { ++ $via = ''; ++ } + // If user wants permalinks first, put the final link in description + if ($usepermalinks===true) $descriptionlink = htmlspecialchars('(Link)'); + if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink; + +- $entries.=''.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink."\n"; ++ $entries.=''.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink.$via."\n"; + if ($link['tags']!='') // Adding tags to each ATOM entry (as mentioned in ATOM specification) + { + foreach(explode(' ',$link['tags']) as $tag) +@@ -1478,7 +1495,7 @@ function renderPage() + if (!startsWith($url,'http:') && !startsWith($url,'https:') && !startsWith($url,'ftp:') && !startsWith($url,'magnet:') && !startsWith($url,'?')) + $url = 'http://'.$url; + $link = array('title'=>trim($_POST['lf_title']),'url'=>$url,'description'=>trim($_POST['lf_description']),'private'=>(isset($_POST['lf_private']) ? 1 : 0), +- 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags)); ++ 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags), 'via'=>trim($_POST['lf_via'])); + if ($link['title']=='') $link['title']=$link['url']; // If title is empty, use the URL as title. + $LINKSDB[$linkdate] = $link; + $LINKSDB->savedb(); // Save to disk. +@@ -1556,7 +1573,8 @@ function renderPage() + $title = (empty($_GET['title']) ? '' : $_GET['title'] ); // Get title if it was provided in URL (by the bookmarklet). + $description = (empty($_GET['description']) ? '' : $_GET['description']); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that] + $tags = (empty($_GET['tags']) ? '' : $_GET['tags'] ); // Get tags if it was provided in URL +- $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL ++ $via = (empty($_GET['via']) ? '' : $_GET['via'] ); ++ $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL + if (($url!='') && parse_url($url,PHP_URL_SCHEME)=='') $url = 'http://'.$url; + // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.) + if (empty($title) && parse_url($url,PHP_URL_SCHEME)=='http') +@@ -1567,7 +1585,7 @@ function renderPage() + { + // Look for charset in html header. + preg_match('##Usi', $data, $meta); +- ++ + // If found, extract encoding. + if (!empty($meta[0])) + { +@@ -1577,7 +1595,7 @@ function renderPage() + $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : 'utf-8'; + } + else { $html_charset = 'utf-8'; } +- ++ + // Extract title + $title = html_extract_title($data); + if (!empty($title)) +@@ -1592,7 +1610,7 @@ function renderPage() + $url='?'.smallHash($linkdate); + $title='Note: '; + } +- $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'private'=>$private); ++ $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'via' => $via,'private'=>$private); + } + + $PAGE = new pageBuilder; +@@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB) + $taglist = explode(' ',$link['tags']); + uasort($taglist, 'strcasecmp'); + $link['taglist']=$taglist; ++ if(!empty($link['via'])){ ++ $link['via']=htmlspecialchars($link['via']); ++ } + $linkDisp[$keys[$i]] = $link; + $i++; + } +diff --git a/tpl/editlink.html b/tpl/editlink.html +index 4a2c30c..14d4f9c 100644 +--- a/tpl/editlink.html ++++ b/tpl/editlink.html +@@ -16,6 +16,7 @@ + Title

    + Description

    + Tags

    ++ Origine

    + {if condition="($link_is_new && $GLOBALS['privateLinkByDefault']==true) || $link.private == true"} + +  
    +diff --git a/tpl/linklist.html b/tpl/linklist.html +index ddc38cb..0a8475f 100644 +--- a/tpl/linklist.html ++++ b/tpl/linklist.html +@@ -43,6 +43,7 @@ + {$value.title|htmlspecialchars} +
    + {if="$value.description"}
    {$value.description}
    {/if} ++ {if condition="isset($value.via) && !empty($value.via)"}
    Origine => {$value.via|getJustDomain}
    {/if} + {if="!$GLOBALS['config']['HIDE_TIMESTAMPS'] || isLoggedIn()"} + {$value.localdate|htmlspecialchars} - permalink - + {else} +-- +2.1.1 +``` \ No newline at end of file diff --git a/doc/md/FAQ.md b/doc/md/FAQ.md new file mode 100644 index 00000000..151dcef5 --- /dev/null +++ b/doc/md/FAQ.md @@ -0,0 +1,43 @@ +### Why did you create Shaarli ? + +I was a StumbleUpon user. Then I got fed up with they big toolbar. I switched to delicious, which was lighter, faster and more beautiful. Until Yahoo bought it. Then the export API broke all the time, delicious became slow and was ditched by Yahoo. I switched to Diigo, which is not bad, but does too much. And Diigo is sslllooooowww and their Firefox extension a bit buggy. And… oh… **their Firefox addon sends to Diigo every single URL you visit** (Don't believe me ? Use [Tamper Data](https://addons.mozilla.org/en-US/firefox/addon/tamper-data/) and open any page). + +Enough is enough. Saving simple links should not be a complicated heavy thing. I ditched them all and wrote my own: Shaarli. It's simple, but it does the job and does it well. And my data is not hosted on a foreign server, but on my server. + +### Why use Shaarli and not Delicious/Diigo ? + +With Shaarli: + +* The data is yours: It's hosted on your server. +* Never fear of having your data locked-in. +* Never fear to have your data sold to third party. +* Your private links are not hosted on a third party server. +* You are not tracked by browser addons (like Diigo does) +* You can change the look and feel of the pages if you want. +* You can change the behaviour of the program. +* It's magnitude faster than most bookmarking services. + +### What does Shaarli mean? + +Shaarli is for shaaring your links. + +### My Shaarli is broken! +First of all, ensure that both the [web server](Server-configuration) and [Shaarli](Shaarli-configuration) are correctly configured, and that your installation is [supported](Server-requirements). + +If everything looks right but the issue(s) remain(s), please: +- take a look at the [troubleshooting](Troubleshooting) section +- come [chat with us](https://gitter.im/shaarli/Shaarli) on Gitter, we'll be happy to help ;-) +- browse active [issues](https://github.com/shaarli/Shaarli/issues) and [Pull Requests](https://github.com/shaarli/Shaarli/pulls) + - if you find one that is related to the issue, feel free to comment and provide additional details (host/Shaarli setup) + - else, [open a new issue](https://github.com/shaarli/Shaarli/issues/new), and provide information about the problem: + - _what happens?_ - display glitches, invalid data, security flaws... + - _what is your configuration?_ - OS, server version, activated extensions, web browser... + - _is it reproducible?_ + +### Why not use a real database? Files are slow! + +Does browsing [this page](http://sebsauvage.net/links/) feel slow? Try browsing older pages, too. + +It's not slow at all, is it? And don't forget the database contains more than 16000 links, and it's on a shared host, with 32000 visitors/day for my website alone. And it's still damn fast. Why? + +The data file is only 3.7 Mb. It's read 99% of the time, and is probably already in the operation system disk cache. So generating a page involves no I/O at all most of the time. diff --git a/doc/md/Features.md b/doc/md/Features.md new file mode 100644 index 00000000..116b1c9c --- /dev/null +++ b/doc/md/Features.md @@ -0,0 +1,24 @@ +### Main features +Shaarli is intended: + * to share, comment and save interesting links and news + * to bookmark useful/frequent personal links (as private links) and share them between computers + * as a minimal blog/microblog/writing platform (no character limit) + * as a read-it-later list (for example items tagged `readlater`) + * to draft and save articles/ideas + * to keep code snippets + * to keep notes and documentation + * as a shared clipboard between machines + * as a todo list + * to store playlists (e.g. with the `music` or `video` tags) + * to keep extracts/comments from webpages that may disappear + * to keep track of ongoing discussions (for example items tagged `discussion`) + * [to feed RSS aggregators](http://shaarli.chassegnouf.net/?9Efeiw) (planets) with specific tags + * to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...) + +### Using Shaarli as a blog, notepad, pastebin... + + * Go to your Shaarli setup and log in + * Click the `Add Link` button + * To share text only, do not enter any URL in the corresponding input field and click `Add Link` + * Pick a title and enter your article, or note, in the description field; add a few tags; optionally check `Private` then click `Save` + * Voilà! Your article is now published (privately if you selected that option) and accessible using its permalink. diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md new file mode 100644 index 00000000..9ba57b04 --- /dev/null +++ b/doc/md/Firefox-share.md @@ -0,0 +1,15 @@ +### Add Shaarli as a sharing service to Firefox + + * Open your Shaarli and `Login` + * Click the `Tools` button in the top bar + * Click the `✚Add to Firefox social` button and accept the activation. + + +### Sharing links using Firefox share + + * Add the sharing service as described above + * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] + * You can edit your link before and after saving, just like the bookmarklet above. + +|  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | +|------|-------------------------------------------------------------------------------| diff --git a/doc/md/GnuPG-signature.md b/doc/md/GnuPG-signature.md new file mode 100644 index 00000000..1fb3b42f --- /dev/null +++ b/doc/md/GnuPG-signature.md @@ -0,0 +1,76 @@ +## Introduction +### PGP and GPG +[Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the [Pretty Good +Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP) (OpenPGP) specification. Its main purposes are digital authentication, +signature and encryption. + +It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify: +- Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master +Keys](https://www.archlinux.org/master-keys/) +- [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity + +### Trust +To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/): + +> You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated. + +Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during [key signing parties](https://en.wikipedia.org/wiki/Key_signing_party), see: +- [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html) +- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust) + +## Generate a GPG key +- [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow) +- [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub) + +### gpg - provide identity information +```bash +$ gpg --gen-key + +gpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc. +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +Note: Use "gpg2 --full-gen-key" for a full featured key generation dialog. + +GnuPG needs to construct a user ID to identify your key. + +Real name: Marvin the Paranoid Android +Email address: marvin@h2g2.net +You selected this USER-ID: + "Marvin the Paranoid Android " + +Change (N)ame, (E)mail, or (O)kay/(Q)uit? o +We need to generate a lot of random bytes. It is a good idea to perform +some other action (type on the keyboard, move the mouse, utilize the +disks) during the prime generation; this gives the random number +generator a better chance to gain enough entropy. +``` + +### gpg - entropy interlude +At this point, you will: +- be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration) +- be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step _may take some time_ + +### gpg - key creation confirmation +```bash +gpg: key A9D53A3E marked as ultimately trusted +public and secret key created and signed. + +gpg: checking the trustdb +gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model +gpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u +pub rsa2048/A9D53A3E 2015-07-31 + Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E +uid [ultimate] Marvin the Paranoid Android +sub rsa2048/8C0EACF1 2015-07-31 +``` + +### gpg - submit your public key to a PGP server (Optional) +``` bash +$ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E +gpg: sending key A9D53A3E to hkp server pgp.mit.edu +``` + +## Create and push a GPG-signed tag + +See [[Release Shaarli]]. diff --git a/doc/md/Plugin-System.md b/doc/md/Plugin-System.md new file mode 100644 index 00000000..d55ffe7e --- /dev/null +++ b/doc/md/Plugin-System.md @@ -0,0 +1,710 @@ +[**I am a developer.** Developer API.](#developer-api) + +[**I am a template designer.** Guide for template designer.](#guide-for-template-designer) + +## Developer API + +### What can I do with plugins? + +The plugin system let you: + + * insert content into specific places across templates. + * alter data before templates rendering. + * alter data before saving new links. + +### How can I create a plugin for Shaarli? + +First, chose a plugin name, such as `demo_plugin`. + +Under `plugin` folder, create a folder named with your plugin name. Then create a .php file in that folder. + +You should have the following tree view: + +``` +| index.php +| plugins/ +|---| demo_plugin/ +| |---| demo_plugin.php +``` + +### Plugin initialization + +At the beginning of Shaarli execution, all enabled plugins are loaded. At this point, the plugin system looks for an `init()` function to execute and run it if it exists. This function must be named this way, and takes the `ConfigManager` as parameter. + + _init($conf) + +This function can be used to create initial data, load default settings, etc. But also to set *plugin errors*. If the initialization function returns an array of strings, they will be understand as errors, and displayed in the header to logged in users. + +### Understanding hooks + +A plugin is a set of functions. Each function will be triggered by the plugin system at certain point in Shaarli execution. + +These functions need to be named with this pattern: + +``` +hook__($data, $conf) +``` + +Parameters: + + - data: see [$data section](https://github.com/shaarli/Shaarli/wiki/Plugin-System#plugins-data) + - conf: the `ConfigManager` instance. + +For exemple, if my plugin want to add data to the header, this function is needed: + + hook_demo_plugin_render_header + +If this function is declared, and the plugin enabled, it will be called every time Shaarli is rendering the header. + +### Plugin's data + +#### Parameters + +Every hook function has a `$data` parameter. Its content differs for each hooks. + +**This parameter needs to be returned every time**, otherwise data is lost. + + return $data; + +#### Filling templates placeholder + +Template placeholders are displayed in template in specific places. + +RainTPL displays every element contained in the placeholder's array. These element can be added by plugins. + +For example, let's add a value in the placeholder `top_placeholder` which is displayed at the top of my page: + +```php +$data['top_placeholder'][] = 'My content'; +# OR +array_push($data['top_placeholder'], 'My', 'content'); + +return $data; +``` + +#### Data manipulation + +When a page is displayed, every variable send to the template engine is passed to plugins before that in `$data`. + +The data contained by this array can be altered before template rendering. + +For exemple, in linklist, it is possible to alter every title: + +```php +// mind the reference if you want $data to be altered +foreach ($data['links'] as &$value) { + // String reverse every title. + $value['title'] = strrev($value['title']); +} + +return $data; +``` + +### Metadata + +Every plugin needs a `.meta` file, which is in fact an `.ini` file (`KEY="VALUE"`), to be listed in plugin administration. + +Each file contain two keys: + + * `description`: plugin description + * `parameters`: user parameter names, separated by a `;`. + * `parameter.`: add a text description the specified parameter. + +> Note: In PHP, `parse_ini_file()` seems to want strings to be between by quotes `"` in the ini file. + +### It's not working! + +Use `demo_plugin` as a functional example. It covers most of the plugin system features. + +If it's still not working, please [open an issue](https://github.com/shaarli/Shaarli/issues/new). + +### Hooks + +| Hooks | Description | +| ------------- |:-------------:| +| [render_header](#render_header) | Allow plugin to add content in page headers. | +| [render_includes](#render_includes) | Allow plugin to include their own CSS files. | +| [render_footer](#render_footer) | Allow plugin to add content in page footer and include their own JS files. | +| [render_linklist](#render_linklist) | It allows to add content at the begining and end of the page, after every link displayed and to alter link data. | +| [render_editlink](#render_editlink) | Allow to add fields in the form, or display elements. | +| [render_tools](#render_tools) | Allow to add content at the end of the page. | +| [render_picwall](#render_picwall) | Allow to add content at the top and bottom of the page. | +| [render_tagcloud](#render_tagcloud) | Allow to add content at the top and bottom of the page, and after all tags. | +| [render_taglist](#render_taglist) | Allow to add content at the top and bottom of the page, and after all tags. | +| [render_daily](#render_daily) | Allow to add content at the top and bottom of the page, the bottom of each link and to alter data. | +| [render_feed](#render_feed) | Allow to do add tags in RSS and ATOM feeds. | +| [save_link](#save_link) | Allow to alter the link being saved in the datastore. | +| [delete_link](#delete_link) | Allow to do an action before a link is deleted from the datastore. | + + + +#### render_header + +Triggered on every page. + +Allow plugin to add content in page headers. + +##### Data + +`$data` is an array containing: + + * `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `buttons_toolbar`: after the list of buttons in the header. + +![buttons_toolbar_example](http://i.imgur.com/ssJUOrt.png) + + * `fields_toolbar`: after search fields in the header. + +> Note: This will only be called in linklist. + +![fields_toolbar_example](http://i.imgur.com/3GMifI2.png) + +#### render_includes + +Triggered on every page. + +Allow plugin to include their own CSS files. + +##### Data + +`$data` is an array containing: + + * `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `css_files`: called after loading default CSS. + +> Note: only add the path of the CSS file. E.g: `plugins/demo_plugin/custom_demo.css`. + +#### render_footer + +Triggered on every page. + +Allow plugin to add content in page footer and include their own JS files. + +##### Data + +`$data` is an array containing: + + * `_PAGE_`: current target page (eg: `linklist`, `picwall`, etc.). + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `text`: called after the end of the footer text. + * `endofpage`: called at the end of the page. + +![text_example](http://i.imgur.com/L5S2YEH.png) + + * `js_files`: called at the end of the page, to include custom JS scripts. + +> Note: only add the path of the JS file. E.g: `plugins/demo_plugin/custom_demo.js`. + +#### render_linklist + +Triggered when `linklist` is displayed (list of links, permalink, search, tag filtered, etc.). + +It allows to add content at the begining and end of the page, after every link displayed and to alter link data. + +##### Data + +`$data` is an array containing: + + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + * All templates data, including links. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `action_plugin`: next to the button "private only" at the top and bottom of the page. + +![action_plugin_example](http://i.imgur.com/Q12PWg0.png) + + * `link_plugin`: for every link, between permalink and link URL. + +![link_plugin_example](http://i.imgur.com/3oDPhWx.png) + + * `plugin_start_zone`: before displaying the template content. + +![plugin_start_zone_example](http://i.imgur.com/OVBkGy3.png) + + * `plugin_end_zone`: after displaying the template content. + +![plugin_end_zone_example](http://i.imgur.com/6IoRuop.png) + +#### render_editlink + +Triggered when the link edition form is displayed. + +Allow to add fields in the form, or display elements. + +##### Data + +`$data` is an array containing: + + * All templates data. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `edit_link_plugin`: after tags field. + +![edit_link_plugin_example](http://i.imgur.com/5u17Ens.png) + +#### render_tools + +Triggered when the "tools" page is displayed. + +Allow to add content at the end of the page. + +##### Data + +`$data` is an array containing: + + * All templates data. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `tools_plugin`: at the end of the page. + +![tools_plugin_example](http://i.imgur.com/Bqhu9oQ.png) + +#### render_picwall + +Triggered when picwall is displayed. + +Allow to add content at the top and bottom of the page. + +##### Data + +`$data` is an array containing: + + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + * All templates data. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `plugin_start_zone`: before displaying the template content. + + * `plugin_end_zone`: after displaying the template content. + +![plugin_start_end_zone_example](http://i.imgur.com/tVTQFER.png) + +#### render_tagcloud + +Triggered when tagcloud is displayed. + +Allow to add content at the top and bottom of the page. + +##### Data + +`$data` is an array containing: + + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + * All templates data. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `plugin_start_zone`: before displaying the template content. + + * `plugin_end_zone`: after displaying the template content. + +For each tag, the following placeholder can be used: + + * `tag_plugin`: after each tag + +![plugin_start_end_zone_example](http://i.imgur.com/vHmyT3a.png) + + +#### render_taglist + +Triggered when taglist is displayed. + +Allow to add content at the top and bottom of the page. + +##### Data + +`$data` is an array containing: + + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + * All templates data. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `plugin_start_zone`: before displaying the template content. + + * `plugin_end_zone`: after displaying the template content. + +For each tag, the following placeholder can be used: + + * `tag_plugin`: after each tag + +#### render_daily + +Triggered when tagcloud is displayed. + +Allow to add content at the top and bottom of the page, the bottom of each link and to alter data. + +##### Data + +`$data` is an array containing: + + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + * All templates data, including links. + +##### Template placeholders + +Items can be displayed in templates by adding an entry in `$data['']` array. + +List of placeholders: + + * `link_plugin`: used at bottom of each link. + +![link_plugin_example](http://i.imgur.com/hzhMfSZ.png) + + * `plugin_start_zone`: before displaying the template content. + + * `plugin_end_zone`: after displaying the template content. + +#### render_feed + +Triggered when the ATOM or RSS feed is displayed. + +Allow to add tags in the feed, either in the header or for each items. Items (links) can also be altered before being rendered. + +##### Data + +`$data` is an array containing: + + * `_LOGGEDIN_`: true if user is logged in, false otherwise. + * `_PAGE_`: containing either `rss` or `atom`. + * All templates data, including links. + +##### Template placeholders + +Tags can be added in feeds by adding an entry in `$data['']` array. + +List of placeholders: + + * `feed_plugins_header`: used as a header tag in the feed. + +For each links: + + * `feed_plugins`: additional tag for every link entry. + +#### save_link + +Triggered when a link is save (new link or edit). + +Allow to alter the link being saved in the datastore. + +##### Data + +`$data` is an array containing the link being saved: + + * id + * title + * url + * shorturl + * description + * private + * tags + * created + * updated + + +#### delete_link + +Triggered when a link is deleted. + +Allow to execute any action before the link is actually removed from the datastore + +##### Data + +`$data` is an array containing the link being saved: + + * id + * title + * url + * shorturl + * description + * private + * tags + * created + * updated + +## Guide for template designer + +### Plugin administration + +Your theme must include a plugin administration page: `pluginsadmin.html`. + +> Note: repo's template link needs to be added when the PR is merged. + +Use the default one as an example. + +Aside from classic RainTPL loops, plugins order is handle by JavaScript. You can just include `plugin_admin.js`, only if: + + * you're using a table. + * you call orderUp() and orderUp() onclick on arrows. + * you add data-line and data-order to your rows. + +Otherwise, you can use your own JS as long as this field is send by the form: + + + +### Placeholder system + +In order to make plugins work with every custom themes, you need to add variable placeholder in your templates. + +It's a RainTPL loop like this: + + {loop="$plugin_variable"} + {$value} + {/loop} + +You should enable `demo_plugin` for testing purpose, since it uses every placeholder available. + +### List of placeholders + +**page.header.html** + +At the end of the menu: + + {loop="$plugins_header.buttons_toolbar"} + {$value} + {/loop} + +At the end of file, before clearing floating blocks: + + {if="!empty($plugin_errors) && isLoggedIn()"} +
      + {loop="plugin_errors"} +
    • {$value}
      • + {/loop} +
    + {/if} + +**includes.html** + +At the end of the file: + +```html +{loop="$plugins_includes.css_files"} + +{/loop} +``` + +**page.footer.html** + +At the end of your footer notes: + +```html +{loop="$plugins_footer.text"} + {$value} +{/loop} +``` + +At the end of file: + +```html +{loop="$plugins_footer.js_files"} + +{/loop} +``` + +**linklist.html** + +After search fields: + +```html +{loop="$plugins_header.fields_toolbar"} + {$value} +{/loop} +``` + +Before displaying the link list (after paging): + +```html +{loop="$plugin_start_zone"} + {$value} +{/loop} +``` + +For every links (icons): + +```html +{loop="$value.link_plugin"} + {$value} +{/loop} +``` + +Before end paging: + +```html +{loop="$plugin_end_zone"} + {$value} +{/loop} +``` + +**linklist.paging.html** + +After the "private only" icon: + +```html +{loop="$action_plugin"} + {$value} +{/loop} +``` + +**editlink.html** + +After tags field: + +```html +{loop="$edit_link_plugin"} + {$value} +{/loop} +``` + +**tools.html** + +After the last tool: + +```html +{loop="$tools_plugin"} + {$value} +{/loop} +``` + +**picwall.html** + +Top: + +```html +
    + {loop="$plugin_start_zone"} + {$value} + {/loop} +
    +``` + +Bottom: + +```html +
    + {loop="$plugin_end_zone"} + {$value} + {/loop} +
    +``` + +**tagcloud.html** + +Top: + +```html +
    + {loop="$plugin_start_zone"} + {$value} + {/loop} +
    +``` + +Bottom: + +```html +
    + {loop="$plugin_end_zone"} + {$value} + {/loop} +
    +``` + +**daily.html** + +Top: + +```html +
    + {loop="$plugin_start_zone"} + {$value} + {/loop} +
    +``` + +After every link: + +```html +
    + {loop="$link.link_plugin"} + {$value} + {/loop} +
    +``` + +Bottom: + +```html +
    + {loop="$plugin_end_zone"} + {$value} + {/loop} +
    +``` + +**feed.atom.xml** and **feed.rss.xml**: + +In headers tags section: +```xml +{loop="$feed_plugins_header"} + {$value} +{/loop} +``` + +After each entry: +```xml +{loop="$value.feed_plugins"} + {$value} +{/loop} +``` diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md new file mode 100644 index 00000000..b52b8090 --- /dev/null +++ b/doc/md/Plugins.md @@ -0,0 +1,75 @@ +## Plugin installation + +There is a bunch of plugins shipped with Shaarli, where there is nothing to do to install them. + +If you want to install a third party plugin: + + * Download it. + * Put it in the `plugins` directory in Shaarli's installation folder. + * Make sure you put it correctly: + +``` +| index.php +| plugins/ +|---| custom_plugin/ +| |---| custom_plugin.php +| |---| ... + +``` + + * Make sure your webserver can read and write the files in your plugin folder. + +## Plugin configuration + +In Shaarli's administration page (`Tools` link), go to `Plugin administration`. + +Here you can enable and disable all plugins available, and configure them. + +![administration screenshot](https://camo.githubusercontent.com/5da68e191969007492ca0fbeb25f3b2357b748cc/687474703a2f2f692e696d6775722e636f6d2f766837544643712e706e67) + +## Plugin order + +In the plugin administration page, you can move enabled plugins to the top or bottom of the list. The first plugins in the list will be processed first. + +This is important in case plugins are depending on each other. Read plugins README details for more information. + +**Use case**: The (non existent) plugin `shaares_footer` adds a footer to every shaare in Markdown syntax. It needs to be processed *before* (higher in the list) the Markdown plugin. Otherwise its syntax won't be translated in HTML. + +## File mode + +Enabled plugin are stored in your `config.php` parameters file, under the `array`: + +```php +$GLOBALS['config']['ENABLED_PLUGINS'] +``` + +You can edit them manually here. +Example: + +```php +$GLOBALS['config']['ENABLED_PLUGINS'] = array( + 'qrcode', + 'archiveorg', + 'wallabag', + 'markdown', +); +``` + +### Plugin usage + +#### Official plugins + +Usage of each plugin is documented in it's README file: + + * `addlink-toolbar`: Adds the addlink input on the linklist page + * `archiveorg`: For each link, add an Archive.org icon + * [`markdown`](https://github.com/shaarli/Shaarli/blob/master/plugins/markdown/README.md): Render shaare description with Markdown syntax. + * [`playvideos`](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md): Add a button in the toolbar allowing to watch all videos. + * `qrcode`: For each link, add a QRCode icon. + * [`wallabag`](https://github.com/shaarli/Shaarli/blob/master/plugins/wallabag/README.md): For each link, add a Wallabag icon to save it in your instance. + + + +#### Third party plugins + +See [Community & related software](https://github.com/shaarli/Shaarli/wiki/Community-%26-Related-software#third-party-plugins) diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md new file mode 100644 index 00000000..8f3f7303 --- /dev/null +++ b/doc/md/REST-API.md @@ -0,0 +1,104 @@ +## Usage + +See the [REST API documentation](http://shaarli.github.io/api-documentation/). + +## Authentication + +All requests to Shaarli's API must include a JWT token to verify their authenticity. + +This token has to be included as an HTTP header called `Authentication: Bearer `. + +JWT resources : + + * [jwt.io](https://jwt.io) (including a list of client per language). + * RFC : https://tools.ietf.org/html/rfc7519 + * https://float-middle.com/json-web-tokens-jwt-vs-sessions/ + * HackerNews thread: https://news.ycombinator.com/item?id=11929267 + + +### Shaarli JWT Token + +JWT tokens are composed by three parts, separated by a dot `.` and encoded in base64: + +``` +[header].[payload].[signature] +``` + +#### Header + +Shaarli only allow one hash algorithm, so the header will always be the same: + +```json +{ + "typ": "JWT", + "alg": "HS512" +} +``` + +Encoded in base64, it gives: + +``` +ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ== +``` + +#### Payload + +**Validity duration** + +To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key `iat` (issued at). This token will be accepted during 9 minutes. + +```json +{ + "iat": 1468663519 +} +``` + +See [RFC reference](https://tools.ietf.org/html/rfc7519#section-4.1.6). + + +#### Signature + +The signature authenticate the token validity. It contains the base64 of the header and the body, separated by a dot `.`, hashed in SHA512 with the API secret available in Shaarli administration page. + +Signature example with PHP: + +```php +$content = base64_encode($header) . '.' . base64_encode($payload); +$signature = hash_hmac('sha512', $content, $secret); +``` + + +### Complete example + +#### PHP + +```php +function generateToken($secret) { + $header = base64_encode('{ + "typ": "JWT", + "alg": "HS512" + }'); + $payload = base64_encode('{ + "iat": '. time() .' + }'); + $signature = hash_hmac('sha512', $header .'.'. $payload , $secret); + return $header .'.'. $payload .'.'. $signature; +} + +$secret = 'mysecret'; +$token = generateToken($secret); +echo $token; +``` + +> `ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==.ewogICAgICAgICJpYXQiOiAxNDY4NjY3MDQ3CiAgICB9.1d2c54fa947daf594fdbf7591796195652c8bc63bffad7f6a6db2a41c313f495a542cbfb595acade79e83f3810d709b4251d7b940bbc10b531a6e6134af63a68` + +```php +$options = [ + 'http' => [ + 'method' => 'GET', + 'jwt' => $token, + ], +]; +$context = stream_context_create($options); +file_get_contents($apiEndpoint, false, $context); +``` diff --git a/doc/md/RSS-feeds.md b/doc/md/RSS-feeds.md new file mode 100644 index 00000000..9d718172 --- /dev/null +++ b/doc/md/RSS-feeds.md @@ -0,0 +1,26 @@ +### Feeds options + +Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`. + +Options: +- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL. + - E.G. `https://my.shaarli.domain/?do=atom&permalinks`. +- You can use `nb` parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: `50`). The keyword `all` is available if you want everything. + - `https://my.shaarli.domain/?do=atom&permalinks&nb=42` + - `https://my.shaarli.domain/?do=atom&permalinks&nb=all` + +### RSS Feeds or Picture Wall for a specific search/tag + +It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to **only display results of a specific search, or for a specific tag**. + +For example, if you want to subscribe only to links tagged `photography`: +- Go to the desired Shaarli instance. +- Search for the `photography` tag in the _Filter by tag_ box. Links tagged `photography` are displayed. +- Click on the `RSS Feed` button. +- You are presented with an RSS feed showing only these links. Subscribe to it to receive only updates with this tag. +- The same method **also works for a full-text search** (_Search_ box) **and for the Picture Wall** (want to only see pictures about `nature`?) +- You can also build the URLs manually: + - `https://my.shaarli.domain/?do=rss&searchtags=nature` + - `https://my.shaarli.domain/links/?do=picwall&searchterm=poney` + +![](images/rss-filter-1.png) ![](images/rss-filter-2.png) diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md new file mode 100644 index 00000000..cce5e209 --- /dev/null +++ b/doc/md/Release-Shaarli.md @@ -0,0 +1,168 @@ +See [Git - Maintaining a project - Tagging your +releases](http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases). + +## Prerequisites +This guide assumes that you have: +- a GPG key matching your GitHub authentication credentials + - i.e., the email address identified by the GPG key is the same as the one in your `~/.gitconfig` +- a GitHub fork of Shaarli +- a local clone of your Shaarli fork, with the following remotes: + - `origin` pointing to your GitHub fork + - `upstream` pointing to the main Shaarli repository +- maintainer permissions on the main Shaarli repository, to: + - push the signed tag + - create a new release +- [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed + +## GitHub release draft and `CHANGELOG.md` +See http://keepachangelog.com/en/0.3.0/ for changelog formatting. + +### GitHub release draft +GitHub allows drafting the release note for the upcoming release, from the [Releases](https://github.com/shaarli/Shaarli/releases) page. This way, the release note can be drafted while contributions are merged to `master`. + +### `CHANGELOG.md` +This file should contain the same information as the release note draft for the upcoming version. + +Update it to: +- add new entries (additions, fixes, etc.) +- mark the current version as released by setting its date and link +- add a new section for the future unreleased version + +```bash +$ cd /path/to/shaarli + +$ nano CHANGELOG.md + +[...] +## vA.B.C - UNRELEASED +TBA + +## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD +[...] +``` + + +## Increment the version code, updated docs, create and push a signed tag +### Generate documentation +```bash +$ cd /path/to/shaarli + +# create a new branch +$ git fetch upstream +$ git checkout upstream/master -b v0.5.0 + +# rebuild the documentation from the wiki +$ make htmldoc + +# commit the changes +$ git add doc +$ git commit -s -m "Generate documentation for v0.5.0" + +# push the commit on your GitHub fork +$ git push origin v0.5.0 +``` + +### Create and merge a Pull Request +This one is pretty straightforward ;-) + +### Bump Shaarli version to v0.x branch + +``` +$ git checkout master +$ git fetch upstream +$ git pull upstream master + +# IF the branch doesn't exists +$ git checkout -b v0.5 +# OR if the branch already exists +$ git checkout v0.5 +$ git rebase upstream/master + +# Bump shaarli version from dev to 0.5.0, **without the `v`** +$ vim shaarli_version.php +$ git add shaarli_version +$ git commit -s -m "Bump Shaarli version to v0.5.0" +$ git push upstream v0.5 +``` + +### Create and push a signed tag +```bash +# update your local copy +$ git checkout v0.5 +$ git fetch upstream +$ git pull upstream v0.5 + +# create a signed tag +$ git tag -s -m "Release v0.5.0" v0.5.0 + +# push it to "upstream" +$ git push --tags upstream +``` + +### Verify a signed tag +[`v0.5.0`](https://github.com/shaarli/Shaarli/releases/tag/v0.5.0) is the first GPG-signed tag pushed on the Community Shaarli. + +Let's have a look at its signature! + +```bash +$ cd /path/to/shaarli +$ git fetch upstream + +# get the SHA1 reference of the tag +$ git show-ref tags/v0.5.0 +f7762cf803f03f5caf4b8078359a63783d0090c1 refs/tags/v0.5.0 + +# verify the tag signature information +$ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1 +gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F +gpg: Good signature from "VirtualTam " [ultimate] +``` + +## Publish the GitHub release +### Update release badges +Update `README.md` so version badges display and point to the newly released Shaarli version(s), in the `master` branch. + +### Create a GitHub release from a Git tag +From the previously drafted release: +- edit the release notes (if needed) +- specify the appropriate Git tag +- publish the release +- profit! + +### Generate and upload all-in-one release archives +Users with a shared hosting may have: +- no SSH access +- no possibility to install PHP packages or server extensions +- no possibility to run scripts + +To ease Shaarli installations, it is possible to generate and upload additional release archives, +that will contain Shaarli code plus all required third-party libraries. + +**From the `v0.5` branch:** + +```bash +$ make release_archive +``` + +This will create the following archives: +- `shaarli-vX.Y.Z-full.tar` +- `shaarli-vX.Y.Z-full.zip` + +The archives need to be manually uploaded on the previously created GitHub release. + +### Update `stable` and `latest` branches + +``` +$ git checkout latest +# latest release +$ git merge v0.5.0 +# fix eventual conflicts +$ make test +$ git push upstream latest +$ git checkout stable +# latest previous major +$ git merge v0.4.5 +# fix eventual conflicts +$ make test +$ git push upstream stable +``` diff --git a/doc/md/Reverse-proxy-configuration.md b/doc/md/Reverse-proxy-configuration.md new file mode 100644 index 00000000..91ffecff --- /dev/null +++ b/doc/md/Reverse-proxy-configuration.md @@ -0,0 +1,6 @@ + +TODO, see https://github.com/shaarli/Shaarli/issues/888 + +## HAProxy + +## Nginx diff --git a/doc/md/Security.md b/doc/md/Security.md new file mode 100644 index 00000000..aec37fa0 --- /dev/null +++ b/doc/md/Security.md @@ -0,0 +1,27 @@ +## Client browser +* Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work + +## PHP +* `magic_quotes` is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with `magic_quotes` on, so you should not be bothered even on crappy hosts. + +## Server and sessions +* Directories are protected using `.htaccess` files +* Forms are protected against XSRF (Cross-site requests forgery): + * Forms which act on data (save,delete…) contain a token generated by the server. + * Any posted form which does not contain a valid token is rejected. + * Any token can only be used once. + * Tokens are attached to the session and cannot be reused in another session. +* Sessions automatically expire after 60 minutes. +* Sessions are protected against hijacking: the session ID cannot be used from a different IP address. + +## Shaarli datastore and configuration +* The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks. +* Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a `.php` file. +* Even if the server does not support `.htaccess` files, the data file will still not be readable by URL. +* The database looks like this: +```php + +``` + +* Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. `20110923_150523`) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only `A-Z a-z 0-9 - _` and `@`. diff --git a/doc/md/Server-configuration.md b/doc/md/Server-configuration.md new file mode 100644 index 00000000..23fdbc8b --- /dev/null +++ b/doc/md/Server-configuration.md @@ -0,0 +1,392 @@ +*Example virtual host configurations for popular web servers* + +- [Apache](#apache) +- [Nginx](#nginx) + +## Prerequisites +### Shaarli +* Shaarli is installed in a directory readable/writeable by the user +* the correct read/write permissions have been granted to the web server _user and/or group_ +* for HTTPS / SSL: + * a key pair (public, private) and a certificate have been generated + * the appropriate server SSL extension is installed and active + +### HTTPS, TLS and self-signed certificates +Related guides: +* [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php) +* [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority) +* Generate a self-signed certificate (will trigger browser warnings) with apache2: `make-ssl-cert generate-default-snakeoil --force-overwrite` will create `/etc/ssl/certs/ssl-cert-snakeoil.pem` and `/etc/ssl/private/ssl-cert-snakeoil.key` + +### Proxies +If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set: +- `X-Forwarded-Proto`; +- `X-Forwarded-Host`; +- `X-Forwarded-For`. + +See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. + +## Apache +### Minimal +```apache + + ServerName shaarli.my-domain.org + DocumentRoot /absolute/path/to/shaarli/ + +``` +### Debug - Log all the things! +This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors. + +See: +* [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow) +* [PHP: php_value vs php_admin_value and the use of php_flag explained](https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/) + +```apache + + ServerName shaarli.my-domain.org + DocumentRoot /absolute/path/to/shaarli/ + + LogLevel warn + ErrorLog /var/log/apache2/shaarli-error.log + CustomLog /var/log/apache2/shaarli-access.log combined + + php_flag log_errors on + php_flag display_errors on + php_value error_reporting 2147483647 + php_value error_log /var/log/apache2/shaarli-php-error.log + +``` + +### Standard - Keep access and error logs +```apache + + ServerName shaarli.my-domain.org + DocumentRoot /absolute/path/to/shaarli/ + + LogLevel warn + ErrorLog /var/log/apache2/shaarli-error.log + CustomLog /var/log/apache2/shaarli-access.log combined + +``` + +### Paranoid - Redirect HTTP (:80) to HTTPS (:443) +See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) (Mozilla). + +```apache + + ServerName shaarli.my-domain.org + DocumentRoot /absolute/path/to/shaarli/ + + SSLEngine on + SSLCertificateFile /absolute/path/to/the/website/certificate.pem + SSLCertificateKeyFile /absolute/path/to/the/website/key.key + + + AllowOverride All + Options Indexes FollowSymLinks MultiViews + Order allow,deny + allow from all + + + LogLevel warn + ErrorLog /var/log/apache2/shaarli-error.log + CustomLog /var/log/apache2/shaarli-access.log combined + + + ServerName shaarli.my-domain.org + Redirect 301 / https://shaarli.my-domain.org + + LogLevel warn + ErrorLog /var/log/apache2/shaarli-error.log + CustomLog /var/log/apache2/shaarli-access.log combined + +``` + +### .htaccess + +Shaarli use `.htaccess` Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive `AllowOverride All` in your virtual host configuration for them to work. + +**Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled. + +Apache module `mod_rewrite` **must** be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root `.htaccess` file. + +## LightHttpd + +## Nginx +### Foreword +Nginx does not natively interpret PHP scripts; to this effect, we will run a [FastCGI](https://en.wikipedia.org/wiki/FastCGI) service, to which Nginx's FastCGI module will proxy all requests to PHP resources. + +Required packages: +- [nginx](http://nginx.org) +- [php-fpm](http://php-fpm.org) - PHP FastCGI Process Manager + +Official documentation: +- [Beginner's guide](http://nginx.org/en/docs/beginners_guide.html) +- [ngx_http_fastcgi_module](http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html) +- [Pitfalls](http://wiki.nginx.org/Pitfalls) + +Community resources: +- [Server-side TLS (Nginx)](https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx) (Mozilla) +- [PHP configuration examples](http://kbeezie.com/nginx-configuration-examples/) (Karl Blessing) + +### Common setup +Once Nginx and PHP-FPM are installed, we need to ensure: +- Nginx and PHP-FPM are running using the _same user and group_ +- both these user and group have + - `read` permissions for Shaarli resources + - `execute` permissions for Shaarli directories _AND_ their parent directories + +On a production server: +- `user:group` will likely be `http:http`, `www:www` or `www-data:www-data` +- files will be located under `/var/www`, `/var/http` or `/usr/share/nginx` + +On a development server: +- files may be located in a user's home directory +- in this case, make sure both Nginx and PHP-FPM are running as the local user/group! + +For all following configuration examples, this user/group pair will be used: +- `user:group = john:users`, + +which corresponds to the following service configuration: + +```ini +; /etc/php/php-fpm.conf +user = john +group = users + +[...] +listen.owner = john +listen.group = users +``` + +```nginx +# /etc/nginx/nginx.conf +user john users; + +http { + [...] +} +``` + +### (Optional) Increase the maximum file upload size +Some bookmark dumps generated by web browsers can be _huge_ due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders. + +To increase upload size, you will need to modify both nginx and PHP configuration: + +```nginx +# /etc/nginx/nginx.conf + +http { + [...] + + client_max_body_size 10m; + + [...] +} +``` + +```ini +# /etc/php5/fpm/php.ini + +[...] +post_max_size = 10M +[...] +upload_max_filesize = 10M +``` + +### Minimal +_WARNING: Use for development only!_ + +```nginx +user john users; +worker_processes 1; +events { + worker_connections 1024; +} + +http { + include mime.types; + default_type application/octet-stream; + keepalive_timeout 20; + + index index.html index.php; + + server { + listen 80; + server_name localhost; + root /home/john/web; + + access_log /var/log/nginx/access.log; + error_log /var/log/nginx/error.log; + + location /shaarli/ { + try_files $uri /shaarli/index.php$is_args$args; + access_log /var/log/nginx/shaarli.access.log; + error_log /var/log/nginx/shaarli.error.log; + } + + location ~ (index)\.php$ { + try_files $uri =404; + fastcgi_split_path_info ^(.+\.php)(/.+)$; + fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock; + fastcgi_index index.php; + include fastcgi.conf; + } + } +} +``` + +### Modular +The previous setup is sufficient for development purposes, but has several major caveats: +- every content that does not match the PHP rule will be sent to client browsers: + - dotfiles - in our case, `.htaccess` + - temporary files, e.g. Vim or Emacs files: `index.php~` +- asset / static resource caching is not optimized +- if serving several PHP sites, there will be a lot of duplication: `location /shaarli/`, `location /mysite/`, etc. + +To solve this, we will split Nginx configuration in several parts, that will be included when needed: + +```nginx +# /etc/nginx/deny.conf +location ~ /\. { + # deny access to dotfiles + access_log off; + log_not_found off; + deny all; +} + +location ~ ~$ { + # deny access to temp editor files, e.g. "script.php~" + access_log off; + log_not_found off; + deny all; +} +``` + +```nginx +# /etc/nginx/php.conf +location ~ (index)\.php$ { + # Slim - split URL path into (script_filename, path_info) + try_files $uri =404; + fastcgi_split_path_info ^(.+\.php)(/.+)$; + + # filter and proxy PHP requests to PHP-FPM + fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock; + fastcgi_index index.php; + include fastcgi.conf; +} + +location ~ \.php$ { + # deny access to all other PHP scripts + deny all; +} +``` + +```nginx +# /etc/nginx/static_assets.conf +location ~* \.(?:ico|css|js|gif|jpe?g|png)$ { + expires max; + add_header Pragma public; + add_header Cache-Control "public, must-revalidate, proxy-revalidate"; +} +``` + +```nginx +# /etc/nginx/nginx.conf +[...] + +http { + [...] + + root /home/john/web; + access_log /var/log/nginx/access.log; + error_log /var/log/nginx/error.log; + + server { + # virtual host for a first domain + listen 80; + server_name my.first.domain.org; + + location /shaarli/ { + # Slim - rewrite URLs + try_files $uri /shaarli/index.php$is_args$args; + + access_log /var/log/nginx/shaarli.access.log; + error_log /var/log/nginx/shaarli.error.log; + } + + location = /shaarli/favicon.ico { + # serve the Shaarli favicon from its custom location + alias /var/www/shaarli/images/favicon.ico; + } + + include deny.conf; + include static_assets.conf; + include php.conf; + } + + server { + # virtual host for a second domain + listen 80; + server_name second.domain.com; + + location /minigal/ { + access_log /var/log/nginx/minigal.access.log; + error_log /var/log/nginx/minigal.error.log; + } + + include deny.conf; + include static_assets.conf; + include php.conf; + } +} +``` + +### Redirect HTTP to HTTPS +Assuming you have generated a (self-signed) key and certificate, and they are located under `/home/john/ssl/localhost.{key,crt}`, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage. + +```nginx +# /etc/nginx/nginx.conf +[...] + +http { + [...] + + index index.html index.php; + + root /home/john/web; + access_log /var/log/nginx/access.log; + error_log /var/log/nginx/error.log; + + server { + listen 80; + server_name localhost; + + return 301 https://localhost$request_uri; + } + + server { + listen 443 ssl; + server_name localhost; + + ssl_certificate /home/john/ssl/localhost.crt; + ssl_certificate_key /home/john/ssl/localhost.key; + + location /shaarli/ { + # Slim - rewrite URLs + try_files $uri /index.php$is_args$args; + + access_log /var/log/nginx/shaarli.access.log; + error_log /var/log/nginx/shaarli.error.log; + } + + location = /shaarli/favicon.ico { + # serve the Shaarli favicon from its custom location + alias /var/www/shaarli/images/favicon.ico; + } + + include deny.conf; + include static_assets.conf; + include php.conf; + } +} +``` diff --git a/doc/md/Server-requirements.md b/doc/md/Server-requirements.md new file mode 100644 index 00000000..b6bbd66a --- /dev/null +++ b/doc/md/Server-requirements.md @@ -0,0 +1,40 @@ +## PHP + +### Release information +- [PHP: Supported versions](http://php.net/supported-versions.php) +- [PHP: Unsupported versions](http://php.net/eol.php) _(EOL - End Of Life)_ +- [PHP 7 Changelog](http://php.net/ChangeLog-7.php) +- [PHP 5 Changelog](http://php.net/ChangeLog-5.php) +- [PHP: Bugs](https://bugs.php.net/) + +### Supported versions +Version | Status | Shaarli compatibility +:---:|:---:|:---: +7.1 | Supported (v0.9.x) | :white_check_mark: +7.0 | Supported | :white_check_mark: +5.6 | Supported | :white_check_mark: +5.5 | EOL: 2016-07-10 | :white_check_mark: +5.4 | EOL: 2015-09-14 | :white_check_mark: (up to Shaarli 0.8.x) +5.3 | EOL: 2014-08-14 | :white_check_mark: (up to Shaarli 0.8.x) + +See also: +- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml) + +### Dependency management +Starting with Shaarli `v0.8.x`, [Composer](https://getcomposer.org/) is used to resolve, +download and install third-party PHP dependencies. + +Library | Required? | Usage +---|:---:|--- +[`shaarli/netscape-bookmark-parser`](https://packagist.org/packages/shaarli/netscape-bookmark-parser) | All | Import bookmarks from Netscape files +[`erusev/parsedown`](https://packagist.org/packages/erusev/parsedown) | All | Parse MarkDown syntax for the MarkDown plugin +[`slim/slim`](https://packagist.org/packages/slim/slim) | All | Handle routes and middleware for the REST API + +### Extensions +Extension | Required? | Usage +---|:---:|--- +[`openssl`](http://php.net/manual/en/book.openssl.php) | All | OpenSSL, HTTPS +[`php-mbstring`](http://php.net/manual/en/book.mbstring.php) | CentOS, Fedora, RHEL, Windows | multibyte (Unicode) string support +[`php-gd`](http://php.net/manual/en/book.image.php) | optional | thumbnail resizing +[`php-intl`](http://php.net/manual/en/book.intl.php) | optional | localized text sorting (e.g. `e->è->f`) +[`php-curl`](http://php.net/manual/en/book.curl.php) | optional | using cURL for fetching webpages and thumbnails in a more robust way diff --git a/doc/md/Server-security.md b/doc/md/Server-security.md new file mode 100644 index 00000000..8df36f46 --- /dev/null +++ b/doc/md/Server-security.md @@ -0,0 +1,73 @@ +## php.ini +PHP settings are defined in: +- a main configuration file, usually found under `/etc/php5/php.ini`; some distributions provide different configuration environments, e.g. + - `/etc/php5/php.ini` - used when running console scripts + - `/etc/php5/apache2/php.ini` - used when a client requests PHP resources from Apache + - `/etc/php5/php-fpm.conf` - used when PHP requests are proxied to PHP-FPM +- additional configuration files/entries, depending on the installed/enabled extensions: + - `/etc/php/conf.d/xdebug.ini` + +### Locate .ini files +#### Console environment +```bash +$ php --ini +Configuration File (php.ini) Path: /etc/php +Loaded Configuration File: /etc/php/php.ini +Scan for additional .ini files in: /etc/php/conf.d +Additional .ini files parsed: /etc/php/conf.d/xdebug.ini +``` + +#### Server environment +- create a `phpinfo.php` script located in a path supported by the web server, e.g. + - Apache (with user dirs enabled): `/home/myself/public_html/phpinfo.php` + - `/var/www/test/phpinfo.php` +- make sure the script is readable by the web server user/group (usually, `www`, `www-data` or `httpd`) +- access the script from a web browser +- look at the _Loaded Configuration File_ and _Scan this dir for additional .ini files_ entries +```php + +``` + +## fail2ban +`fail2ban` is an intrusion prevention framework that reads server (Apache, SSH, etc.) and uses `iptables` profiles to block brute-force attempts: +- [Official website](http://www.fail2ban.org/wiki/index.php/Main_Page) +- [Source code](https://github.com/fail2ban/fail2ban) + +### Read Shaarli logs to ban IPs +Example configuration: +- allow 3 login attempts per IP address +- after 3 failures, permanently ban the corresponding IP adddress + +`/etc/fail2ban/jail.local` +```ini +[shaarli-auth] +enabled = true +port = https,http +filter = shaarli-auth +logpath = /var/www/path/to/shaarli/data/log.txt +maxretry = 3 +bantime = -1 +``` + +`/etc/fail2ban/filter.d/shaarli-auth.conf` +```ini +[INCLUDES] +before = common.conf +[Definition] +failregex = \s-\s\s-\sLogin failed for user.*$ +ignoreregex = +``` + +## Robots - Restricting search engines and web crawler traffic + +Creating a `robots.txt` with the following contents at the root of your Shaarli installation will prevent _honest_ web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic. + +``` +User-agent: * +Disallow: / +``` + +See: +- http://www.robotstxt.org/ +- http://www.robotstxt.org/robotstxt.html +- http://www.robotstxt.org/meta.html diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md new file mode 100644 index 00000000..933f5245 --- /dev/null +++ b/doc/md/Shaarli-configuration.md @@ -0,0 +1,215 @@ +## Foreword + +**Do not edit configuration options in index.php! Your changes would be lost.** + +Once your Shaarli instance is installed, the file `data/config.json.php` is generated: +* it contains all settings in JSON format, and can be edited to customize values +* it defines which [plugins](Plugin-System) are enabled[](.html) +* its values override those defined in `index.php` +* it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration + +## File and directory permissions + +The server process running Shaarli must have: +- `read` access to the following resources: + - PHP scripts: `index.php`, `application/*.php`, `plugins/*.php` + - 3rd party PHP and Javascript libraries: `inc/*.php`, `inc/*.js` + - static assets: + - CSS stylesheets: `inc/*.css` + - `images/*` + - RainTPL templates: `tpl/*.html` +- `read`, `write` and `execution` access to the following directories: + - `cache` - thumbnail cache + - `data` - link data store, configuration options + - `pagecache` - Atom/RSS feed cache + - `tmp` - RainTPL page cache + +On a Linux distribution: +- the web server user will likely be `www` or `http` (for Apache2) +- it will be a member of a group of the same name: `www:www`, `http:http` +- to give it access to Shaarli, either: + - unzip Shaarli in the default web server location (usually `/var/www/`) and set the web server user as the owner + - put users in the same group as the web server, and set the appropriate access rights +- if you have a domain / subdomain to serve Shaarli, [configure the server](Server-configuration) accordingly[](.html) + +## Configuration + +In `data/config.json.php`. + +See also [Plugin System](Plugin-System.html). + +### Credentials + +> You shouldn't edit those. + +**login**: Login username. +**hash**: Generated password hash. +**salt**: Password salt. + +### General + +**title**: Shaarli's instance title. +**header_link**: Link to the homepage. +**links_per_page**: Number of shaares displayed per page. +**timezone**: See [the list of supported timezones](http://php.net/manual/en/timezones.php). +**enabled_plugins**: List of enabled plugins. + +### Security + +**session_protection_disabled**: Disable session cookie hijacking protection (not recommended). +It might be useful if your IP adress often changes. +**ban_after**: Failed login attempts before being IP banned. +**ban_duration**: IP ban duration in seconds. +**open_shaarli**: Anyone can add a new link while logged out if enabled. +**trusted_proxies**: List of trusted IP which won't be banned after failed login attemps. Useful if Shaarli is behind a reverse proxy. +**allowed_protocols**: List of allowed protocols in shaare URLs or markdown-rendered descriptions. Useful if you want to store `javascript:` links (bookmarklets) in Shaarli (default: `["ftp", "ftps", "magnet"]`). + +### Resources + +**data_dir**: Data directory. +**datastore**: Shaarli's links database file path. +**history**: Shaarli's operation history file path. +**updates**: File path for the ran updates file. +**log**: Log file path. +**update_check**: Last update check file path. +**raintpl_tpl**: Templates directory. +**raintpl_tmp**: Template engine cache directory. +**thumbnails_cache**: Thumbnails cache directory. +**page_cache**: Shaarli's internal cache directory. +**ban_file**: Banned IP file path. + +### Updates + +**check_updates**: Enable or disable update check to the git repository. +**check_updates_branch**: Git branch used to check updates (e.g. `stable` or `master`). +**check_updates_interval**: Look for new version every N seconds (default: every day). + +### Privacy + +**default_private_links**: Check the private checkbox by default for every new link. +**hide_public_links**: All links are hidden while logged out. +**hide_timestamps**: Timestamps are hidden. + +### Feed + +**rss_permalinks**: Enable this to redirect RSS links to Shaarli's permalinks instead of shaared URL. +**show_atom**: Display ATOM feed button. + +### Thumbnail + +**enable_thumbnails**: Enable or disable thumbnail display. +**enable_localcache**: Enable or disable local cache. + +### Redirector + +**url**: Redirector URL, such as `anonym.to`. +**encode_url**: Enable this if the redirector needs encoded URL to work properly. + +## Configuration file example + +```json +", + "hash": "", + "salt": "" + }, + "security": { + "ban_after": 4, + "session_protection_disabled": false, + "ban_duration": 1800, + "trusted_proxies": [ + "1.2.3.4", + "5.6.7.8" + ], + "allowed_protocols": [ + "ftp", + "ftps", + "magnet" + ] + }, + "resources": { + "data_dir": "data", + "config": "data\/config.php", + "datastore": "data\/datastore.php", + "ban_file": "data\/ipbans.php", + "updates": "data\/updates.txt", + "log": "data\/log.txt", + "update_check": "data\/lastupdatecheck.txt", + "raintpl_tmp": "tmp\/", + "raintpl_tpl": "tpl\/", + "thumbnails_cache": "cache", + "page_cache": "pagecache" + }, + "general": { + "check_updates": true, + "rss_permalinks": true, + "links_per_page": 20, + "default_private_links": true, + "enable_thumbnails": true, + "enable_localcache": true, + "check_updates_branch": "stable", + "check_updates_interval": 86400, + "enabled_plugins": [ + "markdown", + "wallabag", + "archiveorg" + ], + "timezone": "Europe\/Paris", + "title": "My Shaarli", + "header_link": "?" + }, + "extras": { + "show_atom": false, + "hide_public_links": false, + "hide_timestamps": false, + "open_shaarli": false, + "redirector": "http://anonym.to/?", + "redirector_encode_url": false + }, + "general": { + "header_link": "?", + "links_per_page": 20, + "enabled_plugins": [ + "markdown", + "wallabag" + ], + "timezone": "Europe\/Paris", + "title": "My Shaarli" + }, + "updates": { + "check_updates": true, + "check_updates_branch": "stable", + "check_updates_interval": 86400 + }, + "feed": { + "rss_permalinks": true, + "show_atom": false + }, + "privacy": { + "default_private_links": true, + "hide_public_links": false, + "hide_timestamps": false + }, + "thumbnail": { + "enable_thumbnails": true, + "enable_localcache": true + }, + "redirector": { + "url": "http://anonym.to/?", + "encode_url": false + }, + "plugins": { + "WALLABAG_URL": "http://demo.wallabag.org", + "WALLABAG_VERSION": "1" + } +} ?> +``` + +## Additional configuration + +The playvideos plugin may require that you adapt your server's +[Content Security Policy](https://github.com/shaarli/Shaarli/blob/master/plugins/playvideos/README.md#troubleshooting) +configuration to work properly.[](.html) + diff --git a/doc/md/Shaarli-images.md b/doc/md/Shaarli-images.md new file mode 100644 index 00000000..25f6cfdd --- /dev/null +++ b/doc/md/Shaarli-images.md @@ -0,0 +1,72 @@ +## Get and run a Shaarli image + +### DockerHub repository +The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/) +repository. + +### Available image tags +- `latest`: master branch (tarball release) +- `stable`: stable branch (tarball release) +- `dev`: master branch (Git clone) + +All images rely on: +- [Debian 8 Jessie](https://hub.docker.com/_/debian/) +- [PHP5-FPM](http://php-fpm.org/) +- [Nginx](http://nginx.org/) + +### Download from DockerHub +```bash +$ docker pull shaarli/shaarli +latest: Pulling from shaarli/shaarli +32716d9fcddb: Pull complete +84899d045435: Pull complete +4b6ad7444763: Pull complete +e0345ef7a3e0: Pull complete +5c1dd344094f: Pull complete +6422305a200b: Pull complete +7d63f861dbef: Pull complete +3eb97210645c: Pull complete +869319d746ff: Already exists +869319d746ff: Pulling fs layer +902b87aaaec9: Already exists +Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98 +Status: Downloaded newer image for shaarli/shaarli:latest +``` + +### Create and start a new container from the image +```bash +# map the host's :8000 port to the container's :80 port +$ docker create -p 8000:80 shaarli/shaarli +d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 + +# launch the container in the background +$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 +d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 + +# list active containers +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo +``` + +### Stop and destroy a container +```bash +$ docker stop backstabbing_galileo # those docker guys are really rude to physicists! +backstabbing_galileo + +# check the container is stopped +$ docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES + +# list ALL containers +$ docker ps -a +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo + +# destroy the container +$ docker rm backstabbing_galileo # let's put an end to these barbarian practices +backstabbing_galileo + +$ docker ps -a +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +``` diff --git a/doc/md/Static-analysis.md b/doc/md/Static-analysis.md new file mode 100644 index 00000000..ee4f5978 --- /dev/null +++ b/doc/md/Static-analysis.md @@ -0,0 +1,11 @@ +## WIP +This topic is currently being discussed here: +- [Fix coding style (static analysis)](https://github.com/shaarli/Shaarli/issues/95) (#95) +- [Continuous Integration tools & features](https://github.com/shaarli/Shaarli/issues/130) (#130) + +### Usage +Static analysis tools can be installed with Composer, and used through Shaarli's [Makefile](https://github.com/shaarli/Shaarli/blob/master/Makefile). + +For an overview of the available features, see: +- [Code quality: Makefile to run static code checkers](https://github.com/shaarli/Shaarli/pull/124) (#124) +- [Run PHPCS against different coding standards](https://github.com/shaarli/Shaarli/pull/276) (#276) diff --git a/doc/md/Theming.md b/doc/md/Theming.md new file mode 100644 index 00000000..ae68db38 --- /dev/null +++ b/doc/md/Theming.md @@ -0,0 +1,84 @@ +## Foreword + +There are two ways of customizing how Shaarli looks: + +1. by using a custom CSS to override Shaarli's CSS +2. by using a full theme that provides its own RainTPL templates, CSS and Javascript resources + +## Custom CSS + +Shaarli's appearance can be modified by adding CSS rules to: +- Shaarli < `v0.9.0`: `inc/user.css` +- Shaarli >= `v0.9.0`: `data/user.css` + +This file allows overriding rules defined in the template CSS files (only add changed rules), or define a whole new theme. + +**Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. + +See also [[Download CSS styles from an OPML list]] + +## Themes + +_WARNING - This feature is currently being worked on and will be improved in the next releases. Experimental._ + +Installation: +- find a theme you'd like to install +- copy or clone the theme folder under `tpl/` +- enable the theme: + - Shaarli < `v0.9.0`: edit `data/config.json.php` and set the value of `raintpl_tpl` to the new theme name: + `"raintpl_tpl": "tpl\/my-template\/"` + - Shaarli >= `v0.9.0`: select the theme through the _Tools_ page + +## Community CSS & themes + +### Custom CSS + +- [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for Shaarli +- [shaarli/shaarli-themes](https://github.com/shaarli/shaarli-themes) + +### Themes + +- [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli +- [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli +- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme +- [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli +- [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli +- [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone +- [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site + +### Shaarli forks + +- [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template +- [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance + +## Example installation: AlbinoMouse theme + +With the following configuration: +- Apache 2 / PHP 5.6 +- user sites are enabled, e.g. `/home/user/public_html/somedir` is served as `http://localhost/~user/somedir` +- `http` is the name of the Apache user + +```bash +$ cd ~/public_html + +# clone repositories +$ git clone https://github.com/shaarli/Shaarli.git shaarli +$ pushd shaarli/tpl +$ git clone https://github.com/alexisju/albinomouse-template.git +$ popd + +# set access rights for Apache +$ chgrp -R http shaarli +$ chmod g+rwx shaarli shaarli/cache shaarli/data shaarli/pagecache shaarli/tmp +``` + +Get config written: +- go to the freshly installed site +- fill the install form +- log in to Shaarli + +Edit Shaarli's [[configuration|Shaarli configuration]]: +```bash +# the file should be owned by Apache, thus not writeable => sudo +$ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php +``` diff --git a/doc/md/Troubleshooting.md b/doc/md/Troubleshooting.md new file mode 100644 index 00000000..13005526 --- /dev/null +++ b/doc/md/Troubleshooting.md @@ -0,0 +1,123 @@ +# Troubleshooting + +## Browser + +### Redirection issues (HTTP Referer) + +Depending on its configuration and installed plugins, the browser may remove or alter (spoof) HTTP referers, thus preventing Shaarli from properly redirecting between pages. + +See: +- [HTTP referer](https://en.wikipedia.org/wiki/HTTP_referer) (Wikipedia) +- [Improve online privacy by controlling referrer information](http://www.ghacks.net/2015/01/22/improve-online-privacy-by-controlling-referrer-information/) +- [Better security, privacy and anonymity in Firefox](http://b.agilob.net/better-security-privacy-and-anonymity-in-firefox/) + +### Firefox HTTP Referer options + +HTTP settings are available by browsing `about:config`, here are the available settings and their values. + +`network.http.sendRefererHeader` - determines when to send the Referer HTTP header +- 0: Never send the referring URL + - not recommended, may break some sites +- 1: Send only on clicked links +- 2 (default): Send for links and images + +`network.http.referer.XOriginPolicy` - Cross-domain origin policy +- 0 (default): Always send +- 1: Send if base domains match +- 2: Send if hosts match + +`network.http.referer.spoofSource` - Referer spoofing (~faking) +- false (default): real referer +- true: spoof referer (use target URI as referer) + - known to break some functionality in Shaarli + +`network.http.referer.trimmingPolicy` - trim the URI not to send a full Referer +- 0 (default): send full URI +- 1: scheme+host+port+path +- 2: scheme+host+port + +### Firefox, localhost and redirections + +`localhost` is not a proper Fully Qualified Domain Name (FQDN); if Firefox has been set up to spoof referers, or only accept requests from the same base domain/host, Shaarli redirections will not work properly. + +To solve this, assign a local domain to your host, e.g. +``` +127.0.0.1 localhost desktop localhost.lan +::1 localhost desktop localhost.lan +``` + +and browse Shaarli at http://localhost.lan/. + +Related threads: +- [What is localhost.localdomain for?](https://bbs.archlinux.org/viewtopic.php?id=156064) +- [Stop returning to the first page after editing a bookmark from another page](https://github.com/shaarli/Shaarli/issues/311) + +## Login + +### I forgot my password! + +Delete the file `data/config.php` and display the page again. You will be asked for a new login/password. + +### I'm locked out - Login bruteforce protection + +Login form is protected against brute force attacks: 4 failed logins will ban the IP address from login for 30 minutes. Banned IPs can still browse links. + +To remove the current IP bans, delete the file `data/ipbans.php` + +### List of all login attempts + +The file `data/log.txt` shows all logins (successful or failed) and bans/lifted bans. +Search for `failed` in this file to look for unauthorized login attempts. + +## Hosting problems + +### Old PHP versions + + * On **free.fr** : free.fr now support php 5.6.x([link](http://les.pages.perso.chez.free.fr/migrations/php5v6.io))and so support now the tag autocompletion but you have to do the following : At the root of your webspace create a `sessions` directory and a `.htaccess` file containing: + +```ini + +php56 1 + +``` + + * If you have an error such as: `Parse error: syntax error, unexpected '=', expecting '(' in /links/index.php on line xxx`, it means that your host is using php4, not php5. Shaarli requires php 5.1. Try changing the file extension to `.php5` + * On **1and1** : If you add the link from the page (and not from the bookmarklet), Shaarli will no be able to get the title of the page. You will have to enter it manually. (Because they have disabled the ability to download a file through HTTP). + * If you have the error `Warning: file_get_contents() [function.file-get-contents]: URL file-access is disabled in the server configuration in /…/index.php on line xxx`, it means that your host has disabled the ability to fetch a file by HTTP in the php config (Typically in 1and1 hosting). Bad host. Change host. Or comment the following lines: + +```php +//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive. +// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) in html +//if (strpos($status,'200 OK')) $title=html_extract_title($data); +``` + + * On hosts which forbid outgoing HTTP requests (such as free.fr), some thumbnails will not work. + * On **lost-oasis**, RSS doesn't work correctly, because of this message at the begining of the RSS/ATOM feed : ``. To fix this, remove this message from `php-include/prepend.php` + +### Dates are not properly formatted + +Shaarli tries to sniff the language of the browser (using HTTP_ACCEPT_LANGUAGE headers) and choose a date format accordingly. But Shaarli can only use the date formats (and more generaly speaking, the locales) provided by the webserver. So even if you have a browser in French, you may end up with dates in US format (it's the case on sebsauvage.net :-( ) + +### Problems on CentOS servers + +On **CentOS**/RedHat derivatives, you may need to install the `php-mbstring` package. + + +### My session expires! I can't stay logged in + +This can be caused by several things: + +* Your php installation may not have a proper directory setup for session files. (eg. on Free.fr you need to create a `session` directory on the root of your website.) You may need to create the session directory of set it up. +* Most hosts regularly clean the temporary and session directories. Your host may be cleaning those directories too aggressively (eg.OVH hosts), forcing an expire of the session. You may want to set the session directory in your web root. (eg. Create the `sessions` subdirectory and add `ini_set('session.save_path', $_SERVER['DOCUMENT_ROOT'].'/../sessions');`. Make sure this directory is not browsable !) +* If your IP address changes during surfing, Shaarli will force expire your session for security reasons (to prevent session cookie hijacking). This can happen when surfing from WiFi or 3G (you may have switched WiFi/3G access point), or in some corporate/university proxies which use load balancing (and may have proxies with several external IP addresses). +* Some browser addons may interfer with HTTP headers (ipfuck/ipflood/GreaseMonkey…). Try disabling those. +* You may be using OperaTurbo or OperaMini, which use their own proxies which may change from time to time. +* If you have another application on the same webserver where Shaarli is installed, these application may forcefully expire php sessions. + +## Sessions do not seem to work correctly on your server + +Follow the instructions in the error message. Make sure you are accessing shaarli via a direct IP address or a proper hostname. If you have **no dots** in the hostname (e.g. `localhost` or `http://my-webserver/shaarli/`), some browsers will not store cookies at all (this respects the [HTTP cookie specification](http://curl.haxx.se/rfc/cookie_spec.html)). + +### pubsubhubbub support + +Download [publisher.php](https://pubsubhubbub.googlecode.com/git/publisher_clients/php/library/publisher.php) at the root of your Shaarli installation and set `$GLOBALS['config']['PUBSUBHUB_URL']` in your `config.php` diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md new file mode 100644 index 00000000..19838721 --- /dev/null +++ b/doc/md/Unit-tests.md @@ -0,0 +1,152 @@ +### Setup your environment for tests + +The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. + +Regarding Composer, you can either use: +* a system-wide version, e.g. installed through your distro's package manager +* a local version, downloadable [here](https://getcomposer.org/download/) + +#### Sample usage + +```bash +# system-wide version +$ composer install +$ composer update + +# local version +$ php composer.phar self-update +$ php composer.phar install +$ php composer.phar update +``` + +#### Install Shaarli dev dependencies + +```bash +$ cd /path/to/shaarli +$ composer update +``` + +#### Install and enable Xdebug to generate PHPUnit coverage reports + +For Debian-based distros: +```bash +$ aptitude install php5-xdebug +``` +For ArchLinux: +```bash +$ pacman -S xdebug +``` + +Then add the following line to `/etc/php/php.ini`: +```ini +zend_extension=xdebug.so +``` + +#### Run unit tests + +Successful test suite: +```bash +$ make test + +------- +PHPUNIT +------- +PHPUnit 4.6.9 by Sebastian Bergmann and contributors. + +Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml + +.................................... + +Time: 759 ms, Memory: 8.25Mb + +OK (36 tests, 65 assertions) +``` + +Test suite with failures and errors: +```bash +$ make test +------- +PHPUNIT +------- +PHPUnit 4.6.9 by Sebastian Bergmann and contributors. + +Configuration read from /home/virtualtam/public_html/shaarli/phpunit.xml + +E..FF............................... + +Time: 802 ms, Memory: 8.25Mb + +There was 1 error: + +1) LinkDBTest::testConstructLoggedIn +Missing argument 2 for LinkDB::__construct(), called in /home/virtualtam/public_html/shaarli/tests/Link\ +DBTest.php on line 79 and defined + +/home/virtualtam/public_html/shaarli/application/LinkDB.php:58 +/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:79 + +-- + +There were 2 failures: + +1) LinkDBTest::testCheckDBNew +Failed asserting that two strings are equal. +--- Expected ++++ Actual +@@ @@ +-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e' ++'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834' + +/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:121 + +2) LinkDBTest::testCheckDBLoad +Failed asserting that two strings are equal. +--- Expected ++++ Actual +@@ @@ +-'e3edea8ea7bb50be4bcb404df53fbb4546a7156e' ++'85eab0c610d4f68025f6ed6e6b6b5fabd4b55834' + +/home/virtualtam/public_html/shaarli/tests/LinkDBTest.php:133 + +FAILURES! +Tests: 36, Assertions: 63, Errors: 1, Failures: 2. +``` + +#### Test results and coverage + +By default, PHPUnit will run all suitable tests found under the `tests` directory. + +Each test has 3 possible outcomes: +* `.` - success +* `F` - failure: the test was run but its results are invalid + * the code does not behave as expected + * dependencies to external elements: globals, session, cache... +* `E` - error: something went wrong and the tested code has crashed + * typos in the code, or in the test code + * dependencies to missing external elements + +If Xdebug has been installed and activated, two coverage reports will be generated: +* a summary in the console +* a detailed HTML report with metrics for tested code + * to open it in a web browser: `firefox coverage/index.html &` + +### Executing specific tests + +Add a [`@group`](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group) annotation in a test class or method comment: + +```php +/** + * Netscape bookmark import + * @group WIP + */ +class BookmarkImportTest extends PHPUnit_Framework_TestCase +{ + [...] +} +``` + +To run all tests annotated with `@group WIP`: +```bash +$ vendor/bin/phpunit --group WIP tests/ +``` diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md new file mode 100644 index 00000000..7348891f --- /dev/null +++ b/doc/md/Upgrade-and-migration.md @@ -0,0 +1,194 @@ +## Preparation + +### Note your current version + +If anything goes wrong, it's important for us to know which version you're upgrading from. +The current version is present in the `version.php` file. + +### Backup your data + +Shaarli stores all user data under the `data` directory: +- `data/config.php` - main configuration file +- `data/datastore.php` - bookmarked links +- `data/ipbans.php` - banned IP addresses +- `data/updates.txt` - contains all automatic update to the configuration and datastore files already run + +See [[Shaarli configuration]] for more information about Shaarli resources. + +It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: +- users with SSH access: copy or archive the directory to a temporary location +- users with FTP access: download a local copy of your Shaarli installation using your favourite client + +### Migrating data from a previous installation + +As all user data is kept under `data`, this is the only directory you need to worry about when migrating to a new installation, which corresponds to the following steps: + +- backup the `data` directory +- install or update Shaarli: + - fresh installation - see [[Download and installation]] + - update - see the following sections +- check or restore the `data` directory + +## Recommended : Upgrading from release archives + +All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. + +We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [[Download and installation]] for `git` complete instructions. + +Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! + +After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [[Shaarli configuration]] for more details). + +## Upgrading with Git + +### Updating a community Shaarli + +If you have installed Shaarli from the [community Git repository](Download#clone-with-git-recommended), simply [pull new changes](https://www.git-scm.com/docs/git-pull) from your local clone: + +```bash +$ cd /path/to/shaarli +$ git pull + +From github.com:shaarli/Shaarli + * branch master -> FETCH_HEAD +Updating ebd67c6..521f0e6 +Fast-forward + application/Url.php | 1 + + shaarli_version.php | 2 +- + tests/Url/UrlTest.php | 1 + + 3 files changed, 3 insertions(+), 1 deletion(-) +``` + +Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/): + +```bash +$ composer install --no-dev + +Loading composer repositories with package information +Updating dependencies + - Installing shaarli/netscape-bookmark-parser (v1.0.1) + Downloading: 100% +``` + +### Migrating and upgrading from Sebsauvage's repository + +If you have installed Shaarli from [Sebsauvage's original Git repository](https://github.com/sebsauvage/Shaarli), you can use [Git remotes](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) to update your working copy. + +The following guide assumes that: +- you have a basic knowledge of Git [branching](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) and [remote repositories](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) +- the default remote is named `origin` and points to Sebsauvage's repository +- the current branch is `master` + - if you have personal branches containing customizations, you will need to [rebase them](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) after the upgrade; beware though, a lot of changes have been made since the community fork has been created, so things are very likely to break! +- the working copy is clean: + - no versioned file has been locally modified + - no untracked files are present + +#### Step 0: show repository information + +```bash +$ cd /path/to/shaarli + +$ git remote -v +origin https://github.com/sebsauvage/Shaarli (fetch) +origin https://github.com/sebsauvage/Shaarli (push) + +$ git branch -vv +* master 029f75f [origin/master] Update README.md + +$ git status +On branch master +Your branch is up-to-date with 'origin/master'. +nothing to commit, working directory clean +``` + +#### Step 1: update Git remotes + +``` +$ git remote rename origin sebsauvage +$ git remote -v +sebsauvage https://github.com/sebsauvage/Shaarli (fetch) +sebsauvage https://github.com/sebsauvage/Shaarli (push) + +$ git remote add origin https://github.com/shaarli/Shaarli +$ git fetch origin + +remote: Counting objects: 3015, done. +remote: Compressing objects: 100% (19/19), done. +remote: Total 3015 (delta 446), reused 457 (delta 446), pack-reused 2550 +Receiving objects: 100% (3015/3015), 2.59 MiB | 918.00 KiB/s, done. +Resolving deltas: 100% (1899/1899), completed with 48 local objects. +From https://github.com/shaarli/Shaarli + * [new branch] master -> origin/master + * [new branch] stable -> origin/stable +[...] + * [new tag] v0.6.4 -> v0.6.4 + * [new tag] v0.7.0 -> v0.7.0 +``` + +#### Step 2: use the stable community branch + +```bash +$ git checkout origin/stable -b stable +Branch stable set up to track remote branch stable from origin. +Switched to a new branch 'stable' + +$ git branch -vv + master 029f75f [sebsauvage/master] Update README.md +* stable 890afc3 [origin/stable] Merge pull request #509 from ArthurHoaro/v0.6.5 +``` + +Shaarli >= `v0.8.x`: install/update third-party PHP dependencies using [Composer](https://getcomposer.org/): + +```bash +$ composer install --no-dev + +Loading composer repositories with package information +Updating dependencies + - Installing shaarli/netscape-bookmark-parser (v1.0.1) + Downloading: 100% +``` + +Optionally, you can delete information related to the legacy version: + +```bash +$ git branch -D master +Deleted branch master (was 029f75f). + +$ git remote remove sebsauvage + +$ git remote -v +origin https://github.com/shaarli/Shaarli (fetch) +origin https://github.com/shaarli/Shaarli (push) + +$ git gc +Counting objects: 3317, done. +Delta compression using up to 8 threads. +Compressing objects: 100% (1237/1237), done. +Writing objects: 100% (3317/3317), done. +Total 3317 (delta 2050), reused 3301 (delta 2034)to +``` + +#### Step 3: configuration + +After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [[Shaarli configuration]] for more details). + +## Troubleshooting + +If the solutions provided here doesn't work, please open an issue specifying which version you're upgrading from and to. + +### You must specify an integer as a key + +In `v0.8.1` we changed how link keys are handled (from timestamps to incremental integers). +Take a look at `data/updates.txt` content. + +#### `updates.txt` contains `updateMethodDatastoreIds` + +Try to delete it and refresh your page while being logged in. + +#### `updates.txt` doesn't exists or doesn't contain `updateMethodDatastoreIds` + + 1. Create `data/updates.txt` if it doesn't exist. + 2. Paste this string in the update file `;updateMethodRenameDashTags;` + 3. Login to Shaarli. + 4. Delete the update file. + 5. Refresh. diff --git a/doc/md/Versioning-and-Branches.md b/doc/md/Versioning-and-Branches.md new file mode 100644 index 00000000..e1d998e0 --- /dev/null +++ b/doc/md/Versioning-and-Branches.md @@ -0,0 +1,75 @@ +**WORK IN PROGRESS** + +It's important to understand how Shaarli branches work, especially if you're maintaining a 3rd party tools for Shaarli (theme, plugin, etc.), to be sure stay compatible. + +## `master` branch + +The `master` branch is the development branch. Any new change MUST go through this branch using Pull Requests. + +Remarks: + + * This branch shouldn't be used for production as it isn't necessary stable. + * 3rd party aren't required to be compatible with the latest changes. + * Official plugins, themes and libraries (contained within Shaarli organization repos) must be compatible with the master branch. + * The version in this branch is always `dev`. + +## `v0.x` branch + +This `v0.x` branch, points to the latest `v0.x.y` release. + +Explanation: + +When a new version is released, it might contains a major bug which isn't detected right away. For example, a new PHP version is released, containing backward compatibility issue which doesn't work with Shaarli. + +In this case, the issue is fixed in the `master` branch, and the fix is backported the to the `v0.x` branch. Then a new release is made from the `v0.x` branch. + +This workflow allow us to fix any major bug detected, without having to release bleeding edge feature too soon. + +## `latest` branch + +This branch point the latest release. It recommended to use it to get the latest tested changes. + +## `stable` branch + +The `stable` branch doesn't contain any major bug, and is one major digit version behind the latest release. + +For example, the current latest release is `v0.8.3`, the stable branch is an alias to the latest `v0.7.x` release. When the `v0.9.0` version will be released, the stable will move to the latest `v0.8.x` release. + +Remarks: + + * Shaarli release pace isn't fast, and the stable branch might be a few months behind the latest release. + +## Releases + +Releases are always made from the latest `v0.x` branch. + +Note that for every release, we manually generate a tarball which contains all Shaarli dependencies, making Shaarli's installation only one step. + +## Advices on 3rd party git repos workflow + +### Versioning + +Any time a new Shaarli release is published, you should publish a new release of your repo if the changes affected you since the latest release (take a look at the [changelog](https://github.com/shaarli/Shaarli/releases) (*Draft* means not released yet) and the commit log (like [`tpl` folder](https://github.com/shaarli/Shaarli/commits/master/tpl/default) for themes)). You can either: + + - use the Shaarli version number, with your repo version. For example, if Shaarli `v0.8.3` is released, publish a `v0.8.3-1` release, where `v0.8.3` states Shaarli compatibility and `-1` is your own version digit for the current Shaarli version. + - use your own versioning scheme, and state Shaarli compatibility in the release description. + +Using this, any user will be able to pick the release matching his own Shaarli version. + +### Major bugfix backport releases + +To be able to support backported fixes, it recommended to use our workflow: + +```bash +# In master, fix the major bug +git commit -m "Katastrophe" +git push origin master +# Get your commit hash +git log --format="%H" -n 1 +# Create a new branch from your latest release, let's say v0.8.2-1 (the tag name) +git checkout -b katastrophe v0.8.2-1 +# Backport the fix commit to your brand new branch +git cherry-pick +git push origin katastrophe +# Then you just have to make a new release from the `katastrophe` branch tagged `v0.8.3-1` +``` diff --git a/doc/md/_Footer.md b/doc/md/_Footer.md new file mode 100644 index 00000000..648b1298 --- /dev/null +++ b/doc/md/_Footer.md @@ -0,0 +1 @@ +_Shaarli, the personal, minimalist, super-fast, database-free bookmarking service_ \ No newline at end of file diff --git a/doc/md/_Sidebar.md b/doc/md/_Sidebar.md new file mode 100644 index 00000000..fe0e4229 --- /dev/null +++ b/doc/md/_Sidebar.md @@ -0,0 +1,45 @@ +- [[Home]] +- Setup + - [[Download and Installation]] + - [[Upgrade and migration]] + - [[Server requirements]] + - [[Server configuration]] + - [[Server security]] + - [[Shaarli configuration]] + - [[Plugins]] +- Docker + - [[Docker 101]] + - [[Shaarli images]] + - [[Reverse proxy configuration]] + - [[Docker resources]] +- Usage + - [[Features]] + - [[Bookmarklet]] + - [[Browsing and Searching]] + - [[Firefox share]] + - [[RSS feeds]] + - [[REST API]] +- How To + - [[Backup, restore, import and export]] + - [[Copy an existing installation over SSH and serve it locally]] + - [[Create and serve multiple Shaarlis (farm)]] + - [[Download CSS styles from an OPML list]] + - [[Datastore hacks]] +- [[Troubleshooting]] +- Development: + - [[Development guidelines]] + - [[Continuous integration tools]] + - [[GnuPG signature]] + - [[Coding guidelines]] + - [[Directory structure]] + - [[3rd party libraries]] + - [[Plugin System]] + - [[Release Shaarli]] + - [[Versioning and Branches]] + - [[Security]] + - [[Static analysis]] + - [[Theming]] + - [[Unit tests]] +- About + - [[FAQ]] + - [[Community & Related software]] diff --git a/doc/md/config.json b/doc/md/config.json new file mode 100644 index 00000000..cc4de307 --- /dev/null +++ b/doc/md/config.json @@ -0,0 +1,6 @@ +{ + "useSideMenu": true, + "lineBreaks": "gfm", + "additionalFooterText": "", + "title": "Shaarli documentation" +} \ No newline at end of file diff --git a/doc/md/github-markdown.css b/doc/md/github-markdown.css new file mode 100644 index 00000000..581350ae --- /dev/null +++ b/doc/md/github-markdown.css @@ -0,0 +1,287 @@ +#local-sidebar { + width: 230px; + float: right; + position: relative; + z-index: 4; + background-color: #fff; + border: 1px solid #e2e2e2; + border-radius: 3px; +} + +body { + font-family: Helvetica, arial, sans-serif; + font-size: 14px; + line-height: 1.6; + padding-top: 10px; + padding-bottom: 10px; + background-color: white; + padding: 10px 20%; } + +body > *:first-child { + margin-top: 0 !important; } +body > *:last-child { + margin-bottom: 0 !important; } + +a { + color: #4183C4; } +a.absent { + color: #cc0000; } +a.anchor { + display: block; + padding-left: 30px; + margin-left: -30px; + cursor: pointer; + position: absolute; + top: 0; + left: 0; + bottom: 0; } + +h1, h2, h3, h4, h5, h6 { + margin: 20px 0 10px; + padding: 0; + font-weight: bold; + -webkit-font-smoothing: antialiased; + cursor: text; + position: relative; } + +h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor { + background: url("../../images/modules/styleguide/para.png") no-repeat 10px center; + text-decoration: none; } + +h1 tt, h1 code { + font-size: inherit; } + +h2 tt, h2 code { + font-size: inherit; } + +h3 tt, h3 code { + font-size: inherit; } + +h4 tt, h4 code { + font-size: inherit; } + +h5 tt, h5 code { + font-size: inherit; } + +h6 tt, h6 code { + font-size: inherit; } + +h1 { + font-size: 28px; + color: black; } + +h2 { + font-size: 24px; + border-bottom: 1px solid #cccccc; + color: black; } + +h3 { + font-size: 18px; } + +h4 { + font-size: 16px; } + +h5 { + font-size: 14px; } + +h6 { + color: #777777; + font-size: 14px; } + +p, blockquote, ol, dl, table, pre { + margin: 15px 0; } + +hr { + background: transparent url("../../images/modules/pulls/dirty-shade.png") repeat-x 0 0; + border: 0 none; + color: #cccccc; + height: 4px; + padding: 0; } + +body > h2:first-child { + margin-top: 0; + padding-top: 0; } +body > h1:first-child { + margin-top: 0; + padding-top: 0; } + body > h1:first-child + h2 { + margin-top: 0; + padding-top: 0; } +body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child { + margin-top: 0; + padding-top: 0; } + +a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 { + margin-top: 0; + padding-top: 0; } + +h1 p, h2 p, h3 p, h4 p, h5 p, h6 p { + margin-top: 0; } + +li p.first { + display: inline-block; } + +ul, ol { + padding-left: 30px; } + +ul :first-child, ol :first-child { + margin-top: 0; } + +ul :last-child, ol :last-child { + margin-bottom: 0; } + +dl { + padding: 0; } + dl dt { + font-size: 14px; + font-weight: bold; + font-style: italic; + padding: 0; + margin: 15px 0 5px; } + dl dt:first-child { + padding: 0; } + dl dt > :first-child { + margin-top: 0; } + dl dt > :last-child { + margin-bottom: 0; } + dl dd { + margin: 0 0 15px; + padding: 0 15px; } + dl dd > :first-child { + margin-top: 0; } + dl dd > :last-child { + margin-bottom: 0; } + +blockquote { + border-left: 4px solid #dddddd; + padding: 0 15px; + color: #777777; } + blockquote > :first-child { + margin-top: 0; } + blockquote > :last-child { + margin-bottom: 0; } + +table { + padding: 0; } + table tr { + border-top: 1px solid #cccccc; + background-color: white; + margin: 0; + padding: 0; } + table tr:nth-child(2n) { + background-color: #f8f8f8; } + table tr th { + font-weight: bold; + border: 1px solid #cccccc; + text-align: left; + margin: 0; + padding: 6px 13px; } + table tr td { + border: 1px solid #cccccc; + text-align: left; + margin: 0; + padding: 6px 13px; } + table tr th :first-child, table tr td :first-child { + margin-top: 0; } + table tr th :last-child, table tr td :last-child { + margin-bottom: 0; } + +img { + max-width: 100%; } + +span.frame { + display: block; + overflow: hidden; } + span.frame > span { + border: 1px solid #dddddd; + display: block; + float: left; + overflow: hidden; + margin: 13px 0 0; + padding: 7px; + width: auto; } + span.frame span img { + display: block; + float: left; } + span.frame span span { + clear: both; + color: #333333; + display: block; + padding: 5px 0 0; } +span.align-center { + display: block; + overflow: hidden; + clear: both; } + span.align-center > span { + display: block; + overflow: hidden; + margin: 13px auto 0; + text-align: center; } + span.align-center span img { + margin: 0 auto; + text-align: center; } +span.align-right { + display: block; + overflow: hidden; + clear: both; } + span.align-right > span { + display: block; + overflow: hidden; + margin: 13px 0 0; + text-align: right; } + span.align-right span img { + margin: 0; + text-align: right; } +span.float-left { + display: block; + margin-right: 13px; + overflow: hidden; + float: left; } + span.float-left span { + margin: 13px 0 0; } +span.float-right { + display: block; + margin-left: 13px; + overflow: hidden; + float: right; } + span.float-right > span { + display: block; + overflow: hidden; + margin: 13px auto 0; + text-align: right; } + +code, tt { + margin: 0 2px; + padding: 0 5px; + white-space: nowrap; + border: 1px solid #eaeaea; + background-color: #f8f8f8; + border-radius: 3px; } + +pre code { + margin: 0; + padding: 0; + white-space: pre; + border: none; + background: transparent; } + +.highlight pre { + background-color: #f8f8f8; + border: 1px solid #cccccc; + font-size: 13px; + line-height: 19px; + overflow: auto; + padding: 6px 10px; + border-radius: 3px; } + +pre { + background-color: #f8f8f8; + border: 1px solid #cccccc; + font-size: 13px; + line-height: 19px; + overflow: auto; + padding: 6px 10px; + border-radius: 3px; } + pre code, pre tt { + background-color: transparent; + border: none; } diff --git a/doc/md/images/bookmarklet.png b/doc/md/images/bookmarklet.png new file mode 100644 index 00000000..0262578e Binary files /dev/null and b/doc/md/images/bookmarklet.png differ diff --git a/doc/md/images/doc-logo.png b/doc/md/images/doc-logo.png new file mode 100644 index 00000000..3d8d1787 Binary files /dev/null and b/doc/md/images/doc-logo.png differ diff --git a/doc/md/images/doc-logo.svg b/doc/md/images/doc-logo.svg new file mode 100644 index 00000000..37fc6658 --- /dev/null +++ b/doc/md/images/doc-logo.svg @@ -0,0 +1,522 @@ + + + Shaarli Logo + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + Shaarli Logo + + + http://blog.idleman.fr/ + + + 2012-08-29 22:36:01+02:00 + + + http://sebsauvage.net/ + + + + + Shaarli + Logo + + + + + http://thatguynamedandy.com/, +http://mro.name/me + + + + http://sebsauvage.net/files/shaarli_logo.zip + http://sebsauvage.net/wiki/doku.php?id=php:shaarli:discussion#comment_09a1e91bc0abc7db6d186a6abf429877 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/md/images/firefoxshare.png b/doc/md/images/firefoxshare.png new file mode 100644 index 00000000..98c2fdd3 Binary files /dev/null and b/doc/md/images/firefoxshare.png differ diff --git a/doc/md/images/rss-filter-1.png b/doc/md/images/rss-filter-1.png new file mode 100644 index 00000000..d2a03f67 Binary files /dev/null and b/doc/md/images/rss-filter-1.png differ diff --git a/doc/md/images/rss-filter-2.png b/doc/md/images/rss-filter-2.png new file mode 100644 index 00000000..538b126e Binary files /dev/null and b/doc/md/images/rss-filter-2.png differ diff --git a/doc/md/index.md b/doc/md/index.md new file mode 100644 index 00000000..37a9c1fc --- /dev/null +++ b/doc/md/index.md @@ -0,0 +1,11 @@ +Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki! + +Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. + +For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). + +If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). + +If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin). + +_Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ -- cgit v1.2.3 From 460ce50115e5f5a1183c3c410fd76636ee5c4716 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:29:15 +0200 Subject: doc: rename "datastore hacks" -> "various hacks", move example scripts to gist.github.com, remove obsolete GH wiki _Sidebar.md --- ...g-installation-over-SSH-and-serve-it-locally.md | 66 ------- .../Create-and-serve-multiple-Shaarlis-(farm).md | 57 ------- doc/md/Datastore-hacks.md | 25 --- doc/md/Download-CSS-styles-from-an-OPML-list.md | 154 ----------------- .../Example-patch---add-new-via-field-for-links.md | 189 --------------------- doc/md/Various-hacks.md | 33 ++++ doc/md/_Sidebar.md | 45 ----- 7 files changed, 33 insertions(+), 536 deletions(-) delete mode 100644 doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md delete mode 100644 doc/md/Create-and-serve-multiple-Shaarlis-(farm).md delete mode 100644 doc/md/Datastore-hacks.md delete mode 100644 doc/md/Download-CSS-styles-from-an-OPML-list.md delete mode 100644 doc/md/Example-patch---add-new-via-field-for-links.md create mode 100644 doc/md/Various-hacks.md delete mode 100644 doc/md/_Sidebar.md (limited to 'doc/md') diff --git a/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md b/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md deleted file mode 100644 index 7583c9ea..00000000 --- a/doc/md/Copy-an-existing-installation-over-SSH-and-serve-it-locally.md +++ /dev/null @@ -1,66 +0,0 @@ -Example bash script: - -```bash -#!/bin/bash -#Description: Copy a Shaarli installation over SSH/SCP, serve it locally with php-cli -#Will create a local-shaarli/ directory when you run it, backup your Shaarli there, and serve it locally. -#Will NOT download linked pages. It's just a directly usable backup/copy/mirror of your Shaarli -#Requires: ssh, scp and a working SSH access to the server where your Shaarli is installed -#Usage: ./local-shaarli.sh -#Author: nodiscc (nodiscc@gmail.com) -#License: MIT (http://opensource.org/licenses/MIT) -set -o errexit -set -o nounset - -##### CONFIG ################# -#The port used by php's local server -php_local_port=7431 - -#Name of the SSH server and path where Shaarli is installed -#TODO: pass these as command-line arguments -remotehost="my.ssh.server" -remote_shaarli_dir="/var/www/shaarli" - - -###### FUNCTIONS ############# -_main() { - _CBSyncShaarli - _CBServeShaarli -} - -_CBSyncShaarli() { - remote_temp_dir=$(ssh $remotehost mktemp -d) - remote_ssh_user=$(ssh $remotehost whoami) - ssh -t "$remotehost" sudo cp -r "$remote_shaarli_dir" "$remote_temp_dir" - ssh -t "$remotehost" sudo chown -R "$remote_ssh_user":"$remote_ssh_user" "$remote_temp_dir" - scp -rq "$remotehost":"$remote_temp_dir" local-shaarli - ssh "$remotehost" rm -r "$remote_temp_dir" -} - -_CBServeShaarli() { - #TODO: allow serving a previously downloaded Shaarli - #TODO: ask before overwriting local copy, if it exists - cd local-shaarli/ - php -S localhost:${php_local_port} - echo "Please go to http://localhost:${php_local_port}" -} - - -##### MAIN ################# - -_main -``` - -This outputs: - -```bash -$ ./local-shaarli.sh -PHP 5.6.0RC4 Development Server started at Mon Sep 1 21:56:19 2014 -Listening on http://localhost:7431 -Document root is /home/user/local-shaarli/shaarli -Press Ctrl-C to quit. - -[Mon Sep 1 21:56:27 2014] ::1:57868 [200]: / -[Mon Sep 1 21:56:27 2014] ::1:57869 [200]: /index.html -[Mon Sep 1 21:56:37 2014] ::1:57881 [200]: /... -``` diff --git a/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md b/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md deleted file mode 100644 index d0d812a3..00000000 --- a/doc/md/Create-and-serve-multiple-Shaarlis-(farm).md +++ /dev/null @@ -1,57 +0,0 @@ -Example bash script (creates multiple shaarli instances and generates an HTML index of them) - -```bash -#!/bin/bash -set -o errexit -set -o nounset - -#config -shaarli_base_dir='/var/www/shaarli' -accounts='bob john whatever username' -shaarli_repo_url='https://github.com/shaarli/Shaarli' -ref="master" - -#clone multiple shaarli instances -if [ ! -d "$shaarli_base_dir" ]; then mkdir "$shaarli_base_dir"; fi - -for account in $accounts; do - if [ -d "$shaarli_base_dir/$account" ]; - then echo "[info] account $account already exists, skipping"; - else echo "[info] creating new account $account ..."; git clone --quiet "$shaarli_repo_url" -b "$ref" "$shaarli_base_dir/$account"; fi -done - -#generate html index of shaarlis -htmlhead=' - - - - - My Shaarli farm - - - -
    -

    My Shaarli farm

    -
      ' - -accountlinks='' - -htmlfooter=' -
    -
    - -' - - - -for account in $accounts; do accountlinks="$accountlinks\n
  • $account
    • "; done -if [ -d "$shaarli_base_dir/index.html" ]; then echo "[removing old index.html]"; rm "$shaarli_base_dir/index.html" ]; fi -echo "[info] generating new index of shaarlis" -echo -e "$htmlhead $accountlinks $htmlfooter" > "$shaarli_base_dir/index.html" -echo '[info] done.' -echo "[info] list of accounts: $accounts" -echo "[info] contents of $shaarli_base_dir:" -tree -a -L 1 "$shaarli_base_dir" -``` - -This script just serves as an example. More precise or complex (applying custom configuration, etc) automation is possible using configuration management software like [Ansible](https://www.ansible.com/) \ No newline at end of file diff --git a/doc/md/Datastore-hacks.md b/doc/md/Datastore-hacks.md deleted file mode 100644 index 78baa005..00000000 --- a/doc/md/Datastore-hacks.md +++ /dev/null @@ -1,25 +0,0 @@ -### Decode datastore content - -To display the array representing the data saved in `data/datastore.php`, use the following snippet: - -```php -$data = "tZNdb9MwFIb... "; -$out = unserialize(gzinflate(base64_decode($data))); -echo "
    "; // Pretty printing is love, pretty printing is life
-print_r($out);
-echo "
    "; -exit; -``` -This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). - -Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed): -``` -php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . -``` - -### Changing the timestamp for a link - -* Look for `` in `tpl/editlink.tpl` (line 14) -* Replace `type="hidden"` with `type="text"` from this line -* A new date/time field becomes available in the edit/new link dialog. -* You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. diff --git a/doc/md/Download-CSS-styles-from-an-OPML-list.md b/doc/md/Download-CSS-styles-from-an-OPML-list.md deleted file mode 100644 index 26b7fb3e..00000000 --- a/doc/md/Download-CSS-styles-from-an-OPML-list.md +++ /dev/null @@ -1,154 +0,0 @@ -###Download CSS styles for shaarlis listed in an opml file -Example php script: - -```php - - - - -/** - * Source: https://github.com/Riduidel - * Download css styles for shaarlis listed in an opml file - */ -define("SHAARLI_RSS_OPML", "https://www.ecirtam.net/shaarlirss/custom/people.opml"); - -define("THEMES_TEMP_FOLDER", "new_themes"); - -if(!file_exists(THEMES_TEMP_FOLDER)) { - mkdir(THEMES_TEMP_FOLDER); -} - -function siteUrl($pathInSite) { - $indexPos = strpos($pathInSite, "index.php"); - if(!$indexPos) { - return $pathInSite; - } else { - return substr($pathInSite, 0, $indexPos); - } -} - -function createShaarliHashFromOPMLL($opmlFile) { - $result = array(); - $opml = file_get_contents($opmlFile); - $opmlXml = simplexml_load_string($opml); - $outlineElements = $opmlXml->xpath("body/outline"); - foreach($outlineElements as $site) { - $siteUrl = siteUrl((string) $site['htmlUrl']); - $result[$siteUrl]=((string) $site['text']); - } - return $result; -} - -function getSiteFolder($url) { - $domain = parse_url($url, PHP_URL_HOST); - return THEMES_TEMP_FOLDER."/".str_replace(".", "_", $domain); -} - -function get_http_response_code($theURL) { - $headers = get_headers($theURL); - return substr($headers[0], 9, 3); -} - -/** - * This makes the code PHP-5 only (particularly the call to "get_headers") - */ -function copyUserStyleFrom($url, $name, $knownStyles) { - $userStyle = $url."inc/user.css"; - if(in_array($url, $knownStyles)) { - // TODO add log message - } else { - $statusCode = get_http_response_code($userStyle); - if(intval($statusCode)<300) { - $styleSheet = file_get_contents($userStyle); - $siteFolder = getSiteFolder($url); - if(!file_exists($siteFolder)) { - mkdir($siteFolder); - } - if(!file_exists($siteFolder.'/user.css')) { - // Copy stylesheet - file_put_contents($siteFolder.'/user.css', $styleSheet); - } - if(!file_exists($siteFolder.'/README.md')) { - // Then write a readme.md file - file_put_contents($siteFolder.'/README.md', - "User style from ".$name."\n" - ."=============================" - ."\n\n" - ."This stylesheet was downloaded from ".$userStyle." on ".date(DATE_RFC822) - ); - } - if(!file_exists($siteFolder.'/config.ini')) { - // Write a config file containing useful informations - file_put_contents($siteFolder.'/config.ini', - "site_url=".$url."\n" - ."site_name=".$name."\n" - ); - } - if(!file_exists($siteFolder.'/home.png')) { - // And finally copy generated thumbnail - $homeThumb = $siteFolder.'/home.png'; - file_put_contents($siteFolder.'/home.png', file_get_contents(getThumbnailUrl($url))); - } - echo 'Theme have been downloaded from '.$url.' into '.$siteFolder - .'. It looks like
    '; - } - } -} - -function getThumbnailUrl($url) { - return 'http://api.webthumbnail.org/?url='.$url; -} - -function copyUserStylesFrom($urlToNames, $knownStyles) { - foreach($urlToNames as $url => $name) { - copyUserStyleFrom($url, $name, $knownStyles); - } -} - -/** - * Reading directory list, courtesy of http://www.laughing-buddha.net/php/dirlist/ - * @param directory the directory we want to list files of - * @return a simple array containing the list of absolute file paths. Notice that current file (".") and parent one("..") - * are not listed here - */ -function getDirectoryList ($directory) { - $realPath = realpath($directory); - // create an array to hold directory list - $results = array(); - // create a handler for the directory - $handler = opendir($directory); - // open directory and walk through the filenames - while ($file = readdir($handler)) { - // if file isn't this directory or its parent, add it to the results - if ($file != "." && $file != "..") { - $results[] = realpath($realPath . "/" . $file); - } - } - // tidy up: close the handler - closedir($handler); - // done! - return $results; -} - -/** - * Start in themes folder and look in all subfolders for config.ini files. - * These config.ini files allow us not to download styles again and again - */ -function findKnownStyles() { - $result = array(); - $subFolders = getDirectoryList("themes"); - foreach($subFolders as $folder) { - $configFile = $folder."/config.ini"; - if(file_exists($configFile)) { - $iniParameters = parse_ini_file($configFile); - array_push($result, $iniParameters['site_url']); - } - } - return $result; -} - -$knownStyles = findKnownStyles(); -copyUserStylesFrom(createShaarliHashFromOPMLL(SHAARLI_RSS_OPML), $knownStyles); - - -``` \ No newline at end of file diff --git a/doc/md/Example-patch---add-new-via-field-for-links.md b/doc/md/Example-patch---add-new-via-field-for-links.md deleted file mode 100644 index d84ef25a..00000000 --- a/doc/md/Example-patch---add-new-via-field-for-links.md +++ /dev/null @@ -1,189 +0,0 @@ -Example patch to add a new field ("via") for links, an input field to set the "via" property from the "edit link" dialog, and display the "via" field in the link list display. **Untested, use at your own risk** - -Thanks to @Knah-Tsaeb in https://github.com/sebsauvage/Shaarli/pull/158 - -``` -From e0f363c18e8fe67990ed2bb1a08652e24e70bbcb Mon Sep 17 00:00:00 2001 -From: Knah Tsaeb -Date: Fri, 11 Oct 2013 15:18:37 +0200 -Subject: [PATCH] Add a "via"/origin property for links, add new input in "edit link" dialog -Thanks to: -* https://github.com/Knah-Tsaeb/Shaarli/commit/040eb18ec8cdabd5ea855e108f81f97fbf0478c4 -* https://github.com/Knah-Tsaeb/Shaarli/commit/4123658eae44d7564d1128ce52ddd5689efee813 -* https://github.com/Knah-Tsaeb/Shaarli/commit/f1a8ca9cc8fe49b119d51b2d8382cc1a34542f96 - ---- - index.php | 43 ++++++++++++++++++++++++++++++++----------- - tpl/editlink.html | 1 + - tpl/linklist.html | 1 + - 3 files changed, 34 insertions(+), 11 deletions(-) - -diff --git a/index.php b/index.php -index 6fae2f8..53f798e 100644 ---- a/index.php -+++ b/index.php -@@ -436,6 +436,12 @@ if (isset($_POST['login'])) - // ------------------------------------------------------------------------------------------ - // Misc utility functions: - -+// Try to get just domain for @via -+function getJustDomain($url){ -+ $parts = parse_url($url); -+ return trim($parts['host']); -+ } -+ - // Returns the server URL (including port and http/https), without path. - // e.g. "http://myserver.com:8080" - // You can append $_SERVER['SCRIPT_NAME'] to get the current script URL. -@@ -799,7 +805,8 @@ class linkdb implements Iterator, Countable, ArrayAccess - $found= (strpos(strtolower($l['title']),$s)!==false) - || (strpos(strtolower($l['description']),$s)!==false) - || (strpos(strtolower($l['url']),$s)!==false) -- || (strpos(strtolower($l['tags']),$s)!==false); -+ || (strpos(strtolower($l['tags']),$s)!==false) -+ || (!empty($l['via']) && (strpos(strtolower($l['via']),$s)!==false)); - if ($found) $filtered[$l['linkdate']] = $l; - } - krsort($filtered); -@@ -814,7 +821,7 @@ class linkdb implements Iterator, Countable, ArrayAccess - $t = str_replace(',',' ',($casesensitive?$tags:strtolower($tags))); - $searchtags=explode(' ',$t); - $filtered=array(); -- foreach($this->links as $l) -+ foreach($this-> links as $l) - { - $linktags = explode(' ',($casesensitive?$l['tags']:strtolower($l['tags']))); - if (count(array_intersect($linktags,$searchtags)) == count($searchtags)) -@@ -905,7 +912,7 @@ function showRSS() - else $linksToDisplay = $LINKSDB; - $nblinksToDisplay = 50; // Number of links to display. - if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links. -- { -+ { - $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ; - } - -@@ -944,7 +951,12 @@ function showRSS() - // If user wants permalinks first, put the final link in description - if ($usepermalinks===true) $descriptionlink = '(Link)'; - if (strlen($link['description'])>0) $descriptionlink = '
    '.$descriptionlink; -- echo ''."\n\n"; -+ if(!empty($link['via'])){ -+ $via = '
    Origine => '.htmlspecialchars(getJustDomain($link['via'])).''; -+ } else { -+ $via = ''; -+ } -+ echo ''."\n\n"; - $i++; - } - echo ''; -@@ -980,7 +992,7 @@ function showATOM() - else $linksToDisplay = $LINKSDB; - $nblinksToDisplay = 50; // Number of links to display. - if (!empty($_GET['nb'])) // In URL, you can specificy the number of links. Example: nb=200 or nb=all for all links. -- { -+ { - $nblinksToDisplay = $_GET['nb']=='all' ? count($linksToDisplay) : max($_GET['nb']+0,1) ; - } - -@@ -1006,11 +1018,16 @@ function showATOM() - - // Add permalink in description - $descriptionlink = htmlspecialchars('(Permalink)'); -+ if(isset($link['via']) && !empty($link['via'])){ -+ $via = htmlspecialchars('
    Origine => '.getJustDomain($link['via']).''); -+ } else { -+ $via = ''; -+ } - // If user wants permalinks first, put the final link in description - if ($usepermalinks===true) $descriptionlink = htmlspecialchars('(Link)'); - if (strlen($link['description'])>0) $descriptionlink = '<br>'.$descriptionlink; - -- $entries.=''.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink."\n"; -+ $entries.=''.htmlspecialchars(nl2br(keepMultipleSpaces(text2clickable(htmlspecialchars($link['description']))))).$descriptionlink.$via."\n"; - if ($link['tags']!='') // Adding tags to each ATOM entry (as mentioned in ATOM specification) - { - foreach(explode(' ',$link['tags']) as $tag) -@@ -1478,7 +1495,7 @@ function renderPage() - if (!startsWith($url,'http:') && !startsWith($url,'https:') && !startsWith($url,'ftp:') && !startsWith($url,'magnet:') && !startsWith($url,'?')) - $url = 'http://'.$url; - $link = array('title'=>trim($_POST['lf_title']),'url'=>$url,'description'=>trim($_POST['lf_description']),'private'=>(isset($_POST['lf_private']) ? 1 : 0), -- 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags)); -+ 'linkdate'=>$linkdate,'tags'=>str_replace(',',' ',$tags), 'via'=>trim($_POST['lf_via'])); - if ($link['title']=='') $link['title']=$link['url']; // If title is empty, use the URL as title. - $LINKSDB[$linkdate] = $link; - $LINKSDB->savedb(); // Save to disk. -@@ -1556,7 +1573,8 @@ function renderPage() - $title = (empty($_GET['title']) ? '' : $_GET['title'] ); // Get title if it was provided in URL (by the bookmarklet). - $description = (empty($_GET['description']) ? '' : $_GET['description']); // Get description if it was provided in URL (by the bookmarklet). [Bronco added that] - $tags = (empty($_GET['tags']) ? '' : $_GET['tags'] ); // Get tags if it was provided in URL -- $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL -+ $via = (empty($_GET['via']) ? '' : $_GET['via'] ); -+ $private = (!empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0); // Get private if it was provided in URL - if (($url!='') && parse_url($url,PHP_URL_SCHEME)=='') $url = 'http://'.$url; - // If this is an HTTP link, we try go get the page to extract the title (otherwise we will to straight to the edit form.) - if (empty($title) && parse_url($url,PHP_URL_SCHEME)=='http') -@@ -1567,7 +1585,7 @@ function renderPage() - { - // Look for charset in html header. - preg_match('##Usi', $data, $meta); -- -+ - // If found, extract encoding. - if (!empty($meta[0])) - { -@@ -1577,7 +1595,7 @@ function renderPage() - $html_charset = (!empty($enc[1])) ? strtolower($enc[1]) : 'utf-8'; - } - else { $html_charset = 'utf-8'; } -- -+ - // Extract title - $title = html_extract_title($data); - if (!empty($title)) -@@ -1592,7 +1610,7 @@ function renderPage() - $url='?'.smallHash($linkdate); - $title='Note: '; - } -- $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'private'=>$private); -+ $link = array('linkdate'=>$linkdate,'title'=>$title,'url'=>$url,'description'=>$description,'tags'=>$tags,'via' => $via,'private'=>$private); - } - - $PAGE = new pageBuilder; -@@ -1842,6 +1860,9 @@ function buildLinkList($PAGE,$LINKSDB) - $taglist = explode(' ',$link['tags']); - uasort($taglist, 'strcasecmp'); - $link['taglist']=$taglist; -+ if(!empty($link['via'])){ -+ $link['via']=htmlspecialchars($link['via']); -+ } - $linkDisp[$keys[$i]] = $link; - $i++; - } -diff --git a/tpl/editlink.html b/tpl/editlink.html -index 4a2c30c..14d4f9c 100644 ---- a/tpl/editlink.html -+++ b/tpl/editlink.html -@@ -16,6 +16,7 @@ - Title

    - Description

    - Tags

    -+ Origine

    - {if condition="($link_is_new && $GLOBALS['privateLinkByDefault']==true) || $link.private == true"} - -  
    -diff --git a/tpl/linklist.html b/tpl/linklist.html -index ddc38cb..0a8475f 100644 ---- a/tpl/linklist.html -+++ b/tpl/linklist.html -@@ -43,6 +43,7 @@ - {$value.title|htmlspecialchars} -
    - {if="$value.description"}
    {$value.description}
    {/if} -+ {if condition="isset($value.via) && !empty($value.via)"}{/if} - {if="!$GLOBALS['config']['HIDE_TIMESTAMPS'] || isLoggedIn()"} - {$value.localdate|htmlspecialchars} - permalink - - {else} --- -2.1.1 -``` \ No newline at end of file diff --git a/doc/md/Various-hacks.md b/doc/md/Various-hacks.md new file mode 100644 index 00000000..a4ae81f4 --- /dev/null +++ b/doc/md/Various-hacks.md @@ -0,0 +1,33 @@ +### Decode datastore content + +To display the array representing the data saved in `data/datastore.php`, use the following snippet: + +```php +$data = "tZNdb9MwFIb... "; +$out = unserialize(gzinflate(base64_decode($data))); +echo "
    "; // Pretty printing is love, pretty printing is life
+print_r($out);
+echo "
    "; +exit; +``` +This will output the internal representation of the datastore, "unobfuscated" (if this can really be considered obfuscation). + +Alternatively, you can transform to JSON format (and pretty-print if you have `jq` installed): +``` +php -r 'print(json_encode(unserialize(gzinflate(base64_decode(preg_replace("!.*/\* (.+) \*/.*!", "$1", file_get_contents("data/datastore.php")))))));' | jq . +``` + +### Changing the timestamp for a shaare + +* Look for `` in `tpl/editlink.tpl` (line 14) +* Replace `type="hidden"` with `type="text"` from this line +* A new date/time field becomes available in the edit/new link dialog. +* You can set the timestamp manually by entering it in the format `YYYMMDD_HHMMS`. + + +### See also + + * [Add a new custom field to shaares (example patch)](https://gist.github.com/nodiscc/8b0194921f059d7b9ad89a581ecd482c) + * [Download CSS styles for shaarlis listed in an opml file](https://gist.github.com/nodiscc/dede231c92cab22c3ad2cc24d5035012) + * [Copy an existing Shaarli installation over SSH, and serve it locally](https://gist.github.com/nodiscc/ed161c66e5b028b5299b0a3733d01c77) + * [Create multiple Shaarli instances, generate an HTML index of them](https://gist.github.com/nodiscc/52e711cda3bc47717c16065231cf6b20) \ No newline at end of file diff --git a/doc/md/_Sidebar.md b/doc/md/_Sidebar.md deleted file mode 100644 index fe0e4229..00000000 --- a/doc/md/_Sidebar.md +++ /dev/null @@ -1,45 +0,0 @@ -- [[Home]] -- Setup - - [[Download and Installation]] - - [[Upgrade and migration]] - - [[Server requirements]] - - [[Server configuration]] - - [[Server security]] - - [[Shaarli configuration]] - - [[Plugins]] -- Docker - - [[Docker 101]] - - [[Shaarli images]] - - [[Reverse proxy configuration]] - - [[Docker resources]] -- Usage - - [[Features]] - - [[Bookmarklet]] - - [[Browsing and Searching]] - - [[Firefox share]] - - [[RSS feeds]] - - [[REST API]] -- How To - - [[Backup, restore, import and export]] - - [[Copy an existing installation over SSH and serve it locally]] - - [[Create and serve multiple Shaarlis (farm)]] - - [[Download CSS styles from an OPML list]] - - [[Datastore hacks]] -- [[Troubleshooting]] -- Development: - - [[Development guidelines]] - - [[Continuous integration tools]] - - [[GnuPG signature]] - - [[Coding guidelines]] - - [[Directory structure]] - - [[3rd party libraries]] - - [[Plugin System]] - - [[Release Shaarli]] - - [[Versioning and Branches]] - - [[Security]] - - [[Static analysis]] - - [[Theming]] - - [[Unit tests]] -- About - - [[FAQ]] - - [[Community & Related software]] -- cgit v1.2.3 From 0433c688b9be6097b85a8fec31b3dacd0ab81677 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 06:32:30 +0200 Subject: make htmlpages --- doc/md/Browsing-and-searching.md | 2 +- doc/md/Community-&-Related-software.md | 2 +- doc/md/Continuous-integration-tools.md | 8 ++++---- doc/md/Development-guidelines.md | 6 +++--- doc/md/Firefox-share.md | 2 +- doc/md/GnuPG-signature.md | 2 +- doc/md/Theming.md | 4 ++-- doc/md/Upgrade-and-migration.md | 10 +++++----- 8 files changed, 18 insertions(+), 18 deletions(-) (limited to 'doc/md') diff --git a/doc/md/Browsing-and-searching.md b/doc/md/Browsing-and-searching.md index ad62c2f0..35707482 100644 --- a/doc/md/Browsing-and-searching.md +++ b/doc/md/Browsing-and-searching.md @@ -20,4 +20,4 @@ To search for links that are not tagged, enter `""` in the tag search field. ## Filtering RSS feeds/Picture wall -RSS feeds can also be restricted to only return items matching a text/tag search: see [[RSS feeds]]. +RSS feeds can also be restricted to only return items matching a text/tag search: see [RSS feeds](RSS feeds). diff --git a/doc/md/Community-&-Related-software.md b/doc/md/Community-&-Related-software.md index 6ff7ed45..b8b7cccd 100644 --- a/doc/md/Community-&-Related-software.md +++ b/doc/md/Community-&-Related-software.md @@ -34,7 +34,7 @@ _TODO: contact repos owners to see if they'd like to standardize their work with ### Themes -See [[Theming]] for the list of community-contributed themes, and an installation guide. +See [Theming](Theming) for the list of community-contributed themes, and an installation guide. ### Server apps - [shaarchiver](https://github.com/nodiscc/shaarchiver) - Archive your Shaarli bookmarks and their content diff --git a/doc/md/Continuous-integration-tools.md b/doc/md/Continuous-integration-tools.md index 30dc474d..849257f7 100644 --- a/doc/md/Continuous-integration-tools.md +++ b/doc/md/Continuous-integration-tools.md @@ -1,20 +1,20 @@ ## Local development A [`Makefile`](https://github.com/shaarli/Shaarli/blob/master/Makefile) is available to perform project-related operations: - Documentation - generate a local HTML copy of the GitHub wiki -- [[Static analysis]] - check that the code is compliant to PHP conventions -- [[Unit tests]] - ensure there are no regressions introduced by new commits +- [Static analysis](Static analysis) - check that the code is compliant to PHP conventions +- [Unit tests](Unit tests) - ensure there are no regressions introduced by new commits ## Automatic builds [Travis CI](http://docs.travis-ci.com/) is a Continuous Integration build server, that runs a build: - each time a commit is merged to the mainline (`master` branch) - each time a Pull Request is submitted or updated -A build is composed of several jobs: one for each supported PHP version (see [[Server requirements]]). +A build is composed of several jobs: one for each supported PHP version (see [Server requirements](Server requirements)). Each build job: - updates Composer - installs 3rd-party test dependencies with Composer -- runs [[Unit tests]] +- runs [Unit tests](Unit tests) After all jobs have finished, Travis returns the results to GitHub: - a status icon represents the result for the `master` branch: [![](https://api.travis-ci.org/shaarli/Shaarli.svg)](https://travis-ci.org/shaarli/Shaarli) diff --git a/doc/md/Development-guidelines.md b/doc/md/Development-guidelines.md index 1480ec89..3a248767 100644 --- a/doc/md/Development-guidelines.md +++ b/doc/md/Development-guidelines.md @@ -2,8 +2,8 @@ Please have a look at the following pages: - [Contributing to Shaarli](https://github.com/shaarli/Shaarli/tree/master/CONTRIBUTING.md) -- [[Static analysis]] - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: +- [Static analysis](Static analysis) - patches should try to stick to the [PHP Standard Recommendations](http://www.php-fig.org/psr/) (PSR), especially: - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide -- [[Unit tests]] -- [[GnuPG signature]] for tags/releases +- [Unit tests](Unit tests) +- [GnuPG signature](GnuPG signature) for tags/releases diff --git a/doc/md/Firefox-share.md b/doc/md/Firefox-share.md index 9ba57b04..595b9400 100644 --- a/doc/md/Firefox-share.md +++ b/doc/md/Firefox-share.md @@ -8,7 +8,7 @@ ### Sharing links using Firefox share * Add the sharing service as described above - * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [[images/firefoxshare.png]] + * When you are visiting a webpage you would like to share with Shaarli, click the Firefox _Share_ button [images/firefoxshare.png](images/firefoxshare.png) * You can edit your link before and after saving, just like the bookmarklet above. |  | Your Shaarli instance must be hosted on an HTTPS (SSL/TLS secure connection) enabled server for Firefox Share to work. Firefox Share will not work over plain HTTP connections. | diff --git a/doc/md/GnuPG-signature.md b/doc/md/GnuPG-signature.md index 1fb3b42f..62a17d33 100644 --- a/doc/md/GnuPG-signature.md +++ b/doc/md/GnuPG-signature.md @@ -73,4 +73,4 @@ gpg: sending key A9D53A3E to hkp server pgp.mit.edu ## Create and push a GPG-signed tag -See [[Release Shaarli]]. +See [Release Shaarli](Release Shaarli). diff --git a/doc/md/Theming.md b/doc/md/Theming.md index ae68db38..d72c2ffd 100644 --- a/doc/md/Theming.md +++ b/doc/md/Theming.md @@ -15,7 +15,7 @@ This file allows overriding rules defined in the template CSS files (only add ch **Note**: Do not edit `tpl/default/css/shaarli.css`! Your changes would be overridden when updating Shaarli. -See also [[Download CSS styles from an OPML list]] +See also [Download CSS styles from an OPML list](Download CSS styles from an OPML list) ## Themes @@ -77,7 +77,7 @@ Get config written: - fill the install form - log in to Shaarli -Edit Shaarli's [[configuration|Shaarli configuration]]: +Edit Shaarli's [configuration|Shaarli configuration](configuration|Shaarli configuration): ```bash # the file should be owned by Apache, thus not writeable => sudo $ sudo sed -i s=tpl=tpl/albinomouse-template=g shaarli/data/config.php diff --git a/doc/md/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md index 7348891f..2002a4e2 100644 --- a/doc/md/Upgrade-and-migration.md +++ b/doc/md/Upgrade-and-migration.md @@ -13,7 +13,7 @@ Shaarli stores all user data under the `data` directory: - `data/ipbans.php` - banned IP addresses - `data/updates.txt` - contains all automatic update to the configuration and datastore files already run -See [[Shaarli configuration]] for more information about Shaarli resources. +See [Shaarli configuration](Shaarli configuration) for more information about Shaarli resources. It is recommended to backup this repository _before_ starting updating/upgrading Shaarli: - users with SSH access: copy or archive the directory to a temporary location @@ -25,7 +25,7 @@ As all user data is kept under `data`, this is the only directory you need to wo - backup the `data` directory - install or update Shaarli: - - fresh installation - see [[Download and installation]] + - fresh installation - see [Download and installation](Download and installation) - update - see the following sections - check or restore the `data` directory @@ -33,11 +33,11 @@ As all user data is kept under `data`, this is the only directory you need to wo All tagged revisions can be downloaded as tarballs or ZIP archives from the [releases](https://github.com/shaarli/Shaarli/releases) page. -We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [[Download and installation]] for `git` complete instructions. +We recommend that you use the latest release tarball with the `-full` suffix. It contains the dependencies, please read [Download and installation](Download and installation) for `git` complete instructions. Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! -After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [[Shaarli configuration]] for more details). +After upgrading, access your fresh Shaarli installation from a web browser; the configuration and data store will then be automatically updated, and new settings added to `data/config.json.php` (see [Shaarli configuration](Shaarli configuration) for more details). ## Upgrading with Git @@ -170,7 +170,7 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to #### Step 3: configuration -After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [[Shaarli configuration]] for more details). +After migrating, access your fresh Shaarli installation from a web browser; the configuration will then be automatically updated, and new settings added to `data/config.php` (see [Shaarli configuration](Shaarli configuration) for more details). ## Troubleshooting -- cgit v1.2.3 From 12e1877917dc6c29cd93bce7781e26c9f4415c16 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 22:15:50 +0200 Subject: move README contents to doc/md/index.md --- doc/md/index.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 106 insertions(+), 3 deletions(-) (limited to 'doc/md') diff --git a/doc/md/index.md b/doc/md/index.md index 37a9c1fc..1106334b 100644 --- a/doc/md/index.md +++ b/doc/md/index.md @@ -1,11 +1,114 @@ -Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki! +# [Shaarli](https://github.com/shaarli/Shaarli/) documentation Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). -If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). +If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) or read the current [issues](https://github.com/shaarli/Shaarli/issues). +If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin). -_Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ +_Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._ + +[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli) +[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues) +[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/) + +### Demo + +You can use this [public demo instance of Shaarli](https://demo.shaarli.org). +It runs the latest development version of Shaarli and is updated/reset daily. + +Login: `demo`; Password: `demo` + + +## Features + +### Interface +- minimalist design (simple is beautiful) +- FAST +- ATOM and RSS feeds +- views: + - paginated link list + - tag cloud + - picture wall: image and video thumbnails + - daily: newspaper-like daily digest + - daily RSS feed +- permalinks for easy reference +- links can be public or private +- extensible through [plugins](https://github.com/shaarli/Shaarli/wiki/Plugins#plugin-usage) + +### Tag, view and search your links! +- add a custom title and description to archived links +- add tags to classify and search links + - features tag autocompletion, renaming, merging and deletion +- full-text and tag search + +### Easy setup +- dead-simple installation: drop the files, open the page +- links are stored in a file + - compact storage + - no database required + - easy backup: simply copy the datastore file +- import and export links as Netscape bookmarks + +### Accessibility +- Firefox bookmarlet to share links in one click +- support for mobile browsers +- works with Javascript disabled +- easy page customization through HTML/CSS/RainTPL + +### Security +- bruteforce-proof login form +- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) +and session cookie hijacking + +### Goodies +- thumbnail generation for images and video services: +dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube... + - lazy-loading with [bLazy](http://dinbror.dk/blazy/) +- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support +- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` +- discreet pop-up notification when a new release is available + +### REST API + +Easily extensible by any client using the REST API exposed by Shaarli. + +See the [API documentation](http://shaarli.github.io/api-documentation/). + +### Other usages +Though Shaarli is primarily a bookmarking application, it can serve other purposes +(see [usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)): +- micro-blogging +- pastebin +- online notepad +- snippet archive + +## About +### Shaarli community fork +This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli + +This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). + +The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) +that he would have no time to work on Shaarli in the near future. +The Shaarli community has carried on the work to provide +[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) +for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) +in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. + +### Contributing +If you'd like to help, please: +- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) +and [pull requests](https://github.com/shaarli/Shaarli/pulls) +- feel free to report bugs (feedback is much appreciated) +- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) +- propose solutions to existing problems +- submit pull requests :-) + + +### License +Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](COPYING) for a detail of the contributors and licenses for each individual component. + -- cgit v1.2.3 From 081a73486ff6eb73191294a047c51ea15e2b312a Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 18 Jun 2017 22:22:34 +0200 Subject: doc: replace pandoc requirement with python3-venv --- doc/md/Release-Shaarli.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc/md') diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md index cce5e209..59175352 100644 --- a/doc/md/Release-Shaarli.md +++ b/doc/md/Release-Shaarli.md @@ -12,7 +12,8 @@ This guide assumes that you have: - maintainer permissions on the main Shaarli repository, to: - push the signed tag - create a new release -- [Composer](https://getcomposer.org/) and [Pandoc](http://pandoc.org/) need to be installed +- [Composer](https://getcomposer.org/) needs to be installed +- The [venv](https://docs.python.org/3/library/venv.html) Python 3 module needs to be installed for HTML documentation generation. ## GitHub release draft and `CHANGELOG.md` See http://keepachangelog.com/en/0.3.0/ for changelog formatting. -- cgit v1.2.3 From 2f9c1ecf8853d513ec86427b20e0d006b5296c9c Mon Sep 17 00:00:00 2001 From: nodiscc Date: Tue, 4 Jul 2017 21:26:01 +0200 Subject: doc: release: update doc generation instructions --- doc/md/Release-Shaarli.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/md') diff --git a/doc/md/Release-Shaarli.md b/doc/md/Release-Shaarli.md index 59175352..0e445272 100644 --- a/doc/md/Release-Shaarli.md +++ b/doc/md/Release-Shaarli.md @@ -52,8 +52,8 @@ $ cd /path/to/shaarli $ git fetch upstream $ git checkout upstream/master -b v0.5.0 -# rebuild the documentation from the wiki -$ make htmldoc +# rebuild the HTML documentation from Markdown +$ make htmlpages # commit the changes $ git add doc -- cgit v1.2.3