aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorVirtualTam <virtualtam+github@flibidi.net>2018-02-16 01:52:38 +0100
committerGitHub <noreply@github.com>2018-02-16 01:52:38 +0100
commit2e6b9ed3b9d5c813b0136230f6ac659df9ed46e7 (patch)
tree4c4201ed20c08f8f85c769e341512c3c7c78f209 /doc
parent8b48e36594394e367cbb33c7ad1a679ea57c374d (diff)
parent48679a159ed2e419f207d0be2e03e1a4f0e24f1d (diff)
downloadShaarli-2e6b9ed3b9d5c813b0136230f6ac659df9ed46e7.tar.gz
Shaarli-2e6b9ed3b9d5c813b0136230f6ac659df9ed46e7.tar.zst
Shaarli-2e6b9ed3b9d5c813b0136230f6ac659df9ed46e7.zip
Merge pull request #1084 from virtualtam/doc/updates
Documentation: cleanup, update references to config(.json)?.php
Diffstat (limited to 'doc')
-rw-r--r--doc/md/Directory-structure.md23
-rw-r--r--doc/md/Plugins.md4
-rw-r--r--doc/md/Troubleshooting.md18
-rw-r--r--doc/md/Upgrade-and-migration.md11
4 files changed, 31 insertions, 25 deletions
diff --git a/doc/md/Directory-structure.md b/doc/md/Directory-structure.md
index eb50965b..937a076d 100644
--- a/doc/md/Directory-structure.md
+++ b/doc/md/Directory-structure.md
@@ -1,4 +1,4 @@
1TODO: This page is out of date 1## Directory structure
2 2
3Here is the directory structure of Shaarli and the purpose of the different files: 3Here is the directory structure of Shaarli and the purpose of the different files:
4 4
@@ -6,10 +6,16 @@ Here is the directory structure of Shaarli and the purpose of the different file
6 index.php # Main program 6 index.php # Main program
7 application/ # Shaarli classes 7 application/ # Shaarli classes
8 ├── LinkDB.php 8 ├── LinkDB.php
9
10 ...
11
9 └── Utils.php 12 └── Utils.php
10 tests/ # Shaarli unitary & functional tests 13 tests/ # Shaarli unitary & functional tests
11 ├── LinkDBTest.php 14 ├── LinkDBTest.php
12 ├── utils # utilities to ease testing 15
16 ...
17
18 ├── utils # utilities to ease testing
13 │ └── ReferenceLinkDB.php 19 │ └── ReferenceLinkDB.php
14 └── UtilsTest.php 20 └── UtilsTest.php
15 COPYING # Shaarli license 21 COPYING # Shaarli license
@@ -18,17 +24,18 @@ Here is the directory structure of Shaarli and the purpose of the different file
18 ├── blazy.* # picture wall lazy image loading library 24 ├── blazy.* # picture wall lazy image loading library
19 ├── shaarli.css, reset.css # Shaarli stylesheet. 25 ├── shaarli.css, reset.css # Shaarli stylesheet.
20 ├── qr.* # qr code generation library 26 ├── qr.* # qr code generation library
21 └──rain.tpl.class.php # RainTPL templating library 27 └── rain.tpl.class.php # RainTPL templating library
22 tpl/ # RainTPL templates for Shaarli. They are used to build the pages.
23 images/ # Images and icons used in Shaarli 28 images/ # Images and icons used in Shaarli
24 data/ # data storage: bookmark database, configuration, logs, banlist 29 data/ # data storage: bookmark database, configuration, logs, banlist...
25 ├── config.php # Shaarli configuration (login, password, timezone, title) 30 ├── config.json.php # Shaarli configuration (login, password, timezone, title...)
26 ├── datastore.php # Your link database (compressed). 31 ├── datastore.php # Your link database (compressed).
27 ├── ipban.php # IP address ban system data 32 ├── ipban.php # IP address ban system data
28 ├── lastupdatecheck.txt # Update check timestamp file 33 ├── lastupdatecheck.txt # Update check timestamp file
29 └──log.txt # login/IPban log. 34 └── log.txt # login/IPban log.
35 tpl/ # RainTPL templates for Shaarli. They are used to build the pages.
30 cache/ # thumbnails cache 36 cache/ # thumbnails cache
31 # This directory is automatically created. You can erase it anytime you want. 37 # This directory is automatically created. You can erase it anytime you want.
32 tmp/ # Temporary directory for compiled RainTPL templates. 38 tmp/ # Temporary directory for compiled RainTPL templates.
33 # This directory is automatically created. You can erase it anytime you want. 39 # This directory is automatically created. You can erase it anytime you want.
40 vendor/ # Third-party dependencies. This directory is created by Composer
34``` 41```
diff --git a/doc/md/Plugins.md b/doc/md/Plugins.md
index 463dae17..954442e2 100644
--- a/doc/md/Plugins.md
+++ b/doc/md/Plugins.md
@@ -37,7 +37,7 @@ This is important in case plugins are depending on each other. Read plugins READ
37 37
38## File mode 38## File mode
39 39
40Enabled plugin are stored in your `config.php` parameters file, under the `array`: 40Enabled plugin are stored in your `config.json.php` parameters file, under the `array`:
41 41
42```php 42```php
43$GLOBALS['config']['ENABLED_PLUGINS'] 43$GLOBALS['config']['ENABLED_PLUGINS']
@@ -48,7 +48,7 @@ Example:
48 48
49```php 49```php
50$GLOBALS['config']['ENABLED_PLUGINS'] = array( 50$GLOBALS['config']['ENABLED_PLUGINS'] = array(
51 'qrcode', 51 'qrcode',
52 'archiveorg', 52 'archiveorg',
53 'wallabag', 53 'wallabag',
54 'markdown', 54 'markdown',
diff --git a/doc/md/Troubleshooting.md b/doc/md/Troubleshooting.md
index b2d86d40..570f6956 100644
--- a/doc/md/Troubleshooting.md
+++ b/doc/md/Troubleshooting.md
@@ -63,7 +63,7 @@ Related threads:
63 63
64### I forgot my password! 64### I forgot my password!
65 65
66Delete the file `data/config.php` and display the page again. You will be asked for a new login/password. 66Delete the file `data/config.json.php` and display the page again. You will be asked for a new login/password.
67 67
68### I'm locked out - Login bruteforce protection 68### I'm locked out - Login bruteforce protection
69 69
@@ -97,7 +97,7 @@ php56 1
97 97
98```php 98```php
99//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive. 99//list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.
100// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html 100// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html
101//if (strpos($status,'200 OK')) $title=html_extract_title($data); 101//if (strpos($status,'200 OK')) $title=html_extract_title($data);
102``` 102```
103 103
@@ -106,11 +106,11 @@ php56 1
106 106
107### Dates are not properly formatted 107### Dates are not properly formatted
108 108
109Shaarli 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 :-( ) 109Shaarli tries to sniff the language of the browser (using `HTTP_ACCEPT_LANGUAGE` headers)
110 110and choose a date format accordingly. But Shaarli can only use the date formats
111### Problems on CentOS servers 111(and more generally speaking, the locales) provided by the webserver.
112 112So even if you have a browser in French, you may end up with dates in US format
113On **CentOS**/RedHat derivatives, you may need to install the `php-mbstring` package. 113(it's the case on sebsauvage.net :-( )
114 114
115### My session expires! I can't stay logged in 115### My session expires! I can't stay logged in
116 116
@@ -126,7 +126,3 @@ This can be caused by several things:
126## Sessions do not seem to work correctly on your server 126## Sessions do not seem to work correctly on your server
127 127
128Follow 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)). 128Follow 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)).
129
130### pubsubhubbub support
131
132Download [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/Upgrade-and-migration.md b/doc/md/Upgrade-and-migration.md
index 1dc07339..f666be75 100644
--- a/doc/md/Upgrade-and-migration.md
+++ b/doc/md/Upgrade-and-migration.md
@@ -2,14 +2,14 @@
2 2
3### Note your current version 3### Note your current version
4 4
5If anything goes wrong, it's important for us to know which version you're upgrading from. 5If anything goes wrong, it's important for us to know which version you're upgrading from.
6The current version is present in the `version.php` file. 6The current version is present in the `version.php` file.
7 7
8### Backup your data 8### Backup your data
9 9
10Shaarli stores all user data under the `data` directory: 10Shaarli stores all user data under the `data` directory:
11 11
12- `data/config.php` - main configuration file 12- `data/config.json.php` (or `data/config.php` for older Shaarli versions) - main configuration file
13- `data/datastore.php` - bookmarked links 13- `data/datastore.php` - bookmarked links
14- `data/ipbans.php` - banned IP addresses 14- `data/ipbans.php` - banned IP addresses
15- `data/updates.txt` - contains all automatic update to the configuration and datastore files already run 15- `data/updates.txt` - contains all automatic update to the configuration and datastore files already run
@@ -39,7 +39,7 @@ We recommend that you use the latest release tarball with the `-full` suffix. It
39 39
40Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory! 40Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory!
41 41
42If you use translations in gettext mode - meaning you manually changed the default mode -, 42If you use translations in gettext mode - meaning you manually changed the default mode -,
43reload your web server. 43reload your web server.
44 44
45After 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). 45After 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).
@@ -192,7 +192,10 @@ Total 3317 (delta 2050), reused 3301 (delta 2034)to
192 192
193#### Step 3: configuration 193#### Step 3: configuration
194 194
195After 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). 195After migrating, access your fresh Shaarli installation from a web browser; the
196configuration will then be automatically updated, and new settings added to
197`data/config.json.php` (see [Shaarli configuration](Shaarli-configuration) for more
198details).
196 199
197## Troubleshooting 200## Troubleshooting
198 201