From 50051b36912183d7d346f7d6a2d606323827c7a9 Mon Sep 17 00:00:00 2001 From: Sergio Brighenti Date: Thu, 2 Apr 2020 19:07:35 +0200 Subject: [PATCH] Updated docs --- README.md | 12 ++++++------ docs/common_issues.md | 16 ++++++++++++++++ docs/index.md | 2 +- docs/license.md | 2 +- 4 files changed, 24 insertions(+), 8 deletions(-) create mode 100644 docs/common_issues.md diff --git a/README.md b/README.md index 308e035..94e1401 100644 --- a/README.md +++ b/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. + +## Documentation +All the installations, configuration, and usage instructions are available in the GitHub Pages: + +[XBackBone Documentation](https://sergix44.github.io/XBackBone/) + ## Main Features + 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. + ... and more. -## Documentation -All the installations, configuration, and usage instructions are available in the GitHub Pages: - -[XBackBone Docs](https://sergix44.github.io/XBackBone/) - - ## License This software is licensed under the GNU Affero General Public License v3.0, 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! diff --git a/docs/common_issues.md b/docs/common_issues.md new file mode 100644 index 0000000..eb622da --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 6ff89be..0c23008 100644 --- a/docs/index.md +++ b/docs/index.md @@ -50,6 +50,6 @@ You can help translating the project on [Weblate](https://hosted.weblate.org/pro Stato traduzione - +#### Demo GIF ![img](https://i.imgur.com/iV8Rirn.gif) \ No newline at end of file diff --git a/docs/license.md b/docs/license.md index ab4086b..7cb8062 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,7 +1,7 @@ --- layout: default title: License & Credits -nav_order: 7 +nav_order: 8 --- # License