aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/index.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2018-04-20 23:16:59 +0200
committernodiscc <nodiscc@gmail.com>2018-06-17 18:56:00 +0200
commitbdfb967ca2f9d75791a2da2bb189d63df33638cc (patch)
tree877d38339e2648e18390bf6cd1deeaa8c42c6185 /doc/md/index.md
parent26b0b2022870a540c1a6d54e949c4bdc1486daed (diff)
downloadShaarli-bdfb967ca2f9d75791a2da2bb189d63df33638cc.tar.gz
Shaarli-bdfb967ca2f9d75791a2da2bb189d63df33638cc.tar.zst
Shaarli-bdfb967ca2f9d75791a2da2bb189d63df33638cc.zip
Improve documentation (#598, #1105)
* rework/simplify server configuration/requirements pages (consolidate/simplify SSL/TLS/apache configuration) * update index.md introduction * remove external images (badges) * Fix COPYING link and documentation links * Update features list * dedpulicate information * remove server-requirements.md and move relevant doc to other files * TODO: rework nginx configuration (single configuration example, with commented out blocks for special cases) * TODO: consolidate download/install/configuration pages * remove blank lighttpd configuration section * remove Required? column for composer packages, all libraries are mandatory * php 7.2 compatibilty * clarify that certbot binary and paths may vary depending on install method
Diffstat (limited to 'doc/md/index.md')
-rw-r--r--doc/md/index.md74
1 files changed, 44 insertions, 30 deletions
diff --git a/doc/md/index.md b/doc/md/index.md
index 224070cb..21a63d3c 100644
--- a/doc/md/index.md
+++ b/doc/md/index.md
@@ -1,19 +1,27 @@
1# [Shaarli](https://github.com/shaarli/Shaarli/) documentation 1# [Shaarli](https://github.com/shaarli/Shaarli/) documentation
2 2
3Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli. 3The personal, minimalist, super-fast, database free, bookmarking service.
4
5Do you want to share the links you discover?
6Shaarli is a minimalist link sharing service that you can install on your own server.
7It is designed to be personal (single-user), fast and handy.
8
9<!--- TODO screenshots --->
4 10
5For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md). 11Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
12For general information, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
6 13
7If 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). 14If 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).
15
8If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new). 16If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
9 17
10If 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). 18If 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).
11 19
12_Note: This documentation is available online at https://shaarli.readthedocs.io/, and locally in the `doc/html/` directory of your Shaarli installation._ 20* [GitHub project page](https://github.com/shaarli/Shaarli)
21* [Online documentation](https://shaarli.readthedocs.io/) (this page)
22* [Latest Shaarli releases](https://github.com/shaarli/Shaarli/releases)
23* [Changelog](https://github.com/shaarli/Shaarli/blob/master/CHANGELOG.md)
13 24
14[![Join the chat at https://gitter.im/shaarli/Shaarli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/shaarli/Shaarli)
15[![Bountysource](https://www.bountysource.com/badge/team?team_id=19583&style=bounties_received)](https://www.bountysource.com/teams/shaarli/issues)
16[![Docker repository](https://img.shields.io/docker/pulls/shaarli/shaarli.svg)](https://hub.docker.com/r/shaarli/shaarli/)
17 25
18### Demo 26### Demo
19 27
@@ -22,6 +30,9 @@ It runs the latest development version of Shaarli and is updated/reset daily.
22 30
23Login: `demo`; Password: `demo` 31Login: `demo`; Password: `demo`
24 32
33<!---- TODO review everything below this point --->
34
35
25## Features 36## Features
26 37
27Shaarli can be used: 38Shaarli can be used:
@@ -42,26 +53,31 @@ Shaarli can be used:
42- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...). 53- to feed other social networks, blogs... using RSS feeds and external services (dlvr.it, ifttt.com ...).
43 54
44### Interface 55### Interface
56
45- minimalist design (simple is beautiful) 57- minimalist design (simple is beautiful)
46- FAST 58- FAST
47- ATOM and RSS feeds 59- ATOM and RSS feeds
48- views: 60- views:
49 - paginated link list 61 - paginated link list (with image and video thumbnails)
50 - tag cloud 62 - tag cloud
51 - picture wall: image and video thumbnails 63 - picture wall: image and video thumbnails (with lazy loading)
52 - daily: newspaper-like daily digest 64 - daily: newspaper-like daily digest
53 - daily RSS feed 65 - daily RSS feed
54- permalinks for easy reference 66- permalinks for easy reference
55- links can be public or private 67- links can be public or private
68- thumbnail generation for images and video services
69- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
56- extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage) 70- extensible through [plugins](https://shaarli.readthedocs.io/en/master/Plugins/#plugin-usage)
57 71
58### Tag, view and search your links! 72### Tag, view and search your links
73
59- add a custom title and description to archived links 74- add a custom title and description to archived links
60- add tags to classify and search links 75- add tags to classify and search links
61 - features tag autocompletion, renaming, merging and deletion 76 - features tag autocompletion, renaming, merging and deletion
62- full-text and tag search 77- full-text and tag search
63 78
64### Easy setup 79### Easy setup
80
65- dead-simple installation: drop the files, open the page 81- dead-simple installation: drop the files, open the page
66- links are stored in a file 82- links are stored in a file
67 - compact storage 83 - compact storage
@@ -70,23 +86,19 @@ Shaarli can be used:
70- import and export links as Netscape bookmarks 86- import and export links as Netscape bookmarks
71 87
72### Accessibility 88### Accessibility
73- Firefox bookmarlet to share links in one click 89
90- bookmarlet to share links in one click
74- support for mobile browsers 91- support for mobile browsers
75- works with Javascript disabled 92- degrades gracefully with Javascript disabled
76- easy page customization through HTML/CSS/RainTPL 93- easy page customization through HTML/CSS/RainTPL
77 94
78### Security 95### Security
79- bruteforce-proof login form 96
80- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)
81and session cookie hijacking
82
83### Goodies
84- thumbnail generation for images and video services:
85dailymotion, flickr, imageshack, imgur, vimeo, xkcd, youtube...
86 - lazy-loading with [bLazy](http://dinbror.dk/blazy/)
87- [PubSubHubbub](https://code.google.com/p/pubsubhubbub/) protocol support
88- URL cleanup: automatic removal of `?utm_source=...`, `fb=...`
89- discreet pop-up notification when a new release is available 97- discreet pop-up notification when a new release is available
98- bruteforce protection on the login form
99- protected against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) and session cookie hijacking
100
101<!---- TODO Limitations --->
90 102
91### REST API 103### REST API
92 104
@@ -95,28 +107,30 @@ Easily extensible by any client using the REST API exposed by Shaarli.
95See the [API documentation](http://shaarli.github.io/api-documentation/). 107See the [API documentation](http://shaarli.github.io/api-documentation/).
96 108
97## About 109## About
110
98### Shaarli community fork 111### Shaarli community fork
112
99This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli 113This friendly fork is maintained by the Shaarli community at https://github.com/shaarli/Shaarli
100 114
101This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/). 115This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [Sébastien Sauvage](http://sebsauvage.net/).
102 116
103The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) 117The 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.
104that he would have no time to work on Shaarli in the near future. 118
105The Shaarli community has carried on the work to provide 119The 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.
106[many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) 120
107for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+)
108in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient.
109 121
110### Contributing 122### Contributing
123
111If you'd like to help, please: 124If you'd like to help, please:
112- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues) 125- have a look at the open [issues](https://github.com/shaarli/Shaarli/issues)
113and [pull requests](https://github.com/shaarli/Shaarli/pulls) 126and [pull requests](https://github.com/shaarli/Shaarli/pulls)
114- feel free to report bugs (feedback is much appreciated) 127- feel free to report bugs (feedback is much appreciated)
115- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/wiki) 128- suggest new features and improvements to both code and [documentation](https://github.com/shaarli/Shaarli/tree/master/doc/md/)
116- propose solutions to existing problems 129- propose solutions to existing problems
117- submit pull requests :-) 130- submit pull requests :-)
118 131
119 132
120### License 133### License
121Shaarli 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. 134
135Shaarli 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).
122 136