Welcome to ESGF CoG’s Administrator Guide

This Guide is intended for administrators of ESGF CoG sites. For anyone looking for help in using CoG to find or download ESGF data, please see https://esgf.github.io/esgf-user-support/user_guide.html.

• ESGF/CoG Administrator Guide Overview
  • Step 1b: Upgrade CoG standalone
  • Step 2: Configure CoG
  • Step 3: Upgrade CoG
• ESGF/CoG Administrator Login
  • Option 1: Username/Password login
  • Option 2: OpenID login
• Node Home Project Setup
  • Step 1: Register a new project
  • Step 2: Approve the new project
  • Step 3: Configure the new project as the Node “home” project
  • Step 4: Save the file and restart the ESGF Node.
  • Step 5: Edit the node “home” project “home” page
• Home Page Example
  • Welcome to the [institution] ESGF-CoG Node
    • What can I do on the [institution] data node?
    • Search Data
    • Host a Project
• Data Search Configuration
  • Step 1: Turn on the Data Search widget (Figure 1)
  • Step 2: Customize the Data Search Constraints
  • Optional: Enable New Search Facets
• Data Access Control Setup
  • Step 1: Configure the ESGF Postgres database
  • Step 2: Edit the ESGF XML configuration files
  • Step 3 (optional): Publish the Group Registration URL
  • Special Case: Unrestricted Data
  • Special Case: Authentication Only Data
• Node Federation
  • Step 1: Click on the “Configure Peers” link at the bottom of the left navigation bar (Figure 1)
  • Step 2: Select nodes to federate with
  • Step 3: Save your selections
  • Step 4: Click the “Syncronize projects” link (Figure 2)
  • Step 5: Look for an instance of a federated project in the Project Browser (Figure 3).
• Configuring Globus
  • Configuring ESGF/CoG with Globus Downloads
  • Restricted datasets
    • Step 1: (Preliminary) obtain Globus credentials for the node
    • Step 2: Publish datasets with Globus enabled
    • Step 3: Add Globus URLs to already published datasets
    • Step 4: Register the URL with Globus
    • Step 5: Update the node configuration of Globus endpoints
  • Public datasets
    • Step 1: Configure the Globus Connect Server
    • Step 3: Activate the default Globus Endpoint on the node
    • Step 4: Create a shared Globus endpoint
    • Step 3: Publish public datasets with Globus enabled
• Data Transfer Node Setup
  • 1. Install Globus Connect Server IO
  • 2. Add the ESGF software repository
  • 3. Install ESGF authorization packages
  • 4. Configure Globus Connect Server IO
  • 6. Add ESGF specific GridfTP configuration
  • 7. Test
• Header and Footer
  • Customizing the header and footer
  • The Defaults
  • Overridding the Defaults
  • Example code
• Google Analytics
  • Customizing Federal Google Analytics
  • The Default
  • Overriding the Default
• Notification Header
  • The Defaults
  • Overriding the Defaults
• ESGF CoG User Accounts
  • Migrating CoG User Accounts to ESGF
• Setup Federation
  • Setup federation with other CoG instances:
  • Choosing Peer Nodes
  • Loading Projects from Peer Nodes
    • NOTES:
• Cron Jobs
  • Setup cron jobs to execute periodic administration tasks
  • 1) Periodically update the projects around the federation
  • 2) Backup the postgres databases content every night
  • 3) Remove stale user stubs from local database
• Restore from Backup
  • Restoring CoG from backup
• “Local Shard” Setup
  • Step 1) Setup a “local shard”
  • Step 2) Publish data collections to the “local shard”
  • Step 3) Configure the CoG Search User Interface
• CoG Installation or Upgrade
• Create an account
  • How to Register for CoG
  • *** Don’t create an account unless you plan to join a project or download data from ESGF ***
  • Step 1: Create Account
  • Step 2: Fill in the User Profile (Figure 2)
  • Step 3: Join or Create a project
    • a) Join an existing project
    • b) Create a project
• Authorization for ESGF Data Access
  • Why data access control groups?
  • Which data access control groups currently exist in ESGF?
  • Who has to join?
  • How to join?
