165 lines
6.8 KiB
Markdown
165 lines
6.8 KiB
Markdown
|
|
# XBackBone 📤  [](https://travis-ci.org/SergiX44/XBackBone) [](http://bit.ly/XBackBoneDonate)
|
|
XBackBone is a simple, self-hosted, lightweight PHP backend for the instant sharing tool ShareX. 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 and past uploads history.
|
|
|
|
## Features
|
|
|
|
+ Supports every upload type from ShareX.
|
|
+ Low memory footprint.
|
|
+ Multiple backends support: Local storage, AWS S3, Google Cloud, Dropbox, FTP.
|
|
+ Code uploads syntax highlighting.
|
|
+ Video uploads player.
|
|
+ Files preview page.
|
|
+ Multi language support.
|
|
+ User management, multi user features and roles.
|
|
+ Public and private uploads.
|
|
+ Web UI for each user.
|
|
+ Logging system.
|
|
+ Auto config generator for ShareX.
|
|
+ Share to Telegram.
|
|
+ Linux client tools supported via a custom script.
|
|
+ Direct downloads using curl or wget commands.
|
|
|
|
## How to Install
|
|
XBackBone require PHP >= `7.1`, writable storage path and PDO, with installed the required extensions:
|
|
+ `php-sqlite3` for SQLite
|
|
+ `php-mysql` for MariaDB/MySQL
|
|
+ `php-gd`
|
|
+ `php-json`
|
|
+ `php-intl`
|
|
|
|
### Web installation
|
|
+ **[release, stable]** 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
|
|
+ **[release, stable]** 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**.
|
|
|
|
## How to update
|
|
Self-update (since v2.5) **[BETA]**:
|
|
+ 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.
|
|
|
|
#### Docker deployment
|
|
+ [Docker container](https://hub.docker.com/r/pe46dro/xbackbone-docker)
|
|
|
|
## Translations
|
|
You can help translating the project on [Weblate](https://hosted.weblate.org/projects/xbackbone/xbackbone/).
|
|
|
|
<a href="https://hosted.weblate.org/engage/xbackbone/?utm_source=widget">
|
|
<img src="https://hosted.weblate.org/widgets/xbackbone/-/xbackbone/multi-auto.svg" alt="Stato traduzione" />
|
|
</a>
|
|
|
|
## Changing themes
|
|
XBackBone supports all [bootswatch.com](https://bootswatch.com/) themes.
|
|
|
|
From the web UI:
|
|
+ Navigate to the web interface as admin -> System Menu -> Choose a theme from the dropdown.
|
|
|
|
From the CLI:
|
|
+ Run the command `php bin/theme` to see the available themes.
|
|
+ Use the same command with the argument name (`php bin/theme <THEME-NAME>`) to choose a theme.
|
|
+ If you want to revert back to the original bootstrap theme, run the command `php bin/theme default`.
|
|
|
|
*Clear the browser cache once you have applied.*
|
|
|
|
### 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"',
|
|
...
|
|
);
|
|
```
|
|
## ShareX Configuration
|
|
Once you are logged in, just go in your profile settings and download the ShareX config file for your account.
|
|
|
|
## Linux 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`.
|
|
|
|
*Note: XXX is the username of your XBackBone account.*
|
|
|
|
## Web server configuration notes
|
|
If you do not use Apache, or the Apache `.htaccess` is not enabled, set your web server so that the `static/` folder is the only one accessible from the outside, otherwise even private uploads and logs will be accessible!
|
|
|
|
You can find an example configuration `nginx.conf` in the project repository.
|
|
|
|
## Maintenance Mode
|
|
Maintenance mode is automatically enabled during an upgrade using the upgrade manager. You can activate it manually by adding in the configuration file this:
|
|
|
|
```php
|
|
return array(
|
|
...
|
|
'maintenance' => true,
|
|
);
|
|
```
|
|
|
|
## Animated Demo
|
|
|
|
|
|
## 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.
|
|
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!
|
|
|
|
## Built with
|
|
+ Slim 3, since `v2.0` (https://www.slimframework.com/) and some great PHP packages (Flysystem, Intervention Image, Twig, etc)
|
|
+ FlightPHP, up to `v1.x` (http://flightphp.com/)
|
|
+ Bootstrap 4 (https://getbootstrap.com/)
|
|
+ Font Awesome 5 (http://fontawesome.com)
|
|
+ ClipboardJS (https://clipboardjs.com/)
|
|
+ HighlightJS (https://highlightjs.org/)
|
|
+ JQuery (https://jquery.com/)
|
|
+ video.js (https://videojs.com/)
|