Add-ons & API Home Page


This Article Is Licensed Under CCO For Maximum Reuse.

cc-zero.png

The following is a Table of Contents that links directly to specific sections within the guide.

Overview: 

Add-ons are trusted third-party software that is compatible with the OSF. These add-ons are highly popular with users as the add-ons are often programs users are already personally using. You can review the add-on types we offer and the capabilities of OSF’s open API below: 


  • Storage Add-ons: Storage applications are a great way to store material on the OSF and even get around some OSF Storage caps. The OSF is compatible with a number of common storage add-ons.

  • Citation Add-ons: Citation software is an excellent way to collect and manage references within a research study. The OSF is compatible with Mendeley and Zotero.

  • API Integration: The OSF hosts an Open Application Programming Interface (API). With this API you can access users, projects, components, logs, and files from the Open Science Framework. The Open Science Framework (OSF) is a free, open-source service maintained by the Center for Open Science.

Connecting Add-ons from your OSF profile settings

All add-on integrations can also be connected from your OSF profile settings page and then configured specifically for any project you wish to connect them to. To access the Add-ons go to Settings under your Profile.

Then select Configure add-on & link service accounts. From there you will have the ability to connect all the Add-ons listed below, and then configure them specifically for each project you wish to link them to.


Storage Add-ons

Add and display materials on your project using tools your organization/team is already using. Storage Add-ons are a great solution if your files require significant storage space or if you have a significant number of files, as space used by a connected Storage Add-on does not count towards OSF Storage usage caps.

Amazon S3

Connect Amazon S3 to a Project

Choose an Amazon S3 bucket to connect to your project. Additional buckets can be linked individually to different components within the same project.

The connection between AmazonS3 and OSF is two-way, meaning you can add and update files from either application and your changes are synced.

When you create an Amazon S3 bucket, you can choose its physical location in the world. You might do this to minimize latency or meet funder requirements about where your data can be stored.  

The Amazon S3 add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable Amazon S3 in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under Amazon S3.

Review the terms in the confirmation modal, and click the Confirm button to enable Amazon S3 on your project.

Configure Amazon S3

Find Amazon S3 in the "Configure Add-ons" section, then click the Connect Account link

The "Connect an Amazon S3 Account" modal will appear. Log in to Amazon S3, and Generate Access And Secret Keys.

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_AmazonS3" to distinguish your connection from other collaborators'. When you are finished naming, click Authorize and then click Connect.


Select what bucket you would like to import by clicking a corresponding bubble and clicking the Save button. 


Bitbucket

Connect Bitbucket to a Project

Bitbucket is a web-based Git and Mercurial repository that allows you and your team members to store code. You can connect one Bitbucket repository to your OSF project. Additional repositories can be linked individually to different components within the same project.

The connection between Bitbucket and OSF is read-only, meaning files added to your Bitbucket repository will be accessible - but not editable - via OSF.

The Bitbucket add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable Bitbucket in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under Bitbucket

Review the terms in the confirmation modal, and click the Confirm button to enable Bitbucket on your project.

Setting up a new Bitbucket Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_Bitbucket" to distinguish your connection from other collaborators'. When you are finished naming click Authorize.  

Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected add-on. Log in with your username and password used on that add-on site, not your OSF account. 

The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF account. In this case, click Grant access.  

You will then be returned to your OSF project, where you can select the add-on account you would like to connect to your OSF project. Click the small circle next to the account name, and then click Authorize. Confirm the connection of the account by clicking Confirm.

Select which folders you would like to connect by clicking the files link or using the select bubble for specific files. Then click Save.

You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 

Box

Connect Box to a Project

You can connect one Box folder or an entire Box account to your OSF project or component. Additional Box folders can be linked individually to different components within the same project.

The connection between Box and OSF is two-way, meaning you can add and update files from either application and your changes are synced.

The Box add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable Box in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under Box.

