doc: update references to config(.json)?.php

Closes https://github.com/shaarli/Shaarli/issues/1082 Signed-off-by: VirtualTam <virtualtam@flibidi.net>
author: VirtualTam <virtualtam@flibidi.net> 2018-02-14 22:02:34 +0100
committer: VirtualTam <virtualtam@flibidi.net> 2018-02-14 22:02:50 +0100
commit: 48679a159ed2e419f207d0be2e03e1a4f0e24f1d (patch)
tree: 4c4201ed20c08f8f85c769e341512c3c7c78f209 /doc
parent: 4c1bcd8b254e3376ee1a6d1108a0e56b550f28db (diff)
download: Shaarli-48679a159ed2e419f207d0be2e03e1a4f0e24f1d.tar.gz
Shaarli-48679a159ed2e419f207d0be2e03e1a4f0e24f1d.tar.zst
Shaarli-48679a159ed2e419f207d0be2e03e1a4f0e24f1d.zip
3 files changed, 16 insertions, 17 deletions
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
 ## File mode
-Enabled plugin are stored in your `config.php` parameters file, under the `array`:
+Enabled plugin are stored in your `config.json.php` parameters file, under the `array`:
 ```php
 $GLOBALS['config']['ENABLED_PLUGINS']
@@ -48,7 +48,7 @@ Example:
 ```php
 $GLOBALS['config']['ENABLED_PLUGINS'] = array(
-    'qrcode', 
+    'qrcode',
    'archiveorg',
    'wallabag',
    '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:
 ### I forgot my password!
-Delete the file `data/config.php` and display the page again. You will be asked for a new login/password.
+Delete the file `data/config.json.php` and display the page again. You will be asked for a new login/password.
 ### I'm locked out - Login bruteforce protection
@@ -97,7 +97,7 @@ php56 1
 ```php
 //list($status,$headers,$data) = getHTTP($url,4); // Short timeout to keep the application responsive.
-// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html 
+// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) <head> in html
 //if (strpos($status,'200 OK')) $title=html_extract_title($data);
 ```
@@ -106,11 +106,11 @@ php56 1
 ### Dates are not properly formatted
-Shaarli 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 :-( )
+Shaarli 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
-### Problems on CentOS servers
+(and more generally 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
-On **CentOS**/RedHat derivatives, you may need to install the `php-mbstring` package.
+(it's the case on sebsauvage.net :-( )
 ### My session expires! I can't stay logged in
@@ -126,7 +126,3 @@ This can be caused by several things:
 ## Sessions do not seem to work correctly on your server
 Follow 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)).
-### pubsubhubbub support
-Download [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 @@
 ### Note your current version
-If anything goes wrong, it's important for us to know which version you're upgrading from.  
+If anything goes wrong, it's important for us to know which version you're upgrading from.
 The current version is present in the `version.php` file.
 ### Backup your data
 Shaarli stores all user data under the `data` directory:
- `data/config.php` - main configuration file
+- `data/config.json.php` (or `data/config.php` for older Shaarli versions) - main configuration file
 - `data/datastore.php` - bookmarked links
 - `data/ipbans.php` - banned IP addresses
 - `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
 Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory!
-If you use translations in gettext mode - meaning you manually changed the default mode -, 
+If you use translations in gettext mode - meaning you manually changed the default mode -,
 reload your web server.
 After 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
 #### Step 3: configuration
-After 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).
+After migrating, access your fresh Shaarli installation from a web browser; the
+configuration will then be automatically updated, and new settings added to
+`data/config.json.php` (see [Shaarli configuration](Shaarli-configuration) for more
+details).
 ## Troubleshooting
author	VirtualTam <virtualtam@flibidi.net>	2018-02-14 22:02:34 +0100
committer	VirtualTam <virtualtam@flibidi.net>	2018-02-14 22:02:50 +0100
commit	48679a159ed2e419f207d0be2e03e1a4f0e24f1d (patch)
tree	4c4201ed20c08f8f85c769e341512c3c7c78f209 /doc
parent	4c1bcd8b254e3376ee1a6d1108a0e56b550f28db (diff)
download	Shaarli-48679a159ed2e419f207d0be2e03e1a4f0e24f1d.tar.gz Shaarli-48679a159ed2e419f207d0be2e03e1a4f0e24f1d.tar.zst Shaarli-48679a159ed2e419f207d0be2e03e1a4f0e24f1d.zip

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
40	Enabled plugin are stored in your `config.php` parameters file, under the `array`:	40	Enabled 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
66	Delete the file `data/config.php` and display the page again. You will be asked for a new login/password.	66	Delete 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
109	Shaarli 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 :-( )	109	Shaarli tries to sniff the language of the browser (using `HTTP_ACCEPT_LANGUAGE` headers)
110		110	and 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		112	So even if you have a browser in French, you may end up with dates in US format
113	On 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
128	Follow 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)).	128	Follow 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
132	Download [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
5	If anything goes wrong, it's important for us to know which version you're upgrading from.	5	If anything goes wrong, it's important for us to know which version you're upgrading from.
6	The current version is present in the `version.php` file.	6	The current version is present in the `version.php` file.
7		7
8	### Backup your data	8	### Backup your data
9		9
10	Shaarli stores all user data under the `data` directory:	10	Shaarli 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
40	Once downloaded, extract the archive locally and update your remote installation (e.g. via FTP) -be sure you keep the content of the `data` directory!	40	Once 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
42	If you use translations in gettext mode - meaning you manually changed the default mode -,	42	If you use translations in gettext mode - meaning you manually changed the default mode -,
43	reload your web server.	43	reload your web server.
44		44
45	After 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).	45	After 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
195	After 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).	195	After migrating, access your fresh Shaarli installation from a web browser; the
		196	configuration will then be automatically updated, and new settings added to
		197	`data/config.json.php` (see [Shaarli configuration](Shaarli-configuration) for more
		198	details).
196		199
197	## Troubleshooting	200	## Troubleshooting
198		201