Weave Code
Flysystem Dropbox Laravel Package
spatie/flysystem-dropbox
Flysystem adapter for Dropbox using Dropbox API v2. Connect via an authorization token and use the Spatie Dropbox client with a Flysystem Filesystem. Supports modern Flysystem versions (v2/3); see v1 branch for Flysystem v1.
A flysystem driver for Dropbox that uses the v2 API
Frequently asked questions about Flysystem Dropbox
- How do I configure the Dropbox adapter in Laravel’s filesystem configuration?
- Add a new disk entry in `config/filesystems.php` with the `dropbox` driver. Specify your Dropbox OAuth2 token, app key, secret, and optional team ID. Example: `'dropbox' => ['driver' => 'dropbox', 'token' => env('DROPBOX_TOKEN'), 'key' => env('DROPBOX_KEY')]`. Then reference it via `Storage::disk('dropbox')`.
- Does this package support Dropbox team accounts and shared folders?
- Yes, the package supports Dropbox team accounts by including a `team_id` in the configuration. Shared folders can be accessed by specifying the correct path (e.g., `/Shared/Folder/file.txt`). Ensure your app’s OAuth2 token has the necessary permissions for team access.
- What Laravel versions are compatible with spatie/flysystem-dropbox?
- This package is framework-agnostic but works seamlessly with Laravel 8.x, 9.x, and 10.x. It requires PHP 8.0+. For older Laravel versions (7.x), ensure compatibility with Flysystem v2 and the Dropbox SDK v2.
- How do I handle large file uploads to Dropbox without hitting API rate limits?
- Use Laravel’s queue system to offload uploads to background jobs. For large files, implement chunked uploads manually via the Dropbox SDK, as the adapter doesn’t support streaming natively. Monitor API rate limits (500 requests/10 seconds) and implement retry logic with exponential backoff.
- Can I use this package for production without caching metadata?
- While the package doesn’t include built-in caching, you can cache metadata (e.g., file listings) using Laravel’s cache system or Redis. Store results of `listContents()` calls to reduce API calls. For high-volume apps, consider caching shared links or file metadata separately.
- How do I generate a Dropbox OAuth2 token for authentication?
- Create a Dropbox app in the [Dropbox Developer Console](https://www.dropbox.com/developers/apps). Use the OAuth2 flow to generate a token for your account. For team accounts, ensure the app is installed at the team level. Store the token securely in your `.env` file (e.g., `DROPBOX_TOKEN`).
- What are the alternatives to spatie/flysystem-dropbox for Laravel?
- Alternatives include using the raw [Dropbox SDK](https://github.com/dropbox/dropbox-sdk-php) with custom Laravel logic or third-party packages like `league/flysystem-dropbox` (older Flysystem v1). However, Spatie’s package offers tighter Laravel integration, team account support, and active maintenance.
- How do I test Dropbox file operations in Laravel unit tests?
- Use mocking libraries like Mockery or VCR (e.g., `vcr.php`) to record and replay Dropbox API responses. For example, mock the `DropboxClient` to return static responses for file listings or uploads. Avoid hitting real APIs during tests to prevent rate limits.
- Will this package work if I need to migrate from Flysystem v1 to v2?
- No, this package requires Flysystem v2+. If your project uses Flysystem v1, switch to the [v1 branch of this package](https://github.com/spatie/flysystem-dropbox/tree/v1) or migrate to Flysystem v2. Spatie recommends upgrading for long-term compatibility.
- How do I create shared links for Dropbox files in Laravel?
- Use the Dropbox SDK directly via the `DropboxClient` instance. Example: `$sharedLink = $client->sharedLinks()->createSharedLinkWithSettings('/path/to/file');`. Store the link URL in your database or cache it for reuse. Note that shared links require additional permissions in your Dropbox app settings.
Weaver
How can I help you explore Laravel packages today?