Provides a Dropbox driver for TYPO3 File Abstraction Layer.
See how EXT:dropbox looks like in action.
Explains how to install this extension in Composer-based and Classic TYPO3 installations.
Learn how to configure this extension.
These questions have been frequently asked.
This extension adds a Dropbox FAL driver to TYPO3. With that driver you can browse, modify and delete files from your Dropbox account.
If your TYPO3 installation works in composer mode, please execute following command:
composer req stefanfroemken/dropbox
vendor/bin/typo3 extension:setup --extension=dropboxIf you work with DDEV please execute this command:
ddev composer req stefanfroemken/dropbox
ddev exec vendor/bin/typo3 extension:setup --extension=dropboxOn non composer based TYPO3 installations you can install dropbox still
over the ExtensionManager:
Login
Login to backend of your TYPO3 installation as an administrator or system maintainer.
Open ExtensionManager
Click on Extensions from the left menu to open the ExtensionManager.
Update Extensions
Choose Get Extensions from the upper selectbox and click on
the Update now button at the upper right.
Install dropbox
Use the search field to find dropbox. Choose the dropbox
line from the search result and click on the cloud icon to
install dropbox.
This chapter describes how to manage the extension from a superuser point of view.
If you update dropbox to a newer version, please read this section carefully!
Please execute the token wizard in driver record again to retrieve a fresh refresh token. With that refresh token EXT:dropbox is available to generate a new access token which is available for 4 hours. Remaining time of current access token you can see in dropbox info section of dropbos driver record.
Im future files get bigger and bigger. Downloading these files just to access the image dimension (width/height) can be very slow, costs traffic and of cause CPU time. With version 5.0.0 I use the dropbox API to retrieve this information. This is faster if you have a lot of huge files in your selected folder, but it's slower, if you have a lot of tiny small files in your folder.
Dropbox API can only retrieve image dimension (width/height) for images up to 20 MB.
The access tokens generated by/for Dropbox have now a lifetime of max. 4 hours. So, we can not store the access token anymore. THX goes to TYPO3 community which provides a pull request to migrate to refresh tokens which can be used to generate new temporary available access tokens.
Please edit your dropbox storage and execute the refresh token wizard.
The new access tokens will be stored in sys_registry. On error while working with the API EXT:dropbox will automatically try to refresh the access token and tries the same request again.
A big thank you goes to Georg Ringer, who kindly gave me the extension key "dropbox". I took the chance and renamed all paths, PHP classes, names and repos to the new extension key "dropbox".
Please execute the Rename Extension Key Upgrade wizard from install tool to
rename the driver identifier in all sys_file_storage records of existing
Dropbox storages.
I have added TYPO3 11 compatibility. With this change my ext dropbox is
not compatible with PHP versions less than 7.4 anymore.
This version is still TYPO3 10.4 compatible, but needs at least PHP 7.4.
Go to Developer area of dropbox.com
Simply visit: https://www.dropbox.com/developers
If this link is not valid anymore go to https://www.dropbox.com/, click the
upper left menu icon with the 9 dots. Choose the App Center. In the left
menu of the App Center you will find a link to Develop Apps. Now
you should be in the developer corner of Dropbox.
Create new Dropbox App
Click the App Console button in the upper right corner. Now you see all
your apps (if you have created some). Click the Create app button.
Choose API
With a free or simple Dropbox account you only have the possibility to
choose the API with Scoped access. The TYPO3 Dropbox extension can only
work with this API. Do not choose any other API.
Choose App type
For security reasons I prefer to choose App folder. But if you`re sure,
you also can give your app full access to all of your Dropbox files.
Give it a name
Assign a Dropbox global unique name to your new app. Please consider, that
words like dropbox are not allowed as part of the name.
Confirm your settings with button Create App. You will be redirected to
detail view of your app.
Configure your new app
Switch over to tab Permissions and activate following permissions:
files.metadata.read files.content.write files.content.read Locate App key
For next section you will need to copy App key from tab Settings.
File StorageGeneral choose a name like DropboxConfiguration you have to choose the Dropbox driverWhile editing the File storage click on the + icon to start the wizard.
Paste in the App Key from Dropbox App explained above.
Click on Get AuthCode Link
On the next page you have to click on the authorization link which will
open a new tab where you have to give access to your Dropbox App.
Copy the AuthCode from Dropbox page into the AuthCode field of the Wizard.
With a click on Get AccessToken a further request to dropbox.com will
start in the background. On success the Refresh Token will automatically
inserted in File Storage record and the wizard will close.
Save the record. On success it will show you some user data.
The extension provides an extension setting named count, which
is enabled by default. When activated, the extension performs an individual
API request to Dropbox API for each listed folder in order to determine the
number of contained files.
Each API call introduces a latency of approximately 300–400 milliseconds. For example, if a parent folder contains 10 subfolders, the total time required to render the file list may reach up to 4 seconds.
Since the file count is primarily a visual indicator, this feature can be
disabled to optimize performance. When count is set to 0, the
file list will render significantly faster, but will display "0 files" for
each subfolder.
Within the Configuration tab, at the bottom of the settings list, you will
find the option Folder for manipulated and temporary images etc..
By default, this folder is located within the Dropbox file storage. As a result, all processed or temporary images are transferred via the Dropbox API, which significantly impacts performance due to the slow transfer rates.
To improve rendering speed and overall performance, it is recommended to
relocate this folder to a fast local file storage. For example, if your
fileadmin storage has the storage UID 1, you can set the value to:
1:/_. This ensures that temporary files are handled locally
rather than being transferred through the Dropbox API.
Attention
Cleanup required after changing the processed folder storage
After changing the Folder for manipulated and temporary images to a local
file storage (e.g., UID 1 for fileadmin), it is necessary to clean up
existing processed files.
Specifically, all records in the sys_ table that
reference the previous Dropbox storage (e.g., UID 2) must be deleted.
Otherwise, TYPO3 may continue to reference outdated processed files stored
in the remote storage.
For further details, refer to the related TYPO3 issue: https://forge.typo3.org/issues/84069
In most cases you get that error, if your Dropbox App does not have the
required permissions. PLease visit App Console at Dropbox again and make
sure you have activated files., files. and
files.. Save your App. After each change at the Dropbox App you
have to restart the AccessToken Wizard in your Dropbox TYPO3 FAL Storage and
save the record again.
If you get this error message while uploading a new file, this is because you
have missed to activate the Dropbox Permission files. in your
Dropbox App. Please visit: https://www.dropbox.com/developers
Choose your App, switch to tab permission and activate that option.
If you get this error message you have to activate the files.
permission in Developer corner of Dropbox: https://www.dropbox.com/developers
but you have missed to re-authenticate your connection to Dropbox. Please move
to your Dropbox FAL storage and start the Authentication Wizard again.
I know, but let me explain:
Dropbox delivers an API call to retrieve all folders and files of a given folder. But this request does not contain any image metadata like image dimension (width/height) anymore since 2019. As TYPO3 needs this information to render previews and the image in crop wizard, I have to start a second request for EACH image in selected folder to retrieve the image dimensions with help of another API endpoint. And if you have activated the image preview in filelist module it needs a third dropbox call to retrieve a specific thumbnail. All that costs a lot of time.
How to solve that?
That happens if you have deactivated the clipboard. Please activate the clipboard. You will find a button to activate "moving" files instead of "copying". If you know paste the file, it will be moved instead.
fal_dropbox to dropbox