Synology Install XBackBone With Portainer
XBackBone is a simple and lightweight PHP file manager that supports the instant sharing tool ShareX and *NIX systems
via @marius
Music
Relax while reading
Today, I’m sharing a great alternative for installing the latest version of XBackBone using Portainer. XBackBone is a lightweight PHP file manager that integrates seamlessly with ShareX and *NIX systems. It allows for instant sharing of images, GIFs, videos, code, formatted text, PDFs, and more. With its web UI, it supports multi-user management, a media gallery, and search functionality.
In this step-by-step guide, I’ll walk you through installing XBackBone on your Synology NAS using Docker and Portainer. 😊
This guide works perfectly with the latest XBackBone release
Step 1:
Step 2:
Install Text Editor via Synology “Package Center”. (Mandatory STEP.) If you already have Text Editor installed on your Synology NAS, skip this STEP.
Step 3:
Install Portainer using my step by step guide or marius's. If you already have Portainer installed on your Synology NAS, skip this STEP.
Attention: Make sure you have installed the latest Portainer version.
Step 4:
Make sure you have a synology.me Wildcard Certificate. Follow Marius' guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.
Step 5:
Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.
Step 6:
Now click the** “Create” **button. Follow the instructions in the image below.
Step 7:
After you click the Create button, the window below will open. Follow the instructions in the image below.
On the General area, set the Reverse Proxy Name description: type in XBackBone. After that, add the following instructions:
Step 8:
On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.
Step 9:
Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.
Step 10:
Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.
Step 11:
Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it xbackbone. Follow the instructions in the image below.
Step 12:
Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then** + Add stack**. Follow the instructions in the image below.
Step 13:
In the Name field type in xbackbone. Follow the instructions in the image below.
1services:
2 xbackbone:
3 container_name: XBackBone
4 image: ghcr.io/linuxserver/xbackbone:latest
5 security_opt:
6 - no-new-privileges:true
7 - seccomp:unconfined
8 healthcheck:
9 test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/80' || exit 1
10 interval: 10s
11 timeout: 5s
12 retries: 3
13 start_period: 90s
14 restart: on-failure:5
15 ports:
16 - 8522:80
17 - 4443:443
18 volumes:
19 - /volume1/docker/xbackbone:/config:rw
20 environment:
21 TZ: Europe/Bucharest // change to your own TimeZone and remove comments
22 PUID: 1026 // change to your own PUID
23 PGID: 100 // change to your own PGIDNote: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow marius' step by step guide on how to do this.)
Step 14:
Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.
Step 15:
If everything goes right, you will see the following message at the top right of your screen**: “Success Stack successfully deployed“.**
Step 16:
Now open your browser and type in your HTTPS/SSL certificate https://xbackbone.yourname.synology.me – If everything goes right, you will see the XBackBone installation page. In the Base URL field, type in https:// followed by your synology.me DDNS name instead of http:// – Add your own Admin email and your own Admin password, then click Install. Follow the instructions in the image below.
Step 17:
After you click Install at STEP 16, the installation process will take some minutes. After the installation is completed, you will be prompted to add your own Admin email and Admin password that you have previously created at STEP 16. Click Login. Follow the instructions in the image below.
Step 18:
Your XBackBone dashboard will look like this. Go to the next step.
Step 19:
Go to File Station / Docker / xbackbone / php folder
Double click on the php-local.ini file. Follow the instructions in the image below.
Note: If you can’t open the php-local.ini file, this means you haven’t followed STEP 2 in this article.
Step 20:
After the first line, copy paste these lines below, then save the file. Follow the instructions in the image below.
1upload_max_filesize = 5G
2post_max_size = 5G
3memory_limit = 1G
Step 21:
To apply the settings, Restart your XbackBone container in Portainer / Containers / Select your XBackBone container, then click Restart. Follow the instructions in the image below.
Step 22:
On the System tab, the three parameters, post_max_size, upload_max_filesize and memory_limit, are now showing the values that you have previously added at STEP 21. This change allows you to upload 5GB files instead of 2MB. You can easily change your Theme to Dark. Follow the instructions in the image below.
Step 23:
Upload some files from your computer. Follow the instructions in the image below.
Step 24:
Go to the Home tab. Use the Copy link option and share your files with your friends. Follow the instructions in the image below.
Step 25:
Share your file!
Extra Steps:
Integrations with ShareX app:
1- Go to your profile within XBackBone, generate your token and copy it.
2- After you copied the token, copy the correct code below, change the token placeholder.
1{
2 "Version": "17.0.0",
3 "Name": "My Config",
4 "DestinationType": "ImageUploader, TextUploader, FileUploader",
5 "RequestMethod": "POST",
6 "RequestURL": "https://yourdomain.tld/upload",
7 "Body": "MultipartFormData",
8 "Arguments": {
9 "file": "{filename}",
10 "text": "{input}",
11 "token": "token_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
12 },
13 "FileFormName": "upload",
14 "URL": "{json:url}",
15 "ThumbnailURL": "{json:url}/raw",
16 "DeletionURL": "{json:url}/delete/token_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
17}3- Finally, add the config with the correct token to ShareX custom upload config, and enjoy your free and self-hosted imgur service. Refer to the steps and images below:
- Click on Desitnations
- Then, click on Custom Uploader Settings
- Lastly, fill the details or simply use the code above, change the token and the file as config.sxcu
Thanks for reading
Marius
for their insightful post that inspired this content!You can check out their original content here: https://mariushosting.com/synology-install-xbackbone-with-portainer/