The personal, minimalist, super-fast, database free, bookmarking service - community repo
PHP HTML CSS JavaScript Makefile Nginx ApacheConf
Pull request Compare This branch is 860 commits ahead, 3 commits behind sebsauvage:master.
Latest commit a271c5f Apr 25, 2017 @ArthurHoaro ArthurHoaro committed on GitHub Merge pull request #852 from ArthurHoaro/theme/install-password
Theme: use a password type field during the install
Permalink
Failed to load latest commit information.
.github Add an AUTHORS file, simplify COPYING, bump year to 2017 Jan 7, 2017
application Merge pull request #830 from ArthurHoaro/theme/timezone Apr 25, 2017
cache .htaccess files: support Apache 2.4+ syntax Nov 8, 2016
data .htaccess files: support Apache 2.4+ syntax Nov 8, 2016
doc Bump version to v0.8.1 Dec 12, 2016
docker API+Docker: enable nginx URL rewriting Jan 5, 2017
images Minor improvements regarding #705 (coding style, unit tests, etc.) Jan 5, 2017
inc Remove inline JS and add LibreJS headers in JS files Mar 12, 2017
pagecache .htaccess files: support Apache 2.4+ syntax Nov 8, 2016
plugins Remove readityourself plugin Apr 1, 2017
tests Merge pull request #830 from ArthurHoaro/theme/timezone Apr 25, 2017
tmp .htaccess files: support Apache 2.4+ syntax Nov 8, 2016
tpl Merge pull request #852 from ArthurHoaro/theme/install-password Apr 25, 2017
.gitattributes Prevent git from messing with font files Mar 9, 2017
.gitignore Include composer.lock in git files Mar 21, 2017
.htaccess REST API structure using Slim framework Dec 15, 2016
.travis.yml Use all_tests target in Travis CI Mar 6, 2017
AUTHORS Add an AUTHORS file, simplify COPYING, bump year to 2017 Jan 7, 2017
CHANGELOG.md Theme: display shaarli version in the footer when logged in Mar 12, 2017
CONTRIBUTING.md [doc] update CONTRIBUTING Jun 26, 2015
COPYING Remove inline JS and add LibreJS headers in JS files Mar 12, 2017
Doxyfile Add a target to generate Doxygen documentation Nov 22, 2015
Makefile Run languages tests using PHPUnit test suites Mar 6, 2017
README.md README: use explicit version badges Mar 19, 2017
composer.json Upgrade netscape-bookmark-parser dependency to v2.x Mar 10, 2017
composer.lock Include composer.lock in git files Mar 21, 2017
index.php Merge pull request #830 from ArthurHoaro/theme/timezone Apr 25, 2017
phpunit.xml Run languages tests using PHPUnit test suites Mar 6, 2017
shaarli_version.php Use 'dev' version on the master branch Mar 12, 2017

README.md

Shaarli logo

The personal, minimalist, super-fast, database free, bookmarking service.

Do you want to share the links you discover? Shaarli is a minimalist delicious clone that you can install on your own server. It is designed to be personal (single-user), fast and handy.

Join the chat at https://gitter.im/shaarli/Shaarli Bountysource Docker repository

Quickstart

Demo

You can use this public demo instance of Shaarli. It runs the latest development version of Shaarli and is updated/reset daily.

Login: demo; Password: demo

Installation & upgrade

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

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 and session cookie hijacking

Goodies

  • thumbnail generation for images and video services: dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
    • lazy-loading with bLazy
  • PubSubHubbub protocol support
  • URL cleanup: automatic removal of ?utm_source=..., fb=...
  • discreet pop-up notification when a new release is available

Other usages

Though Shaarli is primarily a bookmarking application, it can serve other purposes (see 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 project by Sébastien Sauvage.

The original project is currently unmaintained, and the developer has informed us 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 for bug fixes and enhancements 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 and pull requests
  • feel free to report bugs (feedback is much appreciated)
  • suggest new features and improvements to both code and documentation
  • propose solutions to existing problems
  • submit pull requests :-)

License

Shaarli is Free Software. See COPYING for a detail of the contributors and licenses for each individual component.