diff --git a/doc/Community-&-Related-software.html b/doc/Community-&-Related-software.html index accbacdc..cbc73d54 100644 --- a/doc/Community-&-Related-software.html +++ b/doc/Community-&-Related-software.html @@ -81,10 +81,11 @@

Third party plugins

Themes

See Theming for the list of community-contributed themes, and an installation guide.

@@ -95,7 +96,7 @@

Server apps

  • Shaarlo - An aggregator for shaarlis with many features (a very popular running instance among french shaarliers: shaarli.fr)
  • Shaarlimages - An image-oriented aggregator for Shaarlis
  • mknexen/shaarli-api - A REST API for Shaarli
    • -
  • Self dead link - Detect dead links on shaarli. This version use the database of shaarli. An another version, can be used for others shaarli (but use most ressources).
    • +
  • Self dead link - Detect dead links on shaarli. This version use the database of shaarli. Another version, can be used for other shaarli instances (but is more resource consuming).

    • Mobile Apps

    +

    GitHub release draft and CHANGELOG.md

    +

    See http://keepachangelog.com/en/0.3.0/ for changelog formatting.

    +

    GitHub release draft

    +

    GitHub allows drafting the release note for the upcoming release, from the Releases page. This way, the release note can be drafted while contributions are merged to master.

    +

    CHANGELOG.md

    +

    This file should contain the same information as the release note draft for the upcoming version.

    +

    Update it to:

    + +
    $ cd /path/to/shaarli
+
+$ nano CHANGELOG.md
+
+[...][](.html)
+## vA.B.C - UNRELEASED
+TBA
+
+## [vX.Y.Z](https://github.com/shaarli/Shaarli/releases/tag/vX.Y.Z) - YYYY-MM-DD[](.html)
+[...][](.html)

    Increment the version code, create and push a signed tag

    Bump Shaarli's version

    $ cd /path/to/shaarli
@@ -165,7 +191,16 @@ 
    Verify a signed tag
    
 $ git verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
 gpg: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
 gpg: Good signature from "VirtualTam <virtualtam@flibidi.net>" [ultimate][](.html)
    -

    Generate and upload all-in-one release archives

    +

    Publish the GitHub release

    +

    Create a GitHub release from a Git tag

    +

    From the previously drafted release:

    + +

    Generate and upload all-in-one release archives

    Users with a shared hosting may have:

    -

    For all following examples, a development configuration will be used:

    +

    For all following configuration examples, this user/group pair will be used:

    @@ -251,6 +254,24 @@

    Common setup

    http { [...][](.html) } +

    (Optional) Increase the maximum file upload size

    +

    Some bookmark dumps generated by web browsers can be huge due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.

    +

    To increase upload size, you will need to modify both nginx and PHP configuration:

    +
    # /etc/nginx/nginx.conf
+
+http {
+    [...][](.html)
+
+    client_max_body_size 10m;
+
+    [...][](.html)
+}
    +
    # /etc/php5/fpm/php.ini
+
+[...][](.html)
+post_max_size = 10M
+[...][](.html)
+upload_max_filesize = 10M

    Minimal

    WARNING: Use for development only!

    user john users;
@@ -350,6 +371,11 @@ 
    Modular
    
             error_log   /var/log/nginx/shaarli.error.log;
         }
 
+        location = /shaarli/favicon.ico {
+            # serve the Shaarli favicon from its custom location
+            alias /var/www/shaarli/images/favicon.ico;
+        }
+
         include deny.conf;
         include static_assets.conf;
         include php.conf;
@@ -403,6 +429,11 @@ 
    Redirect HTTP to HTTPS
    
             error_log   /var/log/nginx/shaarli.error.log;
         }
 
+        location = /shaarli/favicon.ico {
+            # serve the Shaarli favicon from its custom location
+            alias /var/www/shaarli/images/favicon.ico;
+        }
+
         include deny.conf;
         include static_assets.conf;
         include php.conf;
diff --git a/doc/Server-configuration.md b/doc/Server-configuration.md
index 1ab57a0a..df10feb2 100644
--- a/doc/Server-configuration.md
+++ b/doc/Server-configuration.md
@@ -102,6 +102,12 @@ See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache)
 
 ```
 
+### .htaccess
+
+Shaarli use `.htaccess` Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive `AllowOverride All` in your virtual host configuration for them to work.
+
+**Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled.[](.html)
+
 ## LightHttpd
 
 ## Nginx
@@ -136,7 +142,7 @@ On a development server:
 - files may be located in a user's home directory
 - in this case, make sure both Nginx and PHP-FPM are running as the local user/group!
 
-For all following examples, a development configuration will be used:
+For all following configuration examples, this user/group pair will be used:
 - `user:group = john:users`,
 
 which corresponds to the following service configuration:
@@ -160,6 +166,32 @@ http {
 }
 ```
 
+### (Optional) Increase the maximum file upload size
+Some bookmark dumps generated by web browsers can be _huge_ due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.
+
+To increase upload size, you will need to modify both nginx and PHP configuration:
+
+```nginx
+# /etc/nginx/nginx.conf
+
+http {
+    [...][](.html)
+
+    client_max_body_size 10m;
+
+    [...][](.html)
+}
+```
+
+```ini
+# /etc/php5/fpm/php.ini
+
+[...][](.html)
+post_max_size = 10M
+[...][](.html)
+upload_max_filesize = 10M
+```
+
 ### Minimal
 _WARNING: Use for development only!_ 
 
