A lightweight file manager with full ShareX support and more
Go to file
2018-10-14 01:30:53 +02:00
app Fixed gruntfile 2018-10-14 01:18:02 +02:00
bin Fixed gruntfile 2018-10-14 01:18:02 +02:00
bootstrap Doc blocks 2018-10-13 18:25:48 +02:00
logs Initial commit 2018-04-28 14:20:07 +02:00
resources Added popever to write the telegram message when sharing. 2018-10-13 13:09:02 +02:00
src Added popever to write the telegram message when sharing. 2018-10-13 13:09:02 +02:00
.gitignore Fix & improvements (#2) 2018-06-02 22:32:14 +02:00
.htaccess Initial commit 2018-04-28 14:20:07 +02:00
.travis.yml Docker container (#9) 2018-10-14 00:24:28 +02:00
CHANGELOG.md Release 1.3 2018-10-14 00:29:32 +02:00
composer.json Doc blocks 2018-10-13 18:25:48 +02:00
composer.lock Release 1.3 2018-10-14 00:29:32 +02:00
config.example.php Initial commit 2018-04-28 14:20:07 +02:00
Gruntfile.js Fixed gruntfile 2018-10-14 01:18:02 +02:00
index.php Initial commit 2018-04-28 14:20:07 +02:00
LICENSE Initial commit 2018-04-28 14:16:47 +02:00
package.json Added popever to write the telegram message when sharing. 2018-10-13 13:09:02 +02:00
README.md Update README.md 2018-10-14 01:30:53 +02:00
yarn.lock Fix & improvements (#2) 2018-06-02 22:32:14 +02:00

XBackBone 📤 Build Status

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.
  • User management, multi user features.
  • Public and private uploads.
  • Web UI for each user.
  • Logging system.
  • Auto config generator for ShareX.

How to Install

XBackBone require PHP >= 7.1, the composer package manager, writable storage path and PDO, with installed the required extensions (ex. php-sqlite3 for SQLite, php-gd and php-json):

  • [release, stable] Download latest release from GitHub: Latest Release
  • Extract the release zip to your document root.
  • Edit the config file:
cp config.example.php config.php

By default, XBackBone will use Sqlite as DB engine, and a storage dir in the current 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 raccomanded).

return [
	'base_url' => 'https://myaswesomedomain.com', // no trailing slash
	'storage_dir' => 'storage',
	'db' => [
		'connection' => 'sqlite',
		'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
php bin/migrate --install
  • Now just login with admin/admin, be sure to change these credentials after your first login.

Changing themes

XBackBone supports all bootswatch.com themes:

  • 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.

Docker deployment

ShareX Configuration

Once you are logged in, just go in your profile settings and download the ShareX config file for your account.

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! The NGINX configuration should be something like this:

# nginx configuration

location /app {
  return 403;
}

location /bin {
  return 403;
}

location /bootstrap {
  return 403;
}

location /resources {
  return 403;
}

location /storage {
  return 403;
}

location /vendor {
  return 403;
}

location /logs {
  return 403;
}

autoindex off;

location / {
  if (!-e $request_filename){
    rewrite ^(.*)$ /index.php break;
  }
}

Built with