Review the terms in the confirmation modal, and click the Confirm button to enable Box on your project.

Setting up a new Box Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_Box" to distinguish your connection from other collaborators'. When you are finished naming click Authorize.    

Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected add-on. Log in with your username and password used on that add-on site, not your OSF account. 

The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF Account. In this case, Click “Connect account”  


You will then be returned to your OSF project, where you can configure the Box access. Select the folder you would like to connect to the project and then click “save”.

BOX GIF (REPLACE)

You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 


Dataverse

Connect Dataverse to a Project

OSF connects with the Harvard Dataverse or any other instance of Dataverse 4.0. 

Enabling Dataverse for your project allows contributors to view, download files, and upload files to/from a Dataverse study/dataset. Contributors to your project will have access to both released and draft versions of your study, but only the most recent release will be made public alongside your OSF project.

The Dataverse add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF.


Enable Dataverse in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Linked Services from the drop down menu. Click the Connect button under Dataverse. 

Review the terms in the confirmation modal, and click the Confirm button to enable Dataverse on your project.

Setting up a new Dataverse Account & Authorization of Access to Add-on

Next, you will need to insert the host URL, and your personal access token and give this account a name. Finish by clicking “connect” 


Configure Dataverse Connection

You will then be returned to your OSF project, where you can select the Dataverse folder you would like to connect to your OSF project. You can navigate inside each folder by clicking the title of the folder. Click the small circle next to the account name, and then click “Save”. 


You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 

DATAVERSE GIF (REPLACE)

Dropbox

Connect Dropbox to a Project

You can connect one Dropbox folder or an entire Dropbox account to your OSF project or component. Additional Dropbox folders can be linked individually to different components within the same project.

The connection between Dropbox and OSF is two-way, meaning you can add and update files from either application and your changes are synced.

The Dropbox add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable Dropbox in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under Dropbox.

Review the terms in the confirmation modal, and click the Confirm button to enable Dropbox on your project.

Setting up a new Dropbox Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_Dropbox to distinguish your connection from other collaborators'. When you are finished naming click Authorize.  


Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected add-on. Log in with your username and password used on that add-on site, not your OSF account. 


The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF Account. In this case, Click “Allow”  


You will then be returned to your OSF project, where you can select the add-on account you would like to connect to your OSF project. Click the small circle next to the account name, and then click “Authorize” 


Confirm the connection of the account by clicking “confirm” 


Select which folders you would like to connect by clicking the “all documents” link or using the select bubble for specific files. Then click “save”


You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 

<insert screencap or gif of Dropbox from Files Preview or Files Interface>

Figshare

Connect figshare to a Project

Figshare is an online digital repository that allows researchers to preserve and share their research outputs. You can connect one figshare folder to your OSF project. Additional folders can be linked individually to different components within the same project. 

Connecting figshare for your OSF project allows contributors to move/copy files into figshare. Likewise, files added directly via figshare will be accessible on your connected OSF project. 

Files published on figshare cannot be deleted. The figshare add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable figshare in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under figshare.

Review the terms in the confirmation modal, and click the Confirm button to enable Figshare on your project.

Setting up a new figshare Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_Figshare" to distinguish your connection from other collaborators'. When you are finished naming click Authorize.  


Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected add-on. Log in with your username and password used on that add-on site, not your OSF account. 

The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF account. In this case, Click Allow. 


You will then be returned to your OSF project, where you can select the add-on account you would like to connect to your OSF project. Click the small circle next to the account name, and then click “Authorize”. Confirm the connection of the account by clicking “confirm” 


Select which folders you would like to connect by clicking the “all documents” link or using the select bubble for specific files. Then click “save”. You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 

<insert screencap or gif of figshare from Files Preview or Files Interface>

GitHub

Connect GitHub to a Project

GitHub is a commonly-used web-based Git repository-hosting service. You can connect oneGitHub repository per OSF project. Additional repositories can be linked individually to different components within the same project.

