Browse Source

Updated docs

Sergio Brighenti 5 years ago
parent
commit
50051b3691
4 changed files with 24 additions and 8 deletions
  1. 6 6
      README.md
  2. 16 0
      docs/common_issues.md
  3. 1 1
      docs/index.md
  4. 1 1
      docs/license.md

+ 6 - 6
README.md

@@ -7,6 +7,12 @@
 
 
 XBackBone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support.
 XBackBone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support.
 
 
+
+## Documentation
+All the installations, configuration, and usage instructions are available in the GitHub Pages:
+
+[XBackBone Documentation](https://sergix44.github.io/XBackBone/)
+
 ## Main Features
 ## Main Features
 
 
 + Supports every upload type from ShareX.
 + Supports every upload type from ShareX.
@@ -36,12 +42,6 @@ XBackBone is a simple, self-hosted, lightweight PHP file manager that support th
 + Tag uploads with custom tags for categorization.
 + Tag uploads with custom tags for categorization.
 + ... and more.
 + ... and more.
 
 
-## Documentation
-All the installations, configuration, and usage instructions are available in the GitHub Pages:
-
-[XBackBone Docs](https://sergix44.github.io/XBackBone/)
-
-
 ## License
 ## License
 This software is licensed under the <a href="https://choosealicense.com/licenses/agpl-3.0/">GNU Affero General Public License v3.0</a>, available in this repository.
 This software is licensed under the <a href="https://choosealicense.com/licenses/agpl-3.0/">GNU Affero General Public License v3.0</a>, available in this repository.
 As a "copyright notice" it is sufficient to keep the small footer at the bottom of the page, also to help other people to learn about this project!
 As a "copyright notice" it is sufficient to keep the small footer at the bottom of the page, also to help other people to learn about this project!

+ 16 - 0
docs/common_issues.md

@@ -0,0 +1,16 @@
+---
+layout: default
+title: Common Issues
+nav_order: 7
+---
+
+# Common Issues
+
+#### Error 404 after installation
+If you have apache, check if it's reading the file `.htaccess` and the `mod_rewrite` is enabled.
+
+#### [Discord, Telegram, ...] is not showing the image/video preview of the link.
+If you have Cloudflare enabled, check if it's blocking bots. If this function is enabled the Discord bot, Telebot, etc that fetch the preview will be blocked.
+
+#### How to increase the max file size?
+Increase the post_max_size and upload_max_filesize in your php.ini

+ 1 - 1
docs/index.md

@@ -50,6 +50,6 @@ You can help translating the project on [Weblate](https://hosted.weblate.org/pro
 <img src="https://hosted.weblate.org/widgets/xbackbone/-/xbackbone/multi-auto.svg" alt="Stato traduzione" />
 <img src="https://hosted.weblate.org/widgets/xbackbone/-/xbackbone/multi-auto.svg" alt="Stato traduzione" />
 </a>
 </a>
 
 
-
+#### Demo GIF
 
 
 ![img](https://i.imgur.com/iV8Rirn.gif)
 ![img](https://i.imgur.com/iV8Rirn.gif)

+ 1 - 1
docs/license.md

@@ -1,7 +1,7 @@
 ---
 ---
 layout: default
 layout: default
 title: License & Credits
 title: License & Credits
-nav_order: 7
+nav_order: 8
 ---
 ---
 
 
 # License
 # License