Fascinated/sharex-php-uploader
2
2
Fork 0
Code Issues 1 Pull Requests Actions Activity
This PHP script allows you to easily upload ShareX screenshots and videos. It includes token authentication for security and can handle various image file types by converting them to WebP format for efficient storage.
61 Commits 2 Branches 0 Tags 323 KiB
PHP 57.9%
Shell 16%
Dockerfile 14.7%
HTML 11.4%
a397881c08
Go to file
Fascinated a397881c08 re-add manual install steps
2023-07-04 21:23:51 +01:00
.gitea/workflows fix actions? 2023-07-04 17:58:13 +01:00
assets add logo asset 2023-07-04 18:08:45 +01:00
docker add dockerhub image 2023-07-04 17:56:28 +01:00
.dockerignore add docker 2023-07-04 16:32:18 +01:00
docker-compose.yml change image docker compose 2023-07-04 18:08:39 +01:00
Dockerfile i am silly 2023-07-04 17:15:53 +01:00
LICENSE add docker 2023-07-04 16:32:18 +01:00
README.md re-add manual install steps 2023-07-04 21:23:51 +01:00
sharex.sxcu rename uploader file 2023-07-04 18:26:45 +01:00
upload.php change default webp quality 2023-04-12 03:10:09 +01:00

README.md

ShareX Upload Script

This PHP script allows you to effortlessly upload your ShareX app screenshots to your website. ShareX is a widely-used Windows screenshot tool that enables users to take screenshots, annotate them, and share them online.

Features

  • Effortlessly upload screenshots to your website using ShareX.
  • Automatically convert screenshots to WebP format.

Requirements

  • Docker
  • ShareX

Installation

  1. Copy the docker-compose.yml file to your server.
  2. Edit the docker-compose.yml file and change MAX_UPLOAD_SIZE to the maximum file size you want to allow, and update ./uploads to where you want to store the files.
  3. Run docker-compose up -d to start the container.
  4. Go to where the files are stored and edit the variables in upload.php to your liking.
  5. Run docker-compose restart to restart the container.
  6. Go to Post Installation to configure ShareX.

Installation (Unraid)

  1. Install the container from Community Applications and then edit the variables in the container.
  2. Go to where the files are stored and edit the variables in upload.php to your liking.
  3. Restart the container.
  4. Go to Post Installation to configure ShareX.

Installation (Without Docker - Ubuntu)

This installation method is not recommended as I cannot provide instructions for every single Linux distribution. If you don't know what you're doing, use the Docker installation method.

  1. Verify that your web server has the GD library installed. If not, run sudo apt install php-gd to install it.
  2. Upload the upload.php file to your server.
  3. Edit the upload.php file to configure the script.
  4. Go to Post Installation to configure ShareX.

Post Installation

  1. Open ShareX and go to Destinations > Custom Uploader Settings.
  2. Click on Import > From URL and enter https://git.fascinated.cc/Fascinated/sharex-php-uploader/raw/branch/master/sharex.sxcu.
  3. Edit the URL to your website's URL.
  4. Click on Test after you've edited the URL and it should return a URL. If it doesn't, check your settings or contact me.

Need Help?

If you require assistance, feel free to contact me via Discord at fascinated7.

Other Information

This project is maintained on my Gitea instance: https://git.fascinated.cc/Fascinated/sharex-php-uploader