The connection between GitHub and OSF is two-way, meaning you can add and update files from either application and your changes are synced. You can also create a new GitHub repository from your OSF project by clicking Create repo.

The GitHub add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable GitHub in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under GitHub.

Review the terms in the confirmation modal, and click the Confirm button to enable GitHub on your project.

Setting up a new GitHub Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_GitHub" to distinguish your connection from other collaborators'. When you are finished naming click Authorize.   


Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected add-on. Log in with your username and password used on that add-on site, not your OSF account.  

The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF account. In this case, click Authorize CenterForOpenScience.


You will then be returned to your OSF project, where you can select the add-on account you would like to connect to your OSF project. Click the small circle next to the account name, and then click “authorize” 


Confirm the connection of the account by clicking “confirm” 


Select which folders you would like to connect by clicking the “all documents” link or using the select bubble for specific files. Then click “save”


You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 

<insert screencap or gif of GitHub from Files Preview or Files Interface>

Reauthorize GitHub

Having trouble viewing your GitHub organizations or loading your repositories? You may need to reauthorize your GitHub access token. 

  • * Reauthorizing GitHub will disconnect GitHub from any projects where you currently have it configured. After you reauthorize, you will need to re-connect GitHub to each project individually.

This help guide will walk you through how to reauthorize your GitHub connection to your OSF account.

  1. Revoke Your Access Token
  2. Reauthorize GitHub As An Add-On
  3. Grant OSF Access To Your GitHub Account
  4. Connect GitHub To Your Project

Revoke your access token

First, sign in to your GitHub account.

Click your profile in the top right of the page, then click Settings from the drop-down menu.


Your "Personal settings" page will appear.

Click Applications from the left sidebar.


You will be taken to the "Applications" page.

Click the Authorized OAuth Apps tab.


Then, find OSF in the list and click the Revoke button.


Reauthorize GitHub as an add-on

Sign in to the OSF. Click Settings from the left sidebar navigation, then click Configure Add-ons from the  drop down menu.


Click on Connected Add-ons tab and select Additional Storage from the drop down menu. 

Find GitHub in the list, then click the Connect or Reauthorize Account link.

<insert annotated screencap>

Grant OSF access to your GitHub account

You will be taken to the "OAuth" page for GitHub.

If you want to connect to GitHub organizations, click Grant (if you're an owner of the organization) or Request (if you're a member of the organization).

Then click the green AuthorizeCenterForOpenScience button.


GitHub will be connected to your OSF account.

Connect GitHub to your project

Next, connect GitHub to your OSF projects. See Connect Github To A Project for step-by-step instructions.

GitLab

Connect GitLab to a Project

GitLab is an open-source web-based git repository manager. You can link one repository per project. Additional repositories can be linked individually to different components within the same project.

The connection with GitLab is read-only, which means files added to your GitLab repository will be viewable - but not editable - via the OSF.

The GitLab add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider registering your project.

Enable GitLab in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under GitLab.

Review the terms in the confirmation modal, and click the Confirm button to enable GitLab on your project.

Setting up a new GitLab Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_GitLab" to distinguish your connection from other collaborators'. When you are finished naming click Connect. 


To authorize you will need to provide the URL for gitlab: https://gitlab.com, along with an API token or Personal Access Token you generate in your Gitlab account profile.

Google Drive

Connect Google Drive to a project

You can link one Google Drive folder or an entire drive to any OSF project, component, or your profile. Additional folders can be linked individually to different components within the same project.

The connection between Google Drive and OSF is two-way, meaning you can add and update files from either application and your changes are synced. Google Docs, Sheets, and Slides will render in-browser via OSF, but cannot be edited directly on the platform.

The Google Drive add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Setup Google Drive Account

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under Google Drive.

Review the terms in the confirmation modal, and click the Confirm button to enable Google Drive on your project.

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_GoogleDrive" to distinguish your connection from other collaborators'. When you are finished naming click Authorize.  


