Skip to content

Latest commit

 

History

History
147 lines (103 loc) · 5.16 KB

README.md

File metadata and controls

147 lines (103 loc) · 5.16 KB
Raw

SWFT - Simple Web-based File Transfer

SWFT is a lightweight and user-friendly web-based file sharing service that allows you to quickly and securely share files with others. With SWFT, you can easily upload files, get shareable links, and even customize links for easy sharing.

Table of Contents

Features

  • Upload files and get shareable links.
  • Customize links with user-defined names.
  • Automatically delete files after a specified time period.
  • Supports sharing files with users who prefer command-line tools like curl or wget.

Getting Started

Follow these steps to set up and run SWFT on your server.

Prerequisites

  • Python 3.x
  • Flask (Python web framework)
  • pip (Python package manager)

Installation

Clone the SWFT repository to your server:

git clone https://github.com/nnisarggada/swft
cd swft

Create a Python virtual environment and activate it:

python -m venv env
source env/bin/activate

Install the required dependencies from the requirements.txt file:

pip install -r requirements.txt

Configuration

Edit the SWFT configuration in the .env or main.py file to customize settings such as the port, URL, folder for storing files, and the time until files are deleted. Modify the following variables as needed:

# -------------------------------------------------------------------
# The following .env file needs to be changed before running the app using following variables: [SMTP_x and UMAMI_x are optional to use for sending emails]
# -------------------------------------------------------------------

URL = "share.nnisarg.in" # URL of the hosted app
TEMP_FOLDER = "share_temp" # Folder where the files will stored temporarily
MAX_TEMP_FOLDER_SIZE = 50 # Maximum size of the temporary folder in GB (50GB)
DEFAULT_DEL_TIME = 3 # Time until files will be deleted in hours (3 hours)
MAX_CONTENT_LENGTH = 100 # Maximum file size allowed in MB (100MB)
MAX_DEL_TIME = 168 # Maximum time until files will be deleted in hours (24 hours)
UPLOAD_LOG_FILE = "upload.log" # Log file for uploads
ACCESS_LOG_FILE = "access.log" # Log file for access
MAX_LOG_ENTRIES = 500 # Maximum number of log entries for each log file
SMTP_SERVER = "smtp.gmail.com" # SMTP server URL without the protocol and port
SMTP_PORT = 587 # SMTP port
SMTP_USERNAME = "[email protected]"  # Replace with username
SMTP_FROM = "SWFT by Nnisarg Gada <[email protected]>" # Replace with your email
SMTP_PASSWORD = "yourpassword"  # Replace with your email password
UMAMI_SRC = "https://umami.ls/script.js" # Replace with your Umami script src
UMAMI_ID = "your_website_id" # Replace with your Umami website id
# -------------------------------------------------------------------

Running the App

Run the SWFT app by specifying the port number:

gunicorn -b 0.0.0.0:5000 main:app

Here, 5000 is the port on which the app will run. You can access the SWFT web interface in your web browser at http://localhost:5000.

Usage

You can use SWFT to perform the following actions:

Upload a File

  1. Click "Select a file" to choose a file from your local storage.
  2. Optionally, provide a custom link name.
  3. Click "Share" to upload the file and get a shareable link.

Share a File

Use the provided shareable link to access the uploaded file. Customize links for easier sharing.
The user also has an option to send the files directly to your email by providing the email id. (Wait for some time and check spam/junk folder too)

Delete Files

Uploaded files are automatically deleted after the specified time.

Command-Line Usage (curl/wget)

SWFT supports sharing files using command-line tools like curl or wget. For example:

curl -F "file=@/path/to/file" -F "link=my-secret-file" -F "time=3" -F "[email protected]" http://localhost:5000/

This will give a shareable URL to the file like http://localhost:5000/my-secret-file that will get deleted after the provided time.
The Email and the Link are optional to use. Time should be provided in hours not exceeding 168 Hrs (1 Week).

TODO

  • Add support for sending files via email.
  • Implement rate limiting to prevent abuse.
  • Add logging for email-related actions.
  • Develop an admin dashboard for managing uploads and monitoring usage.

License

This project is licensed under the GNU General Public License v3 - see the LICENSE file for details.

Contributing

We welcome contributions from the community! Please read our Contribution Guidelines for details on how to get started.

Code of Conduct

We maintain a Code of Conduct to ensure a welcoming and inclusive environment for all contributors and users.