Submit an Index

Learn more about submitting a public index to the Green Web Tracker.

What is an Index?

An index is a list of public websites that you'd like to have tracked over time. They can represent organisations within the same industry or have other commonalities (e.g. they're created by the same agency, they are listed in the same stock market index, or something else).

Websites listed in an index are checked each week against the Green Web Foundation's Green Web Dataset. The check returns wether or not that website is hosted on a known, verified green hosting provider. Results for each index, and each domain, are shown on respective pages of this site allowing any changes to be seen over time. Learn more about why a website's green hosting status might change in the FAQ.

Who should submit an index?

Anyone can submit an index, although please be mindful of the following contribution conditions:

• Indexes should contain at least 10 domains.
• Domains can be submitted across multiple indexes.
• Once submitted, indexes and their results are public. If you want to keep a private index, you can do so in the "My Index" part of this site or by creating a fork of this project's source code.
• Green Web Foundation will review all submitted indexes before adding them to this site. We reserve the right to edit or reject any submissions, and will provide reasoning explaining our decision in such cases. Any indexes that promote pornography, abuse, gambling, or scams will not be accepted.

How to submit an index

We prefer that new indexes are submitted by contributors through GitHub. For those who do not use GitHub, submissions can also be made by email.

GitHub

The source code for this project can be found on GitHub in a public repository. Follow the steps below to submit a new index:

1. Fork the repository at for this project.
2. Create a new file in the src/indexes directory. The file should be named with the index's name, and have the extension .json. For example, if you're creating an index for "My Industry", the file should be named my-industry.json.
3. Copy the following template into the new file, and fill in the details for your index:

  {
      "name": "My Index",
      "description": "A description of the index.",
      "created": "YYYY-MM-DD",
      "contributors": [
          {
          "name": "Your Name",
          "github": "your-github-username"
          }
      ],
      "sources": [
          {
              "name": "Source Name",
              "url": "https://example.com"
          }
      ],
      "sites": [
          "example.com",
          "example.org"
      ],
  }

4. Update the template with information about your index.
For example:
• name: "My Index"
• description: "A description of the index."
• created: The date you created the index in the format YYYY-MM-DD.
• contributors: Your name and GitHub username.
• sources: Any sources you used to create the index. This is an optional field.
• sites: The list of domains that you'd like to include in the index as an array of strings.
5. Commit your changes to your fork.
6. Create a Pull Request in the thegreenwebfoundation/green-web-tracker repository to merge in your changes.

Email

If you're unable to use GitHub, you can submit an index by email. Please send the following information to us using the support form on our website.

• Index name
• Index description
• Contributors: Your name
• Sources: Any sources you used to create the index. This is an optional field.
• Sites: The list of domains that you'd like to include in the index as an array of strings.