Authorize Access

  1. A new tab will open to begin the OAuth process. OAuth (Open Authorization) is a secure way for one app (like OSF) to access limited information or features from another service (like Google Drive) without needing your password. It lets you grant permission using your existing account, while keeping your login credentials private.
  2. Click Allow to authorize your Google account.

  1. Select the Google Drive account you want to use.
  2. Click Authorize.

  1. Click “Confirm”.

Select a Folder to Connect

  1. You’ll be asked to select a folder (e.g., from “My Drive”).
  2. Click the main folder you’d like to add.
  3. Click "Save".

You have now connected your add-on to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project.

Managing Your Google Drive Files via the Files Tab

Once set up, you’ll use your project Files tab to interact with your connected Google Drive content.

Adding Folders and Files from Google Drive

Use this to link a file or folder from your existing Google Drive account to your OSF project.


  1. Go to the "Files" tab in your project or component.
  2. Click the green ➕ button and select Add from Drive.
  3. A modal will appear showing the Google File Picker.
  4. Select a file or folder from your Drive.

Reminder: You can only select one item at a time. If you select a folder, its contents will not appear— you must add each file individually.

  1. Click Select to confirm. The item will now be visible in your OSF Files tab.

Upload a File

Use this to upload a file from your local device to your connected Google Drive folder.

[insert image]


  1. In the Files tab, click the green ➕ button and select "Upload File".
  2. A system file picker will open (macOS or Windows).
  3. Navigate to the file you want to upload and select it.
  4. A modal will appear showing upload progress.
  5. Once complete, click "Done". The file will be added to your connected Google Drive folder and visible on OSF.

Create Folder

Use this to create a new folder inside your connected Google Drive folder, which will be visible in both OSF and Drive.

[insert image]


  1. In the Files tab, click the green ➕ button and select Create Folder.
  2. Enter a name for the folder in the modal that appears.

