diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Home.md | 63 |
1 files changed, 55 insertions, 8 deletions
diff --git a/doc/Home.md b/doc/Home.md index c80b8c92..bbece989 100644 --- a/doc/Home.md +++ b/doc/Home.md | |||
| @@ -8,6 +8,52 @@ If you'd like a feature added, see if it fits in the list of [Ideas for Plugins] | |||
| 8 | 8 | ||
| 9 | _Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ | 9 | _Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._ |
| 10 | 10 | ||
| 11 | ---------------------------------------------------------------------------------- | ||
| 12 | |||
| 13 | <!-- MarkdownTOC depth=3 --> | ||
| 14 | |||
| 15 | - [Basic Usage](#basic-usage) | ||
| 16 | - [Add the sharing button (_bookmarklet_) to your browser](#add-the-sharing-button-_bookmarklet_-to-your-browser) | ||
| 17 | - [Share links using the _bookmarklet_](#share-links-using-the-_bookmarklet_) | ||
| 18 | - [Other usage examples](#other-usage-examples) | ||
| 19 | - [Using Shaarli as a blog, notepad, pastebin...](#using-shaarli-as-a-blog-notepad-pastebin) | ||
| 20 | - [RSS Feeds or Picture Wall for a specific search/tag](#rss-feeds-or-picture-wall-for-a-specific-searchtag) | ||
| 21 | - [Configuration](#configuration) | ||
| 22 | - [Main data/options.php file](#main-dataoptionsphp-file) | ||
| 23 | - [Changing theme](#changing-theme) | ||
| 24 | - [Changing template](#changing-template) | ||
| 25 | - [Backup](#backup) | ||
| 26 | - [Troubleshooting](#troubleshooting) | ||
| 27 | - [I forgot my password !](#i-forgot-my-password-) | ||
| 28 | - [I'm locked out - Login bruteforce protection](#im-locked-out---login-bruteforce-protection) | ||
| 29 | - [List of all login attempts](#list-of-all-login-attempts) | ||
| 30 | - [Exporting from Diigo](#exporting-from-diigo) | ||
| 31 | - [Importing from SemanticScuttle](#importing-from-semanticscuttle) | ||
| 32 | - [Importing from Mister Wong](#importing-from-mister-wong) | ||
| 33 | - [Hosting problems](#hosting-problems) | ||
| 34 | - [Dates are not properly formatted](#dates-are-not-properly-formatted) | ||
| 35 | - [Problems on CentOS servers](#problems-on-centos-servers) | ||
| 36 | - [My session expires ! I can't stay logged in](#my-session-expires--i-cant-stay-logged-in) | ||
| 37 | - [`Sessions do not seem to work correctly on your server`](#sessions-do-not-seem-to-work-correctly-on-your-server) | ||
| 38 | - [pubsubhubbub support](#pubsubhubbub-support) | ||
| 39 | - [Notes](#notes) | ||
| 40 | - [Various hacks](#various-hacks) | ||
| 41 | - [Changing timestamp for a link](#changing-timestamp-for-a-link) | ||
| 42 | - [Related software](#related-software) | ||
| 43 | - [Other links](#other-links) | ||
| 44 | - [FAQ](#faq) | ||
| 45 | - [Why did you create Shaarli ?](#why-did-you-create-shaarli-) | ||
| 46 | - [Why use Shaarli and not Delicious/Diigo ?](#why-use-shaarli-and-not-deliciousdiigo-) | ||
| 47 | - [What does Shaarli mean ?](#what-does-shaarli-mean-) | ||
| 48 | - [Technical details](#technical-details) | ||
| 49 | - [Directory structure](#directory-structure) | ||
| 50 | - [Why not use a real database ? Files are slow !](#why-not-use-a-real-database--files-are-slow-) | ||
| 51 | - [Wiki - TODO](#wiki---todo) | ||
| 52 | |||
| 53 | <!-- /MarkdownTOC --> | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 11 | ------------------------------------------------------------------ | 57 | ------------------------------------------------------------------ |
| 12 | 58 | ||
| 13 | # Basic Usage | 59 | # Basic Usage |
| @@ -139,23 +185,24 @@ You have two ways of backing up your database: | |||
| 139 | * This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool. Example command: `./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all` | 185 | * This can be done using the [shaarchiver](https://github.com/nodiscc/shaarchiver) tool. Example command: `./export-bookmarks.py --url=https://my.server.com/shaarli --username=myusername --password=mysupersecretpassword --download-dir=./ --type=all` |
| 140 | 186 | ||
| 141 | 187 | ||
| 188 | # Troubleshooting | ||
| 189 | |||
| 190 | ### I forgot my password ! | ||
| 191 | |||
| 192 | Delete the file data/config.php and display the page again. You will be asked for a new login/password. | ||
| 193 | |||
| 194 | |||
| 142 | 195 | ||
| 143 | # Login bruteforce protection | 196 | ### I'm locked out - Login bruteforce protection |
| 144 | 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. | 197 | 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. |
| 145 | 198 | ||
| 146 | To remove the current IP bans, delete the file `data/ipbans.php` | 199 | To remove the current IP bans, delete the file `data/ipbans.php` |
| 147 | 200 | ||
| 148 | ## List of all login attempts | 201 | ### List of all login attempts |
| 149 | 202 | ||
| 150 | The file `data/log.txt` shows all logins (successful or failed) and bans/lifted bans. | 203 | The file `data/log.txt` shows all logins (successful or failed) and bans/lifted bans. |
| 151 | Search for `failed` in this file to look for unauthorized login attempts. | 204 | Search for `failed` in this file to look for unauthorized login attempts. |
| 152 | 205 | ||
| 153 | # Troubleshooting | ||
| 154 | |||
| 155 | ### I forgot my password ! | ||
| 156 | |||
| 157 | Delete the file data/config.php and display the page again. You will be asked for a new login/password. | ||
| 158 | |||
| 159 | 206 | ||
| 160 | ### Exporting from Diigo | 207 | ### Exporting from Diigo |
| 161 | 208 | ||