91a21c2729
- standardize page names, rework documentation structure, update TOC - use same example paths everywhere - level 1 titles on all pages - fix broken links - .md suffix on all page links (works both from readthedocs and github repository views) **Server:** A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration. - server: move most server-related info to server-configuration.md, cleanup/shorten - server: update list of php dependencies/libraries, link to composer.json - server: installation: support 3 install methods (from release zip, from sources, using docker) - server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not - server: add example/basic usage of certbot - server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root - server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example - server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files - server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section - server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here - server: simplify phpinfo documentation - server: move backup and restore information to dedicated page - docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet - troubleshooting: move all troubleshooting documentation to troubleshooting.md **Usage:** - index: add getting started section on index page - features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list - shaarli configuration: add note about configuring from web interface **Removed:** - remove obsolete/orphan images - remove obsolete shaarchiver example - remove outdated "decode datastore content" snippet **Development:** - development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory - development: Merge several pages to development.md - **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag) - **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details - development: directory structure: add note about required file permissions - .travis-ci.yml: add comments - .htaccess: add comment
109 lines
5.5 KiB
Markdown
109 lines
5.5 KiB
Markdown
# <img src="images/icon.png" width="20px" height="20px"> Shaarli
|
|
|
|
The personal, minimalist, super-fast, database free, bookmarking service.
|
|
|
|
Do you want to share the links you discover? Shaarli is a minimalist bookmark manager and link sharing service that you can install on your own server. It is designed to be personal (single-user), fast and handy.
|
|
|
|
Visit the pages in the sidebar to find information on how to setup, use, configure, tweak and troubleshoot Shaarli.
|
|
|
|
* [GitHub project page](https://github.com/shaarli/Shaarli)
|
|
* [Documentation](https://shaarli.readthedocs.io/)
|
|
* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md)
|
|
|
|
|
|
[](https://i.imgur.com/WWPfSj0.png) [](https://i.imgur.com/V09kAQt.png) [](https://i.imgur.com/TZzGHMs.png) [](https://i.imgur.com/sfJJ6NT.png) [](https://i.imgur.com/QsedIuJ.png) [](https://i.imgur.com/KdtF8Ll.png) [](https://i.imgur.com/27wYsbC.png) [](https://i.imgur.com/zGF4d6L.jpg)
|
|
|
|
|
|
|
|
## 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`
|
|
|
|
|
|
## Getting started
|
|
|
|
- [Configure your server](Server-configuration.md)
|
|
- [Install Shaarli](Installation.md)
|
|
- Or install Shaarli using [Docker](Docker.md)
|
|
|
|
|
|
## Features
|
|
|
|
Shaarli can be used:
|
|
|
|
- to share, comment and save interesting links
|
|
- to bookmark useful/frequent links and share them between computers
|
|
- as a minimal blog/microblog/writing platform
|
|
- as a read-it-later/todo list
|
|
- as a notepad to draft and save articles/posts/ideas
|
|
- as a knowledge base to keep notes, documentation and code snippets
|
|
- as a shared clipboard/notepad/pastebin between computers
|
|
- as playlist manager for online media
|
|
- to feed other blogs, aggregators, social networks...
|
|
|
|
### Edit, view and search your links
|
|
|
|
- Editable URL, title, description, tags, private/public status for all your [Shaares](Usage.md)
|
|
- [Tags](Usage.md#tags) to organize your Shaares
|
|
- [Search](Usage.md#search) in all fields
|
|
- Unique [permalinks](Usage.md#permalinks) for easy reference
|
|
- Paginated Shaares list view (with image and video thumbnails)
|
|
- [Tag cloud/list](Usage#tag-cloud) views
|
|
- [Picture wall](Usage#picture-wall)/thumbnails view (with lazy loading)
|
|
- [ATOM and RSS feeds](Usage.md#rss-feeds) (can also be filtered using tags or text search)
|
|
- [Daily](Usage.md#daily): newspaper-like daily digest (and daily RSS feed)
|
|
- URL cleanup: automatic removal of `?utm_source=...`, `fb=...` tracking parameters
|
|
- Extensible through [plugins](Plugins.md)
|
|
- Easily extensible by any client using the [REST API](REST-API.md) exposed by Shaarli
|
|
- Bookmarklet and [other tools](Community-and-related-software.md) to share links in one click
|
|
- Responsive/support for mobile browsers, degrades gracefully with Javascript disabled
|
|
|
|
|
|
### Easy setup
|
|
|
|
- Dead-simple [installation](Installation.md): drop the files on your server, open the page
|
|
- Shaares are stored in a file (no database required, easy [backup](Backup-and-restore.md))
|
|
- [Configurable](Shaarli-configuration.md) from dialog and configuration file
|
|
- Extensible through third-party [plugins and themes](Community-and-related-software.md)
|
|
|
|
|
|
### Fast
|
|
|
|
- Fast! Small datastore file, write-once/read-many, served most of the time from OS disk caches (no disk I/O)
|
|
- Stays fast with even tens of thousands shaares!
|
|
|
|
|
|
### Self-hosted
|
|
|
|
- Shaarli is an alternative to commercial services such as StumbleUpon, Delicio.us, Diigo...
|
|
- The data is yours, [import and export](Usage#import-export) it to HTML bookmarksformat compatible with most web browser, and from a variety of formats
|
|
- Shaarli does not send any telemetry/metrics/private information to developers
|
|
- Shaarli is Free and Open-Source software, inspect and change how the program works in the [source code](https://github.com/shaarli/Shaarli)
|
|
- Built-in [Security](dev/Development.md#security) features to help you protect your Shaarli instance
|
|
|
|
|
|
## About
|
|
|
|
This [community fork](https://github.com/shaarli/Shaarli) of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/) (now [unmaintained](https://github.com/sebsauvage/Shaarli/issues/191)) 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.
|
|
|
|
The original Shaarli instance is still available [here](https://sebsauvage.net/links/) (+25000 shaares!)
|
|
|
|
|
|
### Contributing and getting help
|
|
|
|
Feedback is very appreciated! Feel free to propose solutions to existing problems, help us improve the documentation and translations, and submit pull requests :-)
|
|
|
|
See [Support](Troubleshooting.md#support) to get in touch with the Shaarli community.
|
|
|
|
|
|
### License
|
|
|
|
Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See
|
|
[COPYING](https://github.com/shaarli/Shaarli/blob/master/COPYING) for a detail
|
|
of the contributors and licenses for each individual component. A list of
|
|
contributors is available
|
|
[here](https://github.com/shaarli/Shaarli/blob/master/AUTHORS).
|
|
|