Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cypher-o/windrop-server-side

Windrop is a file sharing app that allows you to easily upload and download files, just like an Airdrop service. Quickly share your files with others via simple HTTP requests—no complicated setup required!
https://github.com/cypher-o/windrop-server-side

airdrop api rust share

Last synced: 24 days ago
JSON representation

Host: GitHub
URL: https://github.com/cypher-o/windrop-server-side
Owner: Cypher-O
License: mit
Created: 2024-11-16T22:14:11.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-11-24T23:00:58.000Z (about 1 month ago)
Last Synced: 2024-11-24T23:27:14.971Z (about 1 month ago)
Topics: airdrop, api, rust, share
Language: Rust
Homepage:
Size: 69.3 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Windrop - File Upload Service with Rate Limiting and Logging Middleware

## Overview

Windrop is an Actix Web-based file upload service that allows users to upload files with rate limiting and request logging. The service integrates several key features:

- **File Upload**: Handles multipart file uploads and stores them on disk.
- **File Retrieval**: Retrieves and streams files from disk, allowing users to download files by their ID.
- **Rate Limiting**: Protects the server from abuse by limiting the number of requests per client IP.
- **Request Logging**: Logs HTTP request details including status codes and response times.

This project aims to provide a simple and effective file upload service with essential protections for handling large traffic volumes.

## Features

- **Rate Limiting**: Limits the number of requests per client IP within a given time window (e.g., 100 requests per minute).
- **File Upload**: Allows users to upload files, which are stored in a configurable storage directory.
- **File Download**: Users can retrieve files using a unique file ID.
- **Logging**: Logs all incoming HTTP requests, including method, path, status code, and response time.
- **Error Handling**: Returns appropriate error responses when upload or file retrieval fails.

## Installation

To install and run this project locally, follow the steps below:

### Prerequisites

- Rust (1.70.0 or later)
- Actix Web (4.0 or later)
- Tokio
- Actix Multipart

### Steps

1. Clone the repository:

```bash
git clone https://github.com/yourusername/windrop.git
cd windrop
```

2. Build the project:

```bash
cargo build
```

3. Run the server:

```bash
cargo run
```

The server will start at `http://127.0.0.1:8080`.

4. You can now test the rate-limiting and file upload functionality by making requests to the `/upload` and `/files/{id}` endpoints.

## Configuration

You can customize the rate-limiting behavior by adjusting the `max_requests` and `window_duration` when creating the `RateLimiter`.

- **`max_requests`**: The maximum number of requests allowed per client IP within the time window.
- **`window_duration`**: The duration of the time window in which requests are counted (e.g., 1 minute, 10 seconds).

### Example Rate Limiting Configuration

```rust
let rate_limiter = RateLimiter::new(100, Duration::from_secs(60));
```

## API Endpoints

### Upload a File

- **Endpoint**: `/api/upload`
- **Method**: `POST`
- **Description**: Uploads a file and stores it on the server.
- **Request**: Multipart form-data containing the file.
- **Response**: Returns a JSON response with the status and file metadata if successful, or an error message if the upload fails.

## Contributing

- We welcome contributions! If you'd like to contribute to Windrop, please fork the repository, create a new branch, and submit a pull request with your changes. Be sure to include a description of the changes in your PR.

## License

- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.