readme.txt 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. === QDR Temporary Shared Storage ===
  2. Contributors: qdr
  3. Tags: file sharing, media, rest api, temporary storage, password protection
  4. Requires at least: 5.0
  5. Tested up to: 6.4
  6. Requires PHP: 7.2
  7. Stable tag: 1.0.0
  8. License: GPLv2 or later
  9. License URI: http://www.gnu.org/licenses/gpl-2.0.html
  10. WordPress plugin for temporary file sharing with REST API support and password protection.
  11. == Description ==
  12. QDR Temporary Shared Storage extends WordPress functionality by providing a REST API interface to upload temporary media files and share them via password-protected download links.
  13. = Key Features =
  14. * Upload large media files via REST API with chunked uploads
  15. * Password protection for all shared files
  16. * Automatic expiration of shared files
  17. * Download count tracking
  18. * Admin interface for managing shared files
  19. * Configurable storage limits
  20. * REST API for integration with external applications
  21. = REST API Endpoints =
  22. * `POST /wp-json/qdr-tss/v1/upload/init` - Initialize chunked upload
  23. * `POST /wp-json/qdr-tss/v1/upload/chunk` - Upload a file chunk
  24. * `POST /wp-json/qdr-tss/v1/upload/finalize` - Finalize upload and create shared file
  25. * `GET /wp-json/qdr-tss/v1/media/{id}` - Get shared file details
  26. * `PUT /wp-json/qdr-tss/v1/media/{id}` - Update shared file properties
  27. * `DELETE /wp-json/qdr-tss/v1/media/{id}` - Delete shared file
  28. * `GET /wp-json/qdr-tss/v1/media` - Get collection of shared files
  29. = Translations =
  30. * English
  31. == Installation ==
  32. 1. Upload the plugin files to the `/wp-content/plugins/qdr-temporary-shared-storage` directory, or install the plugin through the WordPress plugins screen directly.
  33. 2. Activate the plugin through the 'Plugins' screen in WordPress.
  34. 3. Configure the plugin settings in 'Settings > Shared Storage'.
  35. == Frequently Asked Questions ==
  36. = How do I use the REST API? =
  37. You need to include the API key in your requests as an HTTP header:
  38. ```
  39. X-Api-Key: your-api-key-here
  40. ```
  41. See the plugin settings page to view or generate your API key.
  42. = How large can uploaded files be? =
  43. The plugin supports files of any size through chunked uploads. The maximum total storage size can be configured in the settings.
  44. = How long are files kept? =
  45. Each file has configurable 'Active From' and 'Active To' dates. Files are automatically deleted after their expiration date. By default, files expire 30 days after upload.
  46. = Can I manually delete expired files? =
  47. Yes, you can manually purge expired files from the Settings > Shared Storage page.
  48. == Screenshots ==
  49. 1. Admin interface for managing shared files
  50. 2. Settings page
  51. 3. Download page
  52. == Changelog ==
  53. = 1.0.0 =
  54. * Initial release
  55. == Upgrade Notice ==
  56. = 1.0.0 =
  57. Initial release