Dropbox Connector#

Squirro provides a 1-click connector for Dropbox. This connector allows the Project Creators to connect to a Dropbox account and index the data into Squirro.

Setting Up a Connector#

Usage assumes that the OAuth setup for the 1-click connectors has already been done the server. This is by default available on all of our cloud servers at https://start.squirro.com. For any other Squirro installation, please ask your Squirro server admin to follow the steps in the OAuth Configuration section below

  • Head over to the Enterprise tab on the Data screen as shown the screenshot below.


  • Click on the Dropbox icon. Squirro will show a prompt asking you to authenticate your Dropbox account. Click on the Authenticate button there.


  • Once you click on the Authenticate button, you will be re-directed to the Sign-in and consent screen hosted by Dropbox. This screen is presented to you by Dropbox asking you to provide consent for your Dropbox data to Squirro.

Squirro will never ask you for your Dropbox password. This is requested by Dropbox itself.


  • After signing-in or selecting your Dropbox account (if you are signed in into multiple Dropbox accounts), you will be brought back to Squirro’s source configuration screen. This screen shows which Dropbox account Squirro has connected to.


  • Now, you can click Save & Exit for Squirro to automatically configure the mapping of item fields and labels, as well as any other required source configuration.

  • Alternatively you can define those settings manually by clicking Next and going through the whole source setup process. This allows you the full flexibility of how the Dropbox data should be mapped to Squirro items.

  • After clicking on Save & Exit, you will see your source running. Sit back, relax & enjoy while we index your Dropbox data into Squirro.


OAuth Configuration#

App Config#

You will need to register an OAuth2 app on the Dropbox portal to allow Squirro to connect to the Dropbox accounts of end users. Please follow the steps below to do so.

Note that the exact process on the Dropbox platform may change. If you notice big discrepancies between the current Dropbox website and the documentation page here, please reach out to Squirro’s support at support@squirro.com for help.


  • On the next screen, choose the following options as shown in the screenshot below and then click on Create App button:

    • API: “Scoped Access”

    • Type: “Full Dropbox”

    • Name: A meaningful name. This name will be shown to Project Creators when connecting the source, but does not otherwise appear in the indexed data.


  • On the next screen, choose the following options under the settings tab.

    • Configure OAuth 2 Redirect URIs. This is the URL Dropbox will redirect the user to after successful authorization. This needs to be set to https://<your-server-url>>/dataloader/dropbox_plugin/pl/dropbox/authorized on your server.
      For example: https://squirro.example-company.com/dataloader/dropbox_plugin/pl/dropbox/authorized
    • Access token expiration: Short-lived

    • Leave all the other options untouched.

  • Click on the permissions tab and ensure that the following permissions are enabled.

    • account_info.read

    • files.metadata.read

    • files.content.read

    • sharing.read

Apply for Production#

Also note that the Development apps are limited in terms of users (up to 500) and will show a warning about Development status during the user authorization process when they the users connect their Squirro instance to their Dropbox account. To avoid that, you have to apply for Production status of the Dropbox app.

To start that process you first have to configure the Branding. This will require a logo icon, portal URL and some description about the application.

Squirro configuration#

After having created the OAuth2 app on the Dropbox portal, you need to configure the App key and the App secret on your Squirro instance.

  • Get the Dropbox App key and the Dropbox app secret from the settings screen of the app.


This configuration will soon be possible from the user interface.

  • Edit /etc/squirro/common.ini on your Squirro cluster and add the following lines:

  • If the [dataloader] header is already present in this file, add the two lines to the existing section. The section header can not appear more than once in the configuration file.

  • Restart the frontend & datasource service to apply the settings:

sudo systemctl restart sqfrontendd
sudo systemctl restart sqdatasourced