@@ -271,6 +303,11 @@ http {
             error_log   /var/log/nginx/shaarli.error.log;
         }
 
+        location = /shaarli/favicon.ico {
+            # serve the Shaarli favicon from its custom location
+            alias /var/www/shaarli/images/favicon.ico;
+        }
+
         include deny.conf;
         include static_assets.conf;
         include php.conf;
@@ -328,6 +365,11 @@ http {
             error_log   /var/log/nginx/shaarli.error.log;
         }
 
+        location = /shaarli/favicon.ico {
+            # serve the Shaarli favicon from its custom location
+            alias /var/www/shaarli/images/favicon.ico;
+        }
+
         include deny.conf;
         include static_assets.conf;
         include php.conf;
diff --git a/doc/Theming.html b/doc/Theming.html
index 13e6acf0..7cbf7aef 100644
--- a/doc/Theming.html
+++ b/doc/Theming.html
@@ -119,19 +119,20 @@ 
    RainTPL template
    
 
-
  • Edit data/config.php to have Shaarli use this template, e.g.
    
-
    $GLOBALS['config'['RAINTPL_TPL'] = 'tpl/my-template/';]('RAINTPL_TPL']-=-'tpl/my-template/';.html)
    • 
+
  • Edit data/config.json.php to have Shaarli use this template, in "resource" e.g.
    
+
    "raintpl_tpl": "tpl\/my-template\/",
    • 
 
 
    Community themes & templates
    
 
 
    Example installation: AlbinoMouse template
    
diff --git a/doc/Theming.md b/doc/Theming.md
index 7fb8d927..a21899c2 100644
--- a/doc/Theming.md
+++ b/doc/Theming.md
@@ -16,20 +16,21 @@ _WARNING - This feature is currently being worked on and will be improved in the
 - Find it's git clone URL or download the zip archive for the template.
 - In your Shaarli `tpl/` directory, run `git clone https://url/of/my-template/` or unpack the zip archive.
     - There should now be a `my-template/` directory under the `tpl/` dir, containing directly all the template files.
-- Edit `data/config.php` to have Shaarli use this template, e.g.
-```php
-$GLOBALS['config'['RAINTPL_TPL'] = 'tpl/my-template/';]('RAINTPL_TPL']-=-'tpl/my-template/';.html)
+- Edit `data/config.json.php` to have Shaarli use this template, in `"resource"` e.g.
+```json
+"raintpl_tpl": "tpl\/my-template\/",
 ```
 
 ## Community themes & templates
 - [AkibaTech/Shaarli Superhero Theme](https://github.com/AkibaTech/Shaarli---SuperHero-Theme) - A template/theme for Shaarli[](.html)
 - [alexisju/albinomouse-template](https://github.com/alexisju/albinomouse-template) - A full template for Shaarli[](.html)
+- [ArthurHoaro/shaarli-launch](https://github.com/ArthurHoaro/shaarli-launch) - Customizable Shaarli theme.[](.html)
 - [dhoko/ShaarliTemplate](https://github.com/dhoko/ShaarliTemplate) - A template/theme for Shaarli[](.html)
 - [kalvn/shaarli-blocks](https://github.com/kalvn/shaarli-blocks) - A template/theme for Shaarli[](.html)
 - [kalvn/Shaarli-Material](https://github.com/kalvn/Shaarli-Material) - A theme (template) based on Google's Material Design for Shaarli, the superfast delicious clone.[](.html)
+- [ManufacturaInd/shaarli-2004licious-theme](https://github.com/ManufacturaInd/shaarli-2004licious-theme) - A template/theme as a humble homage to the early looks of the del.icio.us site.[](.html)
 - [misterair/Limonade](https://github.com/misterair/limonade) - A fork of (legacy) Shaarli with a new template[](.html)
 - [mrjovanovic/serious-theme-shaarli](https://github.com/mrjovanovic/serious-theme-shaarli) - A serious theme for SHaarli.[](.html)
-- [Vinm/Blue-theme-for Shaarli](https://github.com/Vinm/Blue-theme-for-Shaarli) - A template/theme for Shaarli ([unmaintained](https://github.com/Vinm/Blue-theme-for-Shaarli/issues/2), compatibility unknown)[](.html)
 - [vivienhaese/shaarlitheme](https://github.com/vivienhaese/shaarlitheme) - A Shaarli fork meant to be run in an openshift instance[](.html)
 
 ### Example installation: AlbinoMouse template
diff --git a/index.php b/index.php
index fdbdfaa2..cc448352 100644
--- a/index.php
+++ b/index.php
@@ -1,6 +1,6 @@
  /shaarli/
 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+strrpos($_SERVER['REQUEST_URI'], '/', 0)));
diff --git a/shaarli_version.php b/shaarli_version.php
index eaab95c6..431387bb 100644
--- a/shaarli_version.php
+++ b/shaarli_version.php
@@ -1 +1 @@
-
+