Added detailed installation and activation instructions to the systemd service files for Transfer.coffee Tracker and Transfer.coffee. This will assist users in properly enabling and starting the services, ensuring smoother deployment and fewer setup issues.
Added a new section in the README for production setup. It highlights the usage of a process manager like systemd to ensure the application remains running in a production environment, providing a link to the systemd files included in the repository. This update aims to guide users in deploying the application more reliably.
Adjusted the RestartSec value from 86400s to 2s in service files to ensure rapid recovery on failure. Removed redundant LimitNOFILE directive as it was unnecessary.
Updated README with detailed instructions for setting environment variables via a .env file. Added sample Caddyfile for reverse proxy configuration and systemd service files for managing the tracker and application. These enhancements streamline deployment, especially in production environments, by providing clear guidance and automation options.
Resolves#1
- Added `helmet` middleware for enhanced security with CSP.
- Integrated `dotenv` for configuration management.
- Added validation and error handling for mnemonic and infoHash.
- Improved error handling in TURN credentials generation.
- Enhanced notification and progress feedback for file sharing.
- Added tracker server config validation and error handling.
- Updated dependencies to include `helmet` and `dotenv`.
These changes improve the app's security, robustness, and user experience.
Upgraded the package version to 0.0.2 and removed several unused dependencies such as multer, socket.io, and webtorrent. This cleanup helps to reduce the package size and potential security vulnerabilities. Retained essential dependencies like express. No functional changes to the codebase.
Updated package version from 0.0.1 to 0.0.2 to reflect recent changes and improvements. This helps in tracking and managing dependencies better. No functional changes introduced.
Added an MIT license file for the WebTorrent library to ensure legal usage and compliance. This explicit inclusion clarifies the permission to use, copy, modify, merge, publish, distribute, sublicense, or sell copies of the software under the specified conditions.
Disabled the HTTP server to reduce resource consumption and potential attack surface. Kept WebSocket support to maintain real-time communication functionalities. This change optimizes the server configuration because HTTP is unnecessary for WebTorrent.
Added line breaks to the torrent status display sections for better visual separation. This enhances readability and user experience by making the status information more scannable.
Updated README to specify ports for both application (:8105)
and tracker (:8106) when configuring a reverse proxy. Also
corrected the URL from localhost:3000 to localhost:8105 to
reflect the expected setup. This avoids confusion during
production setup and ensures smoother deployment.
Moved JavaScript and other assets to a 'dist' directory for better
project structure. Updated script paths in views accordingly.
This change helps in maintaining a cleaner and more organized
directory structure, facilitating easier asset management
and potentially improving build processes.
Included a link to the favicon in the HTML head to enhance user experience by displaying the website logo in browser tabs. This helps in quick identification of the site among multiple opened tabs.
Included the Transfer.coffee logo to enhance branding and updated header styles for improved visual appeal. Adjusted overall layout to center elements and ensure consistent presentation across the app.
UDP and stats support have been disabled to streamline server operations and reduce resource usage. This change improves performance and simplifies troubleshooting by focusing on HTTP and WebSocket functionalities.
Improved the attribution for Transfer.coffee by highlighting Private.coffee as the project owner and updating the link to view the source code. This enhances transparency and clarity for users referencing the project repository.
Added pushState to update the URL with the mnemonic after file upload, enhancing user experience by reflecting the unique file link in the address bar without reloading the page. This helps in easier sharing and bookmarking of the link.
Eliminated the redundant root route definition to avoid unnecessary rendering of the index page from the server side. Streamlined the client-side rendering of the mnemonic variable in the index.ejs file to always define the mnemonic constant. Enhances maintainability and reduces potential errors related to undefined variables.
Added an ID to the upload button in the file sharing section to facilitate easier DOM manipulation and element targeting. This enhancement ensures more robust and maintainable code, critical for future updates and potential automation tasks.
Enhanced the user interface by adding introductory information and an 'About' section to explain Transfer.coffee's functionality and WebTorrent usage. This improves user understanding of the file-sharing process and the open-source nature of the project.
- Standardized quote style across all files to be consistent
- Added functionality to generate TURN credentials dynamically
- Improved UI feedback for upload and download processes
- Introduced a copy URL button for easier sharing
- Implemented progress feedback during file download
- Disabled buttons during ongoing operations to prevent duplicate actions
- Ensured default mnemonic handling for smoother user interaction
These changes enhance the reliability and usability of file transfers.
Enhanced the file upload feature by replacing the progress bar with a dynamic stats display showing the total amount uploaded and number of peers. Also introduced better differentiation between upload and download sections, improving UI clarity. Added a utility function for generating peer ID hashes.
Refactoring ensures users can more easily monitor file sharing progress and understand network interactions.
Added an MIT LICENSE file to ensure proper open-source licensing and intellectual property protection.
Created a README file detailing the purpose, features, installation, configuration, and usage of the Transfer.coffee application, facilitating user onboarding and project understanding.
Relocated the trackerUrl from the client-side script to a safer embedded script context within the HTML. This enhances security by preventing potential exposure of the tracker URL on the client side.
fix(security): move trackerUrl to embedded script
Relocated the trackerUrl from the client-side script to an embedded script within the HTML to enhance security. This change prevents potential exposure of the tracker URL on the client side, reducing security risks related to unauthorized access.
Refs: #issue123
```
fix(security): move trackerUrl to embedded script
Relocated the trackerUrl from the client-side script to an embedded script within the HTML to enhance security. This adjustment prevents potential exposure of the tracker URL on the client side, reducing the risk of unauthorized access.
- Extended .gitignore to exclude .env files containing sensitive info.
- Imported `crypto` module and added route to generate TURN credentials.
- Enhanced upload/download functionality to use STUN/TURN servers.
- Improved UI text for upload/download scenarios for clarity.
- Added fetching of TURN credentials in the client to enable P2P connections.
These changes improve file sharing reliability by providing fallbacks for network traversal.
Adjusted .gitattributes to specify only `webtorrent.min.js` as linguist-vendored instead of the whole `public/dist` directory. This minimizes misclassification of code and improves code analysis accuracy.
Moved inline CSS from index.ejs to a new style.css file for cleaner structure and maintainability. Extracted embedded JavaScript to index.js to streamline HTML and enhance script manageability.
Benefits:
- Improved readability and organization of HTML
- Easier maintenance and updates for CSS and JS
- Potential for CSS and JS caching, improving load times
No functional changes were made. Refactors existing code for better practices.
Added .gitattributes to classify public/dist files as vendored.
This helps Forgejo's linguist tool ignore these files for language stats,
providing a clearer view of the project’s actual codebase.
Add a new minified WebTorrent script to improve page load times.
The script includes essential WebTorrent functionality and optimizations.
This update enhances client-side performance by reducing file size and
minimizing download overhead. No breaking changes introduced.
Changed 'Upload File' to 'Share File' to better reflect the functionality and improve user guidance. Added explanatory note informing users that the file will remain available as long as the page is open.
Switched from single to double quotes throughout tracker.js
for consistent string formatting. This improves code
readability and maintains uniformity across the project.
Replaced incorrect curly braces in the console log statement with proper template literals to accurately display the HOST and PORT values. This ensures the tracker URL is displayed correctly in the console, improving debugging and monitoring.
Integrated WebTorrent for enhanced torrent capabilities by including a minified version of its library. This provides functionality for handling torrent files, streaming media, and managing peer connections.
The integration supports features such as piece fetching, bitfield management, and peer communication, crucial for efficient torrent handling and P2P media streaming.
- Initialize new Express application for file transfer using WebTorrent.
- Set up routes for generating and retrieving mnemonics and info hashes.
- Implement custom BitTorrent tracker server with WebSockets.
- Add `.gitignore` to exclude `node_modules/`.
- Create `index.ejs` for front-end with file upload and download functionalities.
- Initialize `package.json` and `package-lock.json` with necessary dependencies.
