-
-
Notifications
You must be signed in to change notification settings - Fork 12
How to Setup Dropbox
Upload a build to a folder on Dropbox, optionally creating a public share link you can paste into a Slack or Discord message.
!NOTE: The Dropbox service is marked Experimental. It works, but expect rough edges.
-
Edit->Preferences->Build Uploader->Services->Dropboxholds your access token. Saved to your own PC only and never written into your project. Every person on your team enters their own. -
Project Settings->Build Uploader->Services->Dropboxholds app names and folder paths. Saved to<YourProjectPath>/BuildUploader/and safe to commit so your team shares them.
Create the entry in Project Settings, then enter its secret in Preferences. The Name is what links the two - it must match exactly.
- Go to the Dropbox App Console
- (Or press the
App Consolebutton at the top of the Preferences page)
- (Or press the
- Press
Create app- Choose an API:
Scoped access - Choose the type of access:
-
App folderkeeps the Build Uploader locked to one folder inside your Dropbox. Recommended -
Full Dropboxlets it write anywhere
-
- Give it a name and press
Create app
- Choose an API:
- Give it permission to upload
- Go to the
Permissionstab - Tick
files.content.write - Tick
sharing.writeas well if you want theCreate Shared Linkoption - Press
Submitat the bottom
- Go to the
- Get the token
- Go back to the
Settingstab - Scroll to
OAuth 2->Generated access tokenand pressGenerate - Copy the token
- Go back to the
!IMPORTANT: Set the permissions before generating the token. A token generated first will not have the new permissions and uploads will fail with a
missing_scopeerror - you'd have to generate a fresh one.
!NOTE: Dropbox generated access tokens are short lived by default (about 4 hours). If your uploads start failing with a
401you need to generate a new one. SettingAccess token expirationtoNo expirationin the Settings tab - if your app type offers it - avoids this.
- Turn on
Enabled - Under
Appspress+to create a new App-
Name: anything you like. This is just a label so you can pick it in a dropdown later. eg:Build Uploader -
Token: paste the access token from step 1- Tick
Showif you want to see what you pasted
- Tick
-
- Under
Appspress+ - Enter the exact same
Nameyou used in Preferences
- Under
Folderspress+-
Name: anything you like. eg:Nightly Builds -
Path: the folder path, starting with a/. eg:/Builds
-
- Leave the path blank (or the Folder unset in the destination) to upload to the root
!NOTE: If you chose
App folderaccess in step 1, paths are relative to your app's own folder - not the root of your Dropbox./BuildsmeansApps/YourAppName/Buildsas seen in the Dropbox website.
The folder does not have to exist first - Dropbox creates it on the first upload.
- Go to
Window->Build Uploader->Open Window - Add a
Dropboxdestination to your Upload Config-
App: the App you made -
Folder: the Folder you made (or leave unset for the root) -
File Name: what the file will be called on Dropbox. Comes pre-filled with a sensible default- Supports
{keys}- see String Formatter
- Supports
-
Zip Contents: leave this on if your source is a folder. It zips the folder and uploads one file- Turn it off to upload each top level file separately. Sub folders are skipped when off
-
Create Shared Link: turn on to generate a public link to the uploaded file- Needs the
sharing.writepermission from step 1 - The link is available as a
{key}afterwards, so you can put it in a Slack or Discord message
- Needs the
-
After uploading, the share link is available as a {key} to any later destination or action. See String Formatter for its name.