Tip: Avoid using special characters (like / \ : * ? " < > |) to prevent sync issues.

  1. Click "Create Folder".
  2. The new folder will appear in both OSF and your Google Drive.

OneDrive

Connect OneDrive to a Project

OneDrive is a cloud-based storage service that is part of the Microsoft suite of tools that allows you to store and share files. You can connect one OneDrive folder or subfolder per project. Additional folders can be linked individually to different components within the same project.

The connection between OneDrive and OSF is two-way, meaning you can add and update files from either application and your changes are synced.

The OneDrive add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable OneDrive in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under OneDrive.

Review the terms in the confirmation modal, and click the Confirm button to enable OneDrive on your project.

Setting up a new OneDrive Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_OneDrive" to distinguish your connection from other collaborators'. When you are finished naming click Authorize.  


Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected Add-on. Log in with your username and password used on that add-on site, not your OSF account. 


The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF Account. Once you have finished approving the add-oin connection, you will then be returned to your OSF project, Confirm the connection of the account by clicking “confirm” 


Next you will select what folder to connect to your OSF project. Select which folders you would like to connect by clicking the “all documents” link or using the select bubble for specific files. Then click “save”


You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 

<insert screencap or gif of OneDrive from Files Preview or Files Interface>

ownCloud/nextCloud


Connect ownCloud/nextCloud to a Project

OwnCloud is an open-source, universal file access platform that is self-hosted on your servers. Some ownCloud instances have alternate names, like nextCloud.

The connection between ownCloud and OSF is two-way, meaning you can add and update files from either application and your changes are synced. 

The ownCloud add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. To back up your content to OSF Storage, consider Registering Your Project.

Enable ownCloud in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Additional Storage from the drop down menu. Click the Connect button under ownCloud.

Review the terms in the confirmation modal, and click the Confirm button to enable ownCloud on your project.

Setting up a new ownCloud Account & Authorization of Access

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_ownCloud" to distinguish your connection from other collaborators'. When you are finished naming click Connect. 

To authorize you will need to provide the URL for ownCloud (the URL to use will be for the WebDAV API), along with an API token or Personal Access Token you generate in your ownCloud account profile.



You will then be returned to your OSF project, where you can select the add-on account you would like to connect to your OSF project. Select which folders you would like to connect by using the select bubble for specific files. Then click “save”


You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 

<insert screencap or gif of ownCloud from Files Preview or Files Interface>


Citation add-ons

Citation software is an excellent way to collect and manage references within a research study. The OSF is compatible with Mendeley and Zotero. Please see our help guide below for more information:

  1. Connect Mendeley to a Project: Connecting a Mendeley folder to your OSF project allows you, your contributors, and others viewing your project to see references you store on Mendeley.
  2. Connect Zotero to a Project: You can manage and collaborate on your Zotero references directly from your OSF projects. 
  3. Reauthorize Citation Add-on: Having trouble seeing your Zotero libraries and folders? You may need to reauthorize Zotero as an add-on to your OSF account. (Follow the same steps if you need to update Mendeley).

Mendeley

Connect Mendeley to a Project

The connection with Mendeley is read-only, which means references added to your Mendeley folder will be viewable - but not editable - via OSF. 

You can link one folder per project. Different folders can be linked to different components within the same project. 

The Mendeley add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. If registering your project with Mendeley connected, Mendeley content will not be registered.

Enable Mendeley in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Citation Manager from the drop down menu. Click the Connect button under Mendeley

Review the terms in the confirmation modal, and click the Confirm button to enable Mendeley on your project.

Setting up a new Mendeley Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_Mendeley" to distinguish your connection from other collaborators'. When you are finished naming, click Authorize.


Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected add-on. Log in with your username and password used on that add-on site, not your OSF account. 


The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF Account. In this case, Click Connect Account.  


You will then be returned to your OSF project, where you can select the add-on account you would like to connect to your OSF project. Click the small circle next to the account name, and then click Authorize. Confirm the connection of the account by clicking Confirm.

Select which folders you would like to connect by clicking the files link or using the select bubble for specific files. Then click Save.


You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 


View citation styles

Click inside the "Enter citation style" menu above the list to view the references in a different citation style. Start typing a citation style, then select the style from the menu.


The references will appear in the selected citation style.


Configuring your Add-on Connection 

If you are looking to add or remove files, or remove your add-on connection you can do so by returning to the add-on selection page Connected Add-ons tab and clicking Configure under your selected add-on. 

You can then edit your configuration by clicking the Pencil icon or remove the connection by clicking the Delete icon.


Selecting the pencil will return you to the “folder selection” page, while clicking the red X will send you to a Pop up message confirming your desire to disconnect the selected add-on. 


The references will appear in the selected citation style.


Zotero

Connect Zotero to a Project

Manage and collaborate on your Zotero references directly from your OSF projects; connect relevant personal or group libraries to individual projects. 

Note: If Zotero is already configured in your OSF account, you may have trouble viewing your Group Libraries. See Reauthorize Zotero for help. 

The Zotero add-on allows you to connect external content to OSF. This connection does not store or back up this content on OSF. If registering your project with Zotero connected, Zotero content will not be registered.

Enable Zotero in your project

Open your project, then click Add-ons in the left sidebar navigation. Select Citation Manager from the drop down menu. Click the Connect button under Zotero.

Review the terms in the confirmation modal, and click the Confirm button to enable Zotero on your project.

Setting up a new Zotero Account 

Because other contributors can connect their add-on accounts to a shared project, you'll be prompted to provide a unique name for your account. 

Choose a clear name like "YourName_Zotero" to distinguish your connection from other collaborators'. When you are finished naming click Authorize.  


Authorization of Access to Add-on

After clicking Authorize, a new window tab will appear to allow you to sign in on the selected add-on. Log in with your username and password used on that add-on site, not your OSF account. 


The add-on will then ask you if you would like to confirm the connection of your add-on account to your OSF account. In this case, click Connect account. In the Case of Zotero, you have the ability to Edit Permissions or Accept Defaults for the setting of the connection. 


You will then be returned to your OSF project, where you can select the add-on account you would like to connect to your OSF project. Click the small circle next to the account name, and then click Authorize.  


Confirm the connection of the account by clicking Confirm. 


Select which folders you would like to connect by clicking the “all documents” link or using the select bubble for specific files. Then click Save.


You have now connected your add-on library to your OSF project and will be returned to the add-on selection page. View your connected add-on folder from the Files section of your project. 


Reauthorize Zotero

Having trouble seeing your Zotero libraries and folders? This help guide will walk you through how to reauthorize Zotero as an add-on to your OSF account.

  • * Reauthorizing Zotero will disconnect Zotero from any projects where you currently have it configured. After you reauthorize, you will need to re-connect Zotero to each project individually.

Disconnect, or Reconfigure Zotero as an add-on

Sign in to the OSF. Click Settings from the left sidebar navigation, then click Configure Add-ons from the  drop down menu.


Click on Connected Add-ons tab and select Citation Manager from the drop down menu. Find Zotero in the list. You will have the choice to 1) reconnect your add-on connection, 2) disable your entire Zotero account 


