docs

docs/basic_usage.md

@@ -0,0 +1,5 @@
+---
+layout: default
+title: Basic Usage
+nav_order: 6
+---

docs/clients.md

@@ -0,0 +1,25 @@
+---
+layout: default
+title: Clients
+nav_order: 5
+---
+
+# Clients Configuration
+
+## ShareX Configuration
+Once you are logged in, just go in your profile settings and download the ShareX config file for your account.
+
+## Linux/Mac Support
+Since ShareX does not support Linux, XBackBone can generate a script that allows you to share an item from any tool:
++ Login into your account
++ Navigate to your profile and download the Linux script for your account.
++ Place the script where you want (ex. in your user home: `/home/<username>`).
++ Add execution permissions (`chmod +x xbackbone_uploader_XXX.sh`)
++ Run the script for the first time to create the desktop entry: `./xbackbone_uploader_XXX.sh -desktop-entry`.
+
+Now, to upload a media, just use the right click on the file > "Open with ..." > search XBackBone Uploader (XXX) in the app list.
+You can use this feature in combination with tools like [Flameshot](https://github.com/lupoDharkael/flameshot), just use the "Open with ..." button once you have done the screenshot.
+
+The script requires `xclip`, `curl`, and `notify-send` on a desktop distribution.
+
+*Note: XXX is the username of your XBackBone account.*

docs/configuration.md

@@ -43,31 +43,11 @@ return array(
 
 By activating this function, it will not be possible for users logging in via ldap to reset the password from the application (for obvious reasons), and it will also be possible to bring existing users under LDAP authentication.
 
-### Change app install name
+## Change app install name
 Add to the `config.php` file an array element like this:
 ```php
 return array(
     'app_name' => 'This line will overwrite "XBackBone"',
     ...
 );
-```
-
-# Clients Configuration
-
-## ShareX Configuration
-Once you are logged in, just go in your profile settings and download the ShareX config file for your account.
-
-## Linux/Mac Support
-Since ShareX does not support Linux, XBackBone can generate a script that allows you to share an item from any tool:
-+ Login into your account
-+ Navigate to your profile and download the Linux script for your account.
-+ Place the script where you want (ex. in your user home: `/home/<username>`).
-+ Add execution permissions (`chmod +x xbackbone_uploader_XXX.sh`)
-+ Run the script for the first time to create the desktop entry: `./xbackbone_uploader_XXX.sh -desktop-entry`.
-
-Now, to upload a media, just use the right click on the file > "Open with ..." > search XBackBone Uploader (XXX) in the app list.
-You can use this feature in combination with tools like [Flameshot](https://github.com/lupoDharkael/flameshot), just use the "Open with ..." button once you have done the screenshot.
-
-The script requires `xclip`, `curl`, and `notify-send` on a desktop distribution.
-
-*Note: XXX is the username of your XBackBone account.*
+```

docs/index.md

@@ -4,9 +4,6 @@ title: Home
 nav_order: 1
 ---
 
-# XBackBone
-{: .fs-9 }
-
 <p align="center">
   <img src="img/xbackbone.png" width="400px">
 </p>

docs/installation.md

@@ -23,7 +23,9 @@ XBackBone require PHP >= `7.1`, with installed the required extensions:
 + Navigate to the webspace root (ex. `http://example.com/xbackbone`, this should auto redirect your browser to the install page `http://example.com/xbackbone/install/`)
 + Follow the instructions.
 
-### Manual installation
+For futher and advanced configurations, see the [configuration page](configuration.md).
+
+## Manual installation
 + Download latest release from GitHub: [Latest Release](https://github.com/SergiX44/XBackBone/releases/latest)
 + Extract the release zip to your document root.
 + Copy and edit the config file:

docs/upgrading.md

@@ -0,0 +1,20 @@
+---
+layout: default
+title: Upgrading
+nav_order: 4
+---
+
+# How to update
+##Self-update (since v2.5):
++ Navigate to the system page as admin.
++ Click the check for update button, and finally the upgrade button.
++ Wait until the browser redirect to the install page.
++ Click the update button.
++ Done.
+
+
+## Manual update:
++ Download and extract the release zip to your document root, overwriting any file.
++ Navigate to the `/install` path (es: `http://example.com/` -> `http://example.com/install/`)
++ Click the update button.
++ Done.