This commit is contained in:
parent
3c78628fc1
commit
0fc5115a27
37
README.md
37
README.md
@ -9,31 +9,36 @@ This PHP script allows you to effortlessly upload your ShareX app screenshots to
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- PHP (Tested on PHP 8.1.12-1ubuntu4)
|
- Docker
|
||||||
- GD Library (If using webp conversion)
|
- ShareX
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
To install this script:
|
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.
|
||||||
|
|
||||||
- Find a suitable location to host the script (with at least 5GB of storage).
|
## Installation (Unraid)
|
||||||
- Verify that your web server has the GD library installed. (See instructions below for Ubuntu installation.)
|
|
||||||
- Upload the files to your server.
|
1. Install the container from Community Applications and then edit the variables in the container.
|
||||||
- Edit the `upload.php` file to configure the script.
|
2. Go to where the files are stored and edit the variables in `upload.php` to your liking.
|
||||||
- Add the custom uploader to ShareX.
|
3. Restart the container.
|
||||||
- Configure the custom uploader in ShareX.
|
4. Go to Post Installation to configure ShareX.
|
||||||
- Test the script!
|
|
||||||
|
## 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?
|
## Need Help?
|
||||||
|
|
||||||
If you require assistance, feel free to contact me via Discord at `fascinated7`.
|
If you require assistance, feel free to contact me via Discord at `fascinated7`.
|
||||||
|
|
||||||
## How to Install GD Library on Ubuntu
|
|
||||||
|
|
||||||
- `sudo apt-get install php-gd`
|
|
||||||
- Add extension=gd to your php.ini file.
|
|
||||||
- Restart your web server and php.
|
|
||||||
|
|
||||||
## Other Information
|
## Other Information
|
||||||
|
|
||||||
This project is maintained on my Gitea instance: <https://git.fascinated.cc/Fascinated/sharex-php-uploader>
|
This project is maintained on my Gitea instance: <https://git.fascinated.cc/Fascinated/sharex-php-uploader>
|
||||||
|
Loading…
Reference in New Issue
Block a user