Upon selection, a pop up window will appear. If you are disconnecting a folder or the Zotero account an OSF pop-up window will confirm your action. 


Click the Disconnect button.

If you are reconfiguring your account, a new tab will open and you will be prompted to login to Zotero account. 


Accept the default settings or edit the permissions from your Zotero account.


You will be returned to your account settings page after the add-on was successfully reconnected. 

API Integrations

The OSF hosts an Open Application Programming Interface (API). With this API you can access users, projects, components, logs, and files from the Open Science Framework (OSF), which is a free, open-source service maintained by the Center for Open Science. 

protocols.io

Protocols.io has developed an integration using the OSF API that allows users to sync their protocols to OSF projects. To initiate the integration, navigate to protocols.io and complete the following steps.

  1. Navigate to a protocol or create a new protocol from your protocols.io dashboard.

  2. From the drop down menu, select Export > PDF > Copy to OSF.

    Indicate whether Only materials or Only commands should be exported. Then confirm that the correct file is selected.

  4. An OSF authentication window will appear. Selecting Allow will populate a list of your OSF projects.

  5. Select the project you want your protocol to be exported to, and then click Synchronize.


  6. Navigate to or refresh your chosen OSF project page where your protocol will be visible in the Files interface.




Third-Party Vendors

COS uses several third-party vendors to help operate OSF and its suite of products. This document provides a list of third-party vendors and their purposes, organized by category. Please refer to our Privacy Policy to understand why and when COS shares information with third-party vendors.

Cloud-computing Services

Purpose: to host web services and to store and back-up operational data, logs, and files uploaded to OSF Storage.

Site Analytics

Purpose: to track and aggregate activity and usage on OSF and its suite of products.

Monitoring

Purpose: to track error logs on OSF and its suite of products.

Spam Detection

Purpose: to automate spam detection.

DOIs

Purpose: to issue DOIs for OSF projects, registrations, and preprints.

User Support

Purpose: to provide user support and log user feedback.

Relationship Management

Purpose: to document partnerships, events, and member activity

Communication

Purpose: to track transactional and engagement emails sent from OSF and its suite of products to users.

FAQs: 

Add-ons, Storage, & API Integration FAQ’s

Storage

Where does OSF store my data?

The United States is the default storage location for OSF Storage. You can set a global storage location for newly created projects going forward; different locations can be set on a per-project basis upon creation. Setting a global storage location is not retroactive: All existing projects will continue to be stored in the United States. As of now, the storage locations available are

  • United States
  • Canada - Montréal
  • Germany - Frankfurt
  • Australia - Sydney

