https://github.com/team-tritan/sharex-host-v2
Tritan's ShareX Host is a self-hosted solution for managing and sharing images and URLs using ShareX. This project provides a web interface for uploading images, managing shortened URLs, and viewing upload statistics.
https://github.com/team-tritan/sharex-host-v2
cdn file file-hosting flameshot go golang sharex
Last synced: 3 months ago
JSON representation
Tritan's ShareX Host is a self-hosted solution for managing and sharing images and URLs using ShareX. This project provides a web interface for uploading images, managing shortened URLs, and viewing upload statistics.
- Host: GitHub
- URL: https://github.com/team-tritan/sharex-host-v2
- Owner: Team-Tritan
- License: apache-2.0
- Created: 2023-08-21T02:16:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T13:49:24.000Z (3 months ago)
- Last Synced: 2025-02-24T14:42:18.145Z (3 months ago)
- Topics: cdn, file, file-hosting, flameshot, go, golang, sharex
- Language: TypeScript
- Homepage: https://i.tritan.gg
- Size: 187 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
# Tritan ShareX Host
Tritan's ShareX Host is a self-hosted solution for managing and sharing images and URLs using ShareX. This project provides a web interface for uploading images, managing shortened URLs, and viewing upload statistics.
## Features
- **Image Uploading**: Easily upload images using the web interface or ShareX.
- **URL Shortening**: Create and manage shortened URLs.
- **User Authentication**: Secure access with API keys.
- **Upload Management**: View, delete, and manage uploaded images.
- **URL Management**: View, edit, and delete shortened URLs.
- **Statistics**: Track views and clicks for uploads and URLs.
- **User Management**: Delete your account, change your upload token, and change your display name.
- **ShareX Config Generation**: Download preconfigured ShareX uploader files based on the domains you select!
- **Responsive Design**: Mobile-friendly interface (mostly).
## Getting Started
### Prerequisites
- [Go](https://golang.org/dl/) (version 1.21 or higher)
- [MongoDB](https://www.mongodb.com/try/download/community) (version 7.0 or higher)
- [Docker](https://get.docker.com)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/Team-Tritan/ShareX-Host-v2.git
cd ShareX-Host-v2
```
2. Install docker.
3. Set up the configuration:
Fill in the config/config.go file with applicable settings.
4. Run the server and frontend:
```sh
sudo docker compose up
```
5. Open your browser and navigate to `http://localhost:3000`.
### Usage
1. **Login**: Enter your API key to log in.
2. **Upload Images**: Drag and drop images to upload or use the ShareX configuration.
3. **Manage Uploads**: View, delete, and manage your uploaded images.
4. **Shorten URLs**: Create and manage shortened URLs.
5. **View Statistics**: Track views and clicks for your uploads and URLs.
### Configuration
To configure ShareX for image uploading and URL shortening, use the provided configuration links in the web interface.
### API Endpoints
- **Generate ShareX Config**: `/api/config`
- **Upload Image**: `/api/upload`
- **Get Uploads**: `/api/uploads`
- **Delete Upload**: `/api/delete-upload/{slug}`
- **Create URL**: `/api/create-url`
- **Get URLs**: `/api/urls`
- **Delete URL**: `/api/delete-url/{slug}`
- **Update URL Slug**: `/api/url/{slug}`
### Images
[Image 1](https://s3.tritan.gg/images/FuyRJyWyZu.png)
[Image 2](https://s3.tritan.gg/images/mb5vHE4hMb.png)
[Image 3](https://s3.tritan.gg/images/DLYmqGgyGY.png)
[Image 4](https://s3.tritan.gg/images/HsQXSHK16j.png)
[Image 5](https://s3.tritan.gg/images/s2XVOmijvo.png)
### Contributing
Contributions are welcome! Please open an issue or submit a pull request.
### License
This project is licensed under the Apache License.
### Acknowledgements
- [ShareX](https://getsharex.com/)
- [Tailwind CSS](https://tailwindcss.com/)
- [jQuery](https://jquery.com/)
- [MongoDB](https://www.mongodb.com/)