documentation: elaborate on REST API server & client prerequisites

Relates to https://github.com/shaarli/Shaarli/issues/903
Relates to https://github.com/shaarli/Shaarli/issues/905

Signed-off-by: VirtualTam <virtualtam@flibidi.net>

diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md
index f3f0b17aa00bc441bac3ef3d240f703fa7d4ec5a..0b8aba8a76f8e906dbee97bca69c34786fadf771 100644 (file)
--- a/doc/md/REST-API.md
+++ b/doc/md/REST-API.md
@@ -1,6 +1,18 @@
-## Usage
+## Usage and Prerequisites
 
-See the [REST API documentation](http://shaarli.github.io/api-documentation/).
+See the [REST API documentation](http://shaarli.github.io/api-documentation/)
+for a list of available endpoints and parameters.
+
+Please ensure that your server meets the [requirements](Server-requirements)
+and is properly [configured](Server-configuration):
+
+- URL rewriting is enabled (see specific Apache and Nginx sections)
+- the server's timezone is properly defined
+- the server's clock is synchronized with
+  [NTP](https://en.wikipedia.org/wiki/Network_Time_Protocol)
+
+The host where the API client is invoked should also be synchronized with NTP,
+see [token expiration](#payload).
 
 ## Authentication
 
@@ -43,9 +55,11 @@ ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==
 
 #### Payload
 
-**Validity duration**
+**Token expiration**
 
-To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key `iat` (issued at). This token will be accepted during 9 minutes.
+To avoid infinite token validity, JWT tokens must include their creation date
+in UNIX timestamp format (timezone independent - UTC) under the key `iat` (issued at).
+This token will be valid during **9 minutes**.
 
 ```json
 {

diff --git a/doc/md/Server-requirements.md b/doc/md/Server-requirements.md
index bec08e499bbf1cd77d03e06038d18aeb066da90f..707af7622b428589d716dbae0e8f79fd92538bba 100644 (file)
--- a/doc/md/Server-requirements.md
+++ b/doc/md/Server-requirements.md
@@ -18,6 +18,7 @@ Version | Status | Shaarli compatibility
 5.3 | EOL: 2014-08-14 | Yes (up to Shaarli 0.8.x)
 
 See also:
+
 - [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml)
 
 ### Dependency management