Files connected to third-party storage add-ons are not stored or backed up on OSF; please refer to the provider's server locations for information on where this content is stored.

What is the individual file size limit?

Individual files must be 5GB or less to be uploaded to OSF Storage. Larger files can be stored in an add-on. Learn more about storage add-ons

What is the cap on data per user or per project?

Currently, there is no applied overall cap on the amount of OSF Storage per user. Beginning November 3, 2020, OSF limited the capacity of private projects and components utilizing OSF Storage to 5 GB and public projects and components to 50 GB. Each project is created with a default OSF Storage enabled. View our Storage Caps help guide for additional information.

My project says I have exceeded the storage capacity, but I need to add more files. What do I do?

There are several options:

  1. Enable storage add-ons to the project or component where you've reached the limit. Review our Add-Ons help guide for more guidance.
  2. If you are working in a private project or component, consider making it public to automatically increase your OSF Storage capacity to 50 GB. Our help guide on privacy settings has more information.
  3. If parts of the project could be made public, organize the project with components to manage access to contents. See an example here. Learn how to create a component by reviewing our Create Components help guide.
  4. If you wish to discuss these options or additional needs, please contact our OSF support team. Contact our support team using the support center beacon found on the bottom right side of any OSF support page: 

I have cleared storage space in my project, Why has my storage tracker has not gone down?

When large amounts of files/data are moved or deleted at once, this sometimes can cause the storage calculator to freeze or stall. Contact our support team using the support center beacon and we can reset your storage calculator. 

I have a nested project structure with components. Is the limit for the entire structure?

Each project and component has its own storage limit, depending on the public or private status. Each is calculated independently. Storage totals are not cumulative across the project and components. For example, if you currently structure your project into sections using folders consider replicating part of this structure using components within the project/component.


Are there additional fees if I exceed the storage limit?

There are no additional fees associated with OSF Storage, though you will not be able to add additional files to a project or component that has exceeded its storage limit.

What is the size limit for a registration?

Registrations archive and preserve both OSF Storage and add-ons connected to projects. Registrations must be 5GB or less across all storage being registered. If you need to create a registration larger than 5GB, Contact our support team using the support center beacon found on the bottom right side of any OSF support page: 


How does OSF store and backup files that I upload to the site?

For OSF Storage, files are stored in multiple locations and on multiple media types on Google Cloud. We keep three types of hashes (MD5, SHA-1, SHA-256) for files. We keep parity archive files to recover from up to 5% bit error.

The OSF database is backed up via streaming replication 24 hours a day, and incremental restore points are made twice daily. Further, the OSF database is maintained in encrypted snapshots for an additional 60 days. Database backups are verified monthly.

Operational data (e.g., config files) for other OSF services are backed up in primary cloud file storage for 60 days.

Logs are primarily stored in Google Cloud cold storage indefinitely. In certain cases a third party aggregation service is used for up to 90 days.

If I delete a file or project, can I get them back?

Unfortunately, no. When a user deletes a file or project from  OSF, access to this content is removed for all users. 

How do I move a file from one storage add-on to another? Or one component to another?

You can move files between components and add-ons (provided the components and add-ons are a part of the same project) from the Files interface on your project. The Dataverse add-on does not currently support this functionality.  (Learn more)

If I make a donation to COS, can I request more storage in my projects? 

The best mechanisms to support OSF Storage for your and others’ projects for many years in the future is to have your institution become a member, help us identify and resource more storage integrations with OSF, and to write OSF into your next grant or project budget. Visit cos.io/grants to learn how to include OSF in your next proposal.

Add-Ons

What services can I use with OSF?