• Logging in with OpenID
  • Method 1: Enter your full OpenID
    • Step 1: Enter your full OpenID in the login box (Figure 1) and click “Login”.
    • Step 2: Enter your password in the ESGF OpenID password box
  • Method 2: Use the pull down to select your OpenID issuer.
    • Step 1: Use the arrow icon in Figure 1 to invoke the list of OpenID providers.
    • Step 2: Enter your username and password (Figure 3).
• Forgot OpenID
  • Step 1: Go to the Login page
    • Step 2: Click the Forgot OpenID link located beneath the login box
  • Step 3: Fill out the template.
• Forgot Password
  • Step 1: Click the Login link in the upper right corner of the CoG page.
  • Step 2: Click the “Forgot Password?” link on the login page
  • Step 3: Enter the ESGF OpenID and emal associated with that OpenID into the form and submit.
• Update Password
  • Step 1: Login
  • Step 2: Click on “My Profile”
  • Step 3: Click on Update password
• Getting Safari to accept the ESGF OpenID certificate
  • Step 1: Enter your ESGF OpenID (or select an OpenID provider from the pulldown) in the login box and click “Login”
  • Step 2: Click the “Show Certificate” button
  • Step 3: Expand the Trust section
  • Step 4: Change the Trust settings
  • Step 5: Authenticate
  • Step 6: Proceed with authentication
• Getting Chrome to accept the ESGF OpenID certificate
  • Step 1: Insert your OpenID (or select an OpenID provider using the pulldown) in the login box and press “Login”
  • Step 2: Click “Advanced” on the warning page
  • Step 3: Click “Proceed to $node (unsafe)”
  • Step 4: Proceed with authentication.
• Getting Internet Explorer to accept the ESGF OpenID certificate
  • Step 1: Enter your OpenID in the box and click “Login”
  • Step 2: Click the “Continue to this website (not recommended) link.
  • Step 3: Enter your password in the box provided
• Getting Firefox to accept the ESGF OpenID certificate
  • Step 1: Enter your OpenID (or select your OpenID providing using the pulldown) in the login box and click “Login”
  • Step 2: Click on “Advanced”
  • Step 2: Click “Add Exception…”
  • Step 3: Click “Confirm Security Exception”
  • Step 4: Click “Resend”
  • Step 5: Proceed with authentication
• CoG Installation from Docker
  • Prerequisites (for installation and general operation)
  • Download
  • Run CoG from the container installation directory
  • Stop CoG
  • Restart CoG
  • Run CoG from the local source directory
• Installation: Prerequisites
  • Step 1: Install Python
  • Step 2: Install Postgres
  • Step 3: Set up git and github
  • Step 4: Update pip
  • Step 5: Install virtualenv
  • Step 6: (CentOS only) Install C-headers for sqlite-devel and freetype-devel
  • Step 7: (MacOSX only) Copy image libraries
  • Step 8: Install Xcode command line tools
  • Step 9: Manually install Pillow
• Installation: Initial setup
  • Step 1: Create the main CoG directory
  • Step 2: Create a CoG configuration directory
  • Step 3: Create a CoG installation directory
  • Step 4: Ensure all environment variables are set
  • Step 5: Set up a Python virtual environment
  • Results:
• Installation: Install or Upgrade
  • Step 1: Activate the CoG Python virtual environment
  • Step 2: Checkout the CoG software stack
  • Step 3: Install CoG and dependencies
  • Step 4: Install patched version of django-openid-auth
    • Step 4a: Install mkproxy (optional)
  • Step 5: Configure CoG
    • Step 5a: To configure CoG WITHOUT an ESGF node (e.g. –esgf=false)
    • Step 5b: To configure CoG with an ESGF node (e.g. –esgf=true)
  • Step 6: Modify configuration file
  • Step 7: Check Django Admin for empty Site
  • Step 8: Remove potential Python conflicts
• Installation Testing: Initial Testing of the Installation
  • Step 1: Run CoG with the Django development server
  • Step 2: Open http://<host>:8000/
  • Step 3: Login
  • Step 4: IMPORTANT: immediately change the “admin” password by:
  • Step 5: Change all other “admin” data.
  • Step 6: Start experimenting with creating other projects and registering new users.
• Installation Configuration
  • Updating the SITE_NAME
  • Configuration Variables

Indices and tables

• Index

• Module Index

• Search Page