diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..9c4a1a7 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,5 @@ +--- +layout: default +title: Configuration +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 61822ee..acf99b7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,18 +4,16 @@ title: Home nav_order: 1 --- -## Welcome! +# XBackBone +{: .fs-9 } -

- -

- -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 and 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, pdf, and file downloading and uploading. Also have a web UI with multi user management, media gallery and search support. +{: .fs-6 .fw-300 } [Download](https://github.com/SergiX44/XBackBone/releases/latest){: .btn .btn-green } [GitHub](https://github.com/SergiX44/XBackBone){: .btn .btn-blue } -## Features +## Main Features + Supports every upload type from ShareX. + Config generator for ShareX. diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..4cd66a6 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,60 @@ +--- +layout: default +title: Installation +nav_order: 2 +--- + +# Installation + +### Prerequisites +XBackBone require PHP >= `7.1`, with installed the required extensions: ++ `php-sqlite3` for SQLite. ++ `php-mysql` for MariaDB/MySQL. ++ `php-gd` image manipualtion library. ++ `php-json` json file support. ++ `php-intl` internationalization functions. ++ `php-fileinfo` file related functions. ++ (optional) `php-ftp` to use the FTP remote storage driver. ++ (optional) `php-ldap` to use LDAP authentication. + +## Web installation ++ Download latest release from GitHub: [Latest Release](https://github.com/SergiX44/XBackBone/releases/latest) ++ Extract the release zip to your document root. ++ 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 ++ 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: +```sh +cp config.example.php config.php && nano config.php +``` +By default, XBackBone will use Sqlite3 as DB engine, and a `storage` dir in the main directory. You can leave these settings unchanged for a simple personal installation. +You must set the `base_url`, or remove it for get dynamically the url from request (not recommended). + +```php +return [ + 'base_url' => 'https://example.com', // no trailing slash + 'storage' => [ + 'driver' => 'local', + 'path' => 'storage', + ], + 'db' => [ + 'connection' => 'sqlite', // current support for sqlite and mysql + 'dsn' => 'resources/database/xbackbone.db', + 'username' => null, // username and password not needed for sqlite + 'password' => null, + ] +]; +``` ++ Finally, run the migrate script to setup the database + +```sh +php bin/migrate --install +``` ++ Delete the `/install` directory. ++ Now just login with `admin/admin`, **be sure to change these credentials after your first login**. + + +For futher and advanced configurations, see the [configuration page]('configuration.md'). \ No newline at end of file