From 4c1bcd8b254e3376ee1a6d1108a0e56b550f28db Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Wed, 14 Feb 2018 21:58:41 +0100 Subject: doc: update Directory Structure Signed-off-by: VirtualTam --- doc/md/Directory-structure.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) (limited to 'doc/md') 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 @@ -TODO: This page is out of date +## Directory structure Here is the directory structure of Shaarli and the purpose of the different files: @@ -6,10 +6,16 @@ Here is the directory structure of Shaarli and the purpose of the different file index.php # Main program application/ # Shaarli classes ├── LinkDB.php + + ... + └── Utils.php - tests/ # Shaarli unitary & functional tests + tests/ # Shaarli unitary & functional tests ├── LinkDBTest.php - ├── utils # utilities to ease testing + + ... + + ├── utils # utilities to ease testing │ └── ReferenceLinkDB.php └── UtilsTest.php COPYING # Shaarli license @@ -18,17 +24,18 @@ Here is the directory structure of Shaarli and the purpose of the different file ├── blazy.* # picture wall lazy image loading library ├── shaarli.css, reset.css # Shaarli stylesheet. ├── qr.* # qr code generation library - └──rain.tpl.class.php # RainTPL templating library - tpl/ # RainTPL templates for Shaarli. They are used to build the pages. + └── rain.tpl.class.php # RainTPL templating library images/ # Images and icons used in Shaarli - data/ # data storage: bookmark database, configuration, logs, banlist… - ├── config.php # Shaarli configuration (login, password, timezone, title…) + data/ # data storage: bookmark database, configuration, logs, banlist... + ├── config.json.php # Shaarli configuration (login, password, timezone, title...) ├── datastore.php # Your link database (compressed). ├── ipban.php # IP address ban system data ├── lastupdatecheck.txt # Update check timestamp file - └──log.txt # login/IPban log. + └── log.txt # login/IPban log. + tpl/ # RainTPL templates for Shaarli. They are used to build the pages. cache/ # thumbnails cache # This directory is automatically created. You can erase it anytime you want. tmp/ # Temporary directory for compiled RainTPL templates. # This directory is automatically created. You can erase it anytime you want. + vendor/ # Third-party dependencies. This directory is created by Composer ``` -- cgit v1.2.3 From 48679a159ed2e419f207d0be2e03e1a4f0e24f1d Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Wed, 14 Feb 2018 22:02:34 +0100 Subject: doc: update references to config(.json)?.php Closes https://github.com/shaarli/Shaarli/issues/1082 Signed-off-by: VirtualTam --- doc/md/Plugins.md | 4 ++-- doc/md/Troubleshooting.md | 18 +++++++----------- doc/md/Upgrade-and-migration.md | 11 +++++++---- 3 files changed, 16 insertions(+), 17 deletions(-) (limited to 'doc/md') 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) in html +// FIXME: Decode charset according to charset specified in either 1) HTTP response headers or 2) 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 :-( ) - -### Problems on CentOS servers - -On **CentOS**/RedHat derivatives, you may need to install the `php-mbstring` package. +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 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 +(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 -- cgit v1.2.3