https://github.com/gamepowerx/kekupload-server
A backend providing a HTTP REST like interface for uploading files written in rust.
https://github.com/gamepowerx/kekupload-server
backend files http kekupload rest-api rust share upload
Last synced: 10 months ago
JSON representation
A backend providing a HTTP REST like interface for uploading files written in rust.
- Host: GitHub
- URL: https://github.com/gamepowerx/kekupload-server
- Owner: GamePowerX
- License: mit
- Created: 2022-02-06T08:22:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-25T19:18:14.000Z (about 2 years ago)
- Last Synced: 2025-04-03T23:06:46.262Z (about 1 year ago)
- Topics: backend, files, http, kekupload, rest-api, rust, share, upload
- Language: Rust
- Homepage: https://gamepowerx.com/kekupload-server/
- Size: 296 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
██╗ ██╗███████╗██╗ ██╗██╗ ██╗██████╗ ██╗ ██████╗ █████╗ ██████╗
██║ ██╔╝██╔════╝██║ ██╔╝██║ ██║██╔══██╗██║ ██╔═══██╗██╔══██╗██╔══██╗
█████╔╝ █████╗ █████╔╝ ██║ ██║██████╔╝██║ ██║ ██║███████║██║ ██║
██╔═██╗ ██╔══╝ ██╔═██╗ ██║ ██║██╔═══╝ ██║ ██║ ██║██╔══██║██║ ██║
██║ ██╗███████╗██║ ██╗╚██████╔╝██║ ███████╗╚██████╔╝██║ ██║██████╔╝
╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═╝╚═════╝
kekupload-server
```
A backend providing a HTTP REST like interface for uploading files written in [rust](https://www.rust-lang.org/).
[API Documentation](https://gamepowerx.com/kekupload-server/docs/api/)
## License
This project is licensed under the [Mit License](https://mit-license.org/)
## Features
1. Rest api
2. Chunked uploading
3. Embeds
## Clients
- [kekupload-client client (svelte)](https://github.com/GamePowerX/kekupload-client)
- [KekUploadCLIClient (C#)](https://github.com/CraftingDragon007/KekUploadCLIClient)
## Libraries
- [kekupload-lib-ts (typescript)](https://github.com/GamePowerX/kekupload-lib-ts)
- [KekUploadLibrary (C#)](https://github.com/CraftingDragon007/KekUploadLibrary)
You have created your own client/library for [kekupload-server](https://gamepowerx.com/kekupload-server)? Great! Just submit an client request in the issues tab of github or write us an email at [info@gamepowerx.com](mailto:info@gamepowerx.com).
## Usage
### Docker
Get a prebuilt image [here](https://github.com/GamePowerX/kekupload-server/pkgs/container/uploadserver)
or build it yourself:
```
docker build -t uploadserver:latest
```
**Running**
prebuilt:
```
sudo docker run -ti ghcr.io/kotwoss/uploadserver:main
```
selfbuilt:
```
sudo docker run -ti uploadserver:latest
```
### Prerequirements
- Rust Nightly
You need [rustup](https://rustup.rs/) to run this.
```sh
rustup default nightly
```
### Configuration
Copy default.env to .env and change the settings in .env.
### Building
```sh
cargo build --release
```
The executable will be located at `target/release/uploadserver`
### Testing
If you are developing and don't want to rebuild and run the client to release mode use
```sh
cargo run
```
## Goals
- Image compression
If you have aditional ideas how to make this tool better please create a feature request in the issues tab.
## Contributing
More information [here](https://gamepowerx.com/kekupload-server/CONTRIBUTE).