Welcome to Green Web Foundation Platform documentation!

Welcome to the documentation for the Green Web platform. This site project contains documentation for the code for serving:

• the admin interface used by hosting provider, at admin.thegreenwebfoundation.org

• the API that serves requests at api.thegreenwebfoundation.org

This site also provides a summary of the other main libraries maintained by the Green Web Foundation, namely co2js, a javascript library for understanding and managing the carbon emissions from software, and the green web grid-intensity libraries, designed to help design carbon aware digital services that respond to the carbon intensity conditions on the electricity grids the internet relies on.

Getting started

Need to get going quickly? Start with installation steps, see the answers to common questions, and if you need to push changes for review visit the deployment instructions.

• Installation
  • Development on a remote machine using Gitpod
    • Why Gitpod
    • Preparing a Gitpod workspace
  • Development on a local machine using virtual environments
    • Prerequisites
    • Setup
  • Working with email
• How to…
  • Debug issues on production and staging
  • Run tests using pytest
    • Run all tests
    • Run all test until one fails
  • Set up Gitpod environment
    • Fetch files from object storage
• Deployment
  • Github conventions
  • Using Ansible
  • Understanding our infrastructure
    • Other relevant links:
  • how our web servers are deployed
    • A model closer to production - 4 sync workers
    • 2 workers, each with 2 threads
  • Workers
    • Typical queue operation - serving fast and slow responses
  • Scaling processes with ansible
  • Logging
  • Gunicorn logging
• Key concepts
  • What green energy means in this context
• Users and permissions
  • User accounts
    • Creating a user account
    • Quirks
  • User permissions
    • Groups
    • Object-level permissions
• Verification request
  • What is a verification request?
  • How to access the verification request form?
  • How is the form implemented?
  • Working with WizardView
  • Quirks of Django forms
    • Working with file upload in the form
    • Working with error messages
    • Preview implementation details
  • Testing the verification request
    • Testing the form wizard end to end
    • Testing focussed steps of the form wizard
• Understanding checks for green sites
  • Making this more specific
    • Domain, to IP to provider, by IP range
      • Linking directly to a provider by IP range
      • Linking a site to a provider in the site’s supply chain
    • Domain, to IP to provider, by ASN
      • Linking directly to a provider by ASN
      • Linking a site to a provider in the site’s supply chain
    • Domain to carbon.txt lookup
      • Why do it this way?
• Understanding the life cycle of a Green Check Request
  • Our usual, fast check
  • Updating our green domains table
  • Carrying out a slow full network look up
• Automated Importers
  • Two moving parts - NetworkImporter and a CloudImporter
    • NetworkImporter
    • CloudImporters
    • Checking that importers work as expected:
  • Running the import from the command line
  • Adding new importers
  • Further Reading
• Other Green Web software
  • CO2.js
  • Grid intensity libraries - golang and javascript
  • Web Extension
• Working with the Green Web Open Data
  • Understanding the url2green dataset
  • Example uses of this dataset
  • Licensing of the data
  • Getting support with using the the Green Web Foundation datasets