OSF supports many third-party add-ons. For storage, you can connect to Amazon S3, Bitbucket, Box, Dataverse, Dropbox, Figshare, Github, GitLab, Google Drive, OneDrive, and Owncloud. For citation management, you can connect to Mendeley and Zotero. OSF also has its own default storage add-on, OSF Storage, if you choose not to connect to any third-party add-ons. Please refer to the Add-ons section of our Guides for more information on how to use add-ons.

What features or storage rules are included with the OSF add-ons? How do I choose?

Please review our Add-ons comparison chart. If you do not see your preferred personal or institutional storage provider, please contact our support team to discuss options. Contact our support team using the support center beacon found on the bottom right side of any OSF support page: 


What are the common storage limitations with these add-on providers? 

The limit of add-on storage options varies by provider. We recommend users utilize the storage option that is ideal for their data (e.g., with respect to accessibility or security) and connect that service to their OSF project(s) rather than transfer the data to OSF storage.

Storage providers on OSF Storage by provider File size limits when uploaded to each add-on from OSF
Amazon S3 5GB free or a paid package based on location and storage plan 5GB
Bitbucket 1GB free per repository Read-only connection with OSF
Box 10GB free 5GB
Dataverse 1TB free on Harvard Dataverse; other Dataverses set alternate limits 6GB
Dropbox 2GB free 5GB
figshare 20GB free private storage, unlimited public 50MB
GitHub 1GB free per repository 100MB
GitLab 10GB free per repository Read-only connection with OSF
Google Drive 15GB free 5GB
OneDrive 5GB free Read-only connection with OSF
ownCloud 5GB free 512MB

Many academic research institutions may offer enterprise licenses for the tools above that provide increased storage limits. Institutions may also offer access to locally available storage options for users that have OSF Institutions.

There is no limit imposed by OSF for the amount of storage used across add-ons connected to a given project. OSF storage is offered as a complement to these options and to allow complete documentation of a research project’s lifecycle. Please see the COS Terms of Use for details.

The add-ons we use at my institution are not available. How can I follow your guides?

Determine if you have access to additional storage options, or request your institutions storage options be integrated with OSF add-ons by contacting our support team using the support center beacon found on the bottom right side of any OSF support page: 


I am leaving my institution and my add-on is tied to an institutional account. Will I still be able to see and modify my files through OSF?

OSF relies on an authentication or provider token process to verify access to each of your provider accounts. Once your permissions are revoked by the institution, OSF cannot continue to grant access to those resources. While preparing to change institutions, consider moving your files to a provider that you will allow you to retain access. Also reference any data management policies provided by your institution. If you have concerns or would like to discuss options, please contact our support team using the support center beacon found on the bottom right side of any OSF support page: 


If I move my files to an add-on, what happens to my OSF links to individual files?

Files moving to most providers will not change the file’s URL and all links and embeds will continue to function as expected.  For more information on file behavior within and between OSF add-ons, visit our Add-Ons help guides.

What can I do with a file after uploading it into a storage add-on?

You can view, download, delete, and rename any files uploaded into OSF Storage. All files are assigned unique, persistent identifiers, suitable for use in citations. 

Files in third party storage add-ons might have restrictions on renaming or deleting.

Does registering a component with storage in an add-on mean the files are now stored/archived at COS?

Yes, those files are archived with the registration on OSF Storage and are unrelated to your project storage total.

If I have external storage, how do I know which privacy settings apply? Do I keep track of two sets of permissions/link access?

Privacy settings for each individual project or component are controlled separately, and content linked from external storage will inherit the public visibility of your project.  Consider adding components that can remain private if this content should not be accessed publicly.  Review our help guides to learn more about privacy settings and components.

API Integration

Does OSF have a public API?

Yes! Read more on the API docs

Will storage limits interrupt API syncing / workflows?

Attempting to add to a project or component past its storage limit will result in a “507 Insufficient Storage” status. 


cc-zero.png

 This Article Is Licensed Under CCO For Maximum Reuse.

Back to Main Support page

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.