Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonpalmisc/filedrop
Minimal, CLI-friendly file transfer service
https://github.com/jonpalmisc/filedrop
cli curl file-sharing rust web
Last synced: 14 days ago
JSON representation
Minimal, CLI-friendly file transfer service
- Host: GitHub
- URL: https://github.com/jonpalmisc/filedrop
- Owner: jonpalmisc
- License: bsd-3-clause
- Created: 2022-12-21T17:49:21.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-07T19:36:21.000Z (over 1 year ago)
- Last Synced: 2025-01-12T13:56:12.461Z (22 days ago)
- Topics: cli, curl, file-sharing, rust, web
- Language: Python
- Homepage:
- Size: 61.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Filedrop
Filedrop is a minimal, CLI-friendly file transfer service. It is designed to
facilitate quick file uploads/downloads from the terminal.
## Security
This is alpha software at best. It was written in about 30 minutes. There are
ZERO security checks. It is your responsibility to sandbox Filedrop and/or
secure the environment it runs in. At a minumum, containerizing Filedrop with
Docker using the provided Dockerfile is recommended.
Do **NOT** use this in production yet. Seriously.
## Usage
Filedrop does not have a concept of accounts or users. Files are simply uploaded
using `curl`:
```sh
curl -T example.txt filedrop.example.org
```
Upon successfully uploading a file, the server should respond with the `curl`
command needed to retrieve the file; you can send this to the intended
recipient. A sample response is shown below.
```
curl http://filedrop.example.org/5WyQxQu6XAoh >example.txt
```
> The URL shown in the `curl` command can also be accessed via the browser.
## Deployment
To run Filedrop during development, the following should be sufficient:
```sh
poetry install
poetry run uvicorn filedrop:app
```
Alternatively, you may build and run the Docker image.
## License
Copyright © 2022–2023 Jon Palmisciano. All rights reserved.
Use of this source code is governed by the BSD 3-Clause license; a full copy of
the license can be found in the [LICENSE.txt](LICENSE.txt) file.