Open Science Network Configuration Guide

This guide covers how to configure and deploy your own Open Science Network instance (powered by Bonfire).

Prerequisites

  • Deploy an instance by following Bonfire's setup and deployment guides, making sure to set open_science as the flavour.

Environment Configuration

ORCID Application Setup (Optional - for importing and adding works)

  1. Register your application at ORCID Developer Tools (or Sandbox for testing)
  2. Set redirect URIs for your instance in the ORCID app setup:
    https://your-domain.org/settings/orcid/callback
    
  3. Copy credentials to your Bonfire environment or .env file (see example below)
  1. Restart Bonfire

Zenodo Application Setup (Optional - for archiving discussions)

  1. Create application at Zenodo Developers (or Sandbox for testing)
  2. Set redirect URIs for your instance in the Zenodo app setup:
    https://your-domain.org/settings/zenodo/callback
    
  3. Copy credentials to your Bonfire environment or .env file (see example below)
  4. Restart Bonfire

OSN Environment Variables

Add these variables to your Bonfire environment or .env file:

FLAVOUR=open_science # sets Bonfire flavour

# ORCID Integration 
# ORCID_ENV=sandbox # uncomment if using the sandbox API
ORCID_CLIENT_ID=your_orcid_client_id
ORCID_CLIENT_SECRET=your_orcid_client_secret
# ORCID_WITH_MEMBER_API=yes # uncomment only if your organisation (used to create these API keys) is an ORCID member

# Zenodo Integration 
# ZENODO_ENV=sandbox # uncomment if using the sandbox API
ZENODO_CLIENT_ID=your_zenodo_client_id
ZENODO_CLIENT_SECRET=your_zenodo_client_secret

Support Resources