Skip to content

Commit

Permalink
Merge pull request #3140 from catchpoint/master
Browse files Browse the repository at this point in the history 
Promote to prod
  • Loading branch information
@lbartoli79
lbartoli79 authored Feb 5, 2025
2 parents aff76cc + ef772d0 commit ed365f0
Show file tree
Hide file tree
Showing 45 changed files with 1,090 additions and 740 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/stale.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ jobs:
days-before-issue-stale: 730
days-before-issue-close: 1
stale-issue-label: "stale"
stale-issue-message: >
stale-issue-message: >
We're in the process of cleaning up issues on this project in order to ensure we're able to stay on top of high priority bugs and feature requests.
As a part of this process, we're automatically closing any issues that have had no activity within the last two years, including this one, since the codebase has changed dramatically in that time.
If you feel this is still relevant, please [file a new issue](https://github.com/WPO-Foundation/webpagetest/issues/new/choose) using the relevant issue template so we can get it prioritized.
If you feel this is still relevant, please [file a new issue](https://github.com/catchpoint/WebPageTest/issues/new/choose) using the relevant issue template so we can get it prioritized.
Thanks!
close-issue-message: " "
days-before-pr-stale: -1
days-before-pr-close: -1
ascending: true
operations-per-run: 2000
repo-token: ${{ secrets.GITHUB_TOKEN }}
repo-token: ${{ secrets.GITHUB_TOKEN }}
75 changes: 38 additions & 37 deletions LICENSE_FAQ.md
View file
Original file line number Diff line number Diff line change
@@ -1,76 +1,77 @@
# WebPageTest by Catchpoint Licensing FAQ
# WebPageTest by Catchpoint Licensing FAQ

## Executive Summary
The WebPageTest code is free to use under the Polyform Shield license, a source-available license. As long as you are not creating a product or service that competes with Catchpoint’s offerings then you are free to do whatever you like with the WebPageTest code, including using it for your own internal use or creating non-competing commercial products from it. In fact, we encourage using the WebPageTest code to build your own value-added applications.

## What is the Polyform Shield License?
The WebPageTest code is free to use under the Polyform Shield license, a source-available license. As long as you are not creating a product or service that competes with Catchpoint’s offerings then you are free to do whatever you like with the WebPageTest code, including using it for your own internal use or creating non-competing commercial products from it. In fact, we encourage using the WebPageTest code to build your own value-added applications.

More information about Polyform licenses, including the Shield License, can be found here: https://polyformproject.org, and the Shield License is here: https://polyformproject.org/licenses/shield/1.0.0/.
## What is the Polyform Shield License?

We chose the Polyform Shield license because it provides a standard community-accepted license that provides the necessary protections for a commercial product while keeping the code as open as possible.
More information about Polyform licenses, including the Shield License, can be found here: https://polyformproject.org, and the Shield License is here: https://polyformproject.org/licenses/shield/1.0.0/.

A prior version of the WebPageTest code was released under the BSD and Apache 2.0 licenses. A branch of the code under that license is available [here](https://github.com/WPO-Foundation/webpagetest/tree/apache) for anyone in the community who wants to continue to use the code under that license or contribute to its maintenance.
We chose the Polyform Shield license because it provides a standard community-accepted license that provides the necessary protections for a commercial product while keeping the code as open as possible.

## What does this mean for my access and usage of the source code?
A prior version of the WebPageTest code was released under the BSD and Apache 2.0 licenses. A branch of the code under that license is available [here](https://github.com/catchpoint/WebPageTest/tree/apache) for anyone in the community who wants to continue to use the code under that license or contribute to its maintenance.

You can access the WebPageTest source code, and download, modify, or redistribute it with one limitation: you can’t use the WebPageTest source code to make a product that competes with Catchpoint. We’ve excerpted the relevant license language here:
## What does this mean for my access and usage of the source code?

> “Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.”
You can access the WebPageTest source code, and download, modify, or redistribute it with one limitation: you can’t use the WebPageTest source code to make a product that competes with Catchpoint. We’ve excerpted the relevant license language here:

For clarity, “permitted purposes” exclude providing any software-as a-service, platform-as-a-service, infrastructure-as-a-service or other similar online service that competes with Catchpoint products or services.
> “Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.”
We expect that almost all users of the WebPageTest will have no trouble abiding by this license. We hope this explanation is helpful, but the legal requirements are in the actual language of the license, not this FAQ.
For clarity, “permitted purposes” exclude providing any software-as a-service, platform-as-a-service, infrastructure-as-a-service or other similar online service that competes with Catchpoint products or services.

While our prior open source version is still available, we may no longer be maintaining this version.
We expect that almost all users of the WebPageTest will have no trouble abiding by this license. We hope this explanation is helpful, but the legal requirements are in the actual language of the license, not this FAQ.

If you are interested in a license of WebPageTest software on commercial licensing terms, please contact us at [[email protected]](mailto:[email protected]), and we would be happy to answer any questions and help you set up an enterprise relationship.
While our prior open source version is still available, we may no longer be maintaining this version.

## Can I embed WebPageTest source code licensed under the Polyform Shield License in a software I distribute?
If you are interested in a license of WebPageTest software on commercial licensing terms, please contact us at [[email protected]](mailto:[email protected]), and we would be happy to answer any questions and help you set up an enterprise relationship.

Yes, you are still able to do so, as long as that product does not compete with Catchpoint products and services.
## Can I embed WebPageTest source code licensed under the Polyform Shield License in a software I distribute?

## Can I embed Polyform Shield source code in a new SaaS offering?
Yes, you are still able to do so, as long as that product does not compete with Catchpoint products and services.

## Can I embed Polyform Shield source code in a new SaaS offering?

Yes, but only as long as your SaaS offering does not compete with Catchpoint products and services.

## Can I modify some of the WebPageTest source code licensed under the Polyform Shield License?
## Can I modify some of the WebPageTest source code licensed under the Polyform Shield License?

Yes, as long as your use case is covered by the “permitted purpose” defined in the license.
Yes, as long as your use case is covered by the “permitted purpose” defined in the license.

## Under the terms of the Polyform Shield License, can I create a competing product but give it away for free?
## Under the terms of the Polyform Shield License, can I create a competing product but give it away for free?

No; whether a fee is charged or not does change whether your product competes. A free-of-charge product that competes with Catchpoint products or services is still prohibited.
No; whether a fee is charged or not does change whether your product competes. A free-of-charge product that competes with Catchpoint products or services is still prohibited.

## Is the Polyform Shield License open source?
## Is the Polyform Shield License open source?

They are not exactly the same. The Polyform Shield License permits many of the same actions that “true” open source licenses do, such as downloading, modifying, and distributing the source code, but it does not permit the use case of creating a product “that competes with the software or any product the licensor or any of its affiliates provides,” as described above. The Polyform Shield License is technically source available, rather than open source, and we will refer to it as “source available.” The phrase “open source,” used strictly, refers to licenses adhering to a specific set of criteria published by the Open Source Initiative.
They are not exactly the same. The Polyform Shield License permits many of the same actions that “true” open source licenses do, such as downloading, modifying, and distributing the source code, but it does not permit the use case of creating a product “that competes with the software or any product the licensor or any of its affiliates provides,” as described above. The Polyform Shield License is technically source available, rather than open source, and we will refer to it as “source available.” The phrase “open source,” used strictly, refers to licenses adhering to a specific set of criteria published by the Open Source Initiative.

## When will the Polyform Shield License be effective?
## When will the Polyform Shield License be effective?

It will apply to WebPageTest software released as of November 1, 2020, and later releases. Previous releases and any bug fixes to such releases will remain under the BSD and Apache 2.0 licenses.
It will apply to WebPageTest software released as of November 1, 2020, and later releases. Previous releases and any bug fixes to such releases will remain under the BSD and Apache 2.0 licenses.

## Does the Polyform Shield License impose a general prohibition against competing with Catchpoint?
## Does the Polyform Shield License impose a general prohibition against competing with Catchpoint?

Yes, in the sense that you cannot use our software to compete with any of our products or services; see the definition of “permitted purpose” above.
Yes, in the sense that you cannot use our software to compete with any of our products or services; see the definition of “permitted purpose” above.

## I’m confused about what use cases are competitive. What if future Catchpoint products compete with mine?
## I’m confused about what use cases are competitive. What if future Catchpoint products compete with mine?

Competitive products are evaluated relative to the Catchpoint offerings at the time your product is created. If you create a product that does not compete with current Catchpoint offerings, then you can continue to use the WebPageTest software even if a future Catchpoint offering does compete. Please see the license for the exact limitations.
Competitive products are evaluated relative to the Catchpoint offerings at the time your product is created. If you create a product that does not compete with current Catchpoint offerings, then you can continue to use the WebPageTest software even if a future Catchpoint offering does compete. Please see the license for the exact limitations.

## Can I still use older versions of the WebPageTest software?
## Can I still use older versions of the WebPageTest software?

Yes; the new license terms don’t alter your ability to use older versions of the WebPageTest software under their open source license.
Yes; the new license terms don’t alter your ability to use older versions of the WebPageTest software under their open source license.

## My company doesn’t permit employees to use code with a non-commercial restriction. Can I still use WebPageTest under the new Polyform Shield license?
## My company doesn’t permit employees to use code with a non-commercial restriction. Can I still use WebPageTest under the new Polyform Shield license?

The only commercial restriction imposed is set out in the “permitted purposes” described above: a product that competes with Catchpoint. This is a much narrower restriction than a “non-commercial” restriction. If you want to use the software and are having trouble getting it approved by your company, contact us at [[email protected]](mailto:[email protected]), and we may be able to help.
The only commercial restriction imposed is set out in the “permitted purposes” described above: a product that competes with Catchpoint. This is a much narrower restriction than a “non-commercial” restriction. If you want to use the software and are having trouble getting it approved by your company, contact us at [[email protected]](mailto:[email protected]), and we may be able to help.

## Is the Polyform Shield License a EULA?
## Is the Polyform Shield License a EULA?

No, a “EULA” is an end user license agreement, and is almost always used for binary software only. The Polyform Shield License gives you other rights in addition to use, such as modification and distribution, in addition to use, subject only to the “permitted purposes” clause set out above.
No, a “EULA” is an end user license agreement, and is almost always used for binary software only. The Polyform Shield License gives you other rights in addition to use, such as modification and distribution, in addition to use, subject only to the “permitted purposes” clause set out above.

## Why did Catchpoint make this change?
## Why did Catchpoint make this change?

This lets us invest heavily in code that we distribute for free, while sustaining a healthy business that funds this investment.
This lets us invest heavily in code that we distribute for free, while sustaining a healthy business that funds this investment.

This change is similar to and made for similar reasons as other companies that have gone through similar licensing adjustments. We still believe in the WebPageTest project and its availability as a resource for the community.
This change is similar to and made for similar reasons as other companies that have gone through similar licensing adjustments. We still believe in the WebPageTest project and its availability as a resource for the community.
5 changes: 2 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
This is the official repository for the performance-testing code that runs at [webpagetest.org](https://www.webpagetest.org).

- 🥡 [Install your own instance](https://docs.webpagetest.org/private-instances/)
- 📕 [Documentation](https://github.com/WPO-Foundation/webpagetest-docs)
- 📕 [Documentation](https://github.com/catchpoint/WebPageTest.docs)
- 🕒 [Changelog](https://docs.webpagetest.org/change-log)
- 🌐 [Cross-platform browser agent](https://github.com/WPO-Foundation/wptagent)
- [WPT website global header repo](https://github.com/WebPageTest/wpt-header) and [documentation](https://wpt-header.netlify.app/)
- 🌐 [Cross-platform browser agent](https://github.com/catchpoint/WebPageTest.agent)
- 💤 [REST API](https://docs.webpagetest.org/api/) examples:
- 🐘 [`/bulktest`](/bulktest/): A PHP command-line tool that can submit a bulk set of tests, gather the results, and aggregate analyses.
- 🐍 [`/batchtool`](/batchtool/): A Python tool that can submit a bulk set of tests and gather the results.
Expand Down
2 changes: 1 addition & 1 deletion bulktest/alexa-curated.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ www.aol.com/
wenwen.sogou.com/
www.yelp.com/search?find_desc=dinner&find_loc=New+York%2C+NY&ns=1
ameblo.jp/
https://github.com/WPO-Foundation/webpagetest
https://github.com/catchpoint/WebPageTest
new.livejasmin.com/en/
www.slideshare.net/patrickmeenan
www.w3schools.com/html/default.asp
Expand Down
2 changes: 1 addition & 1 deletion docker/local/Dockerfile-wptagent
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ RUN ln -fs /usr/share/zoneinfo/$TIMEZONE /etc/localtime && apt install -y \
ttf-mscorefonts-installer fonts-noto fonts-roboto fonts-open-sans ffmpeg npm sudo curl xvfb

# Get WPTAgent for dependecies
RUN git clone -b master https://github.com/WPO-Foundation/wptagent.git
RUN git clone -b master https://github.com/catchpoint/WebPageTest.agent.git

### UPDATE FONT CACHE ###
RUN fc-cache -f -v
Expand Down
6 changes: 3 additions & 3 deletions docker/local/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The reason for failure on WSL2 is because WSL2 does not have the network interfa
Clone the project

```bash
git clone https://github.com/WPO-Foundation/webpagetest.git
git clone https://github.com/catchpoint/WebPageTest.git
```
Go to the project directory

Expand Down Expand Up @@ -53,7 +53,7 @@ Since the Webpagetest container is packaged with an agent, we first need to stop
#### ####
```

Then follow the guide on how to install Wptagent (https://github.com/WPO-Foundation/wptagent). Once the Agent is working, which can be confirmed by running a local test with...
Then follow the guide on how to install [Wpt Agent](https://github.com/catchpoint/WebPageTest.agent). Once the Agent is working, which can be confirmed by running a local test with...

```bash
python3 wptagent.py -vvvv --xvfb --testurl www.google.com --shaper none #Shaper doesn't work with my instance
Expand All @@ -78,7 +78,7 @@ Adjusting Webpagetest Keys? Adjust them here
`docker/local/wptconfig/keys.ini`

Looking for more information setting up? Check Out
- `https://github.com/WPO-Foundation/wptserver-install`
- `https://github.com/catchpoint/WebPageTest.server-install`
- `https://www.robinosborne.co.uk/2021/12/22/automate-your-webpagetest-private-instance-with-terraform-2021-edition/`


Expand Down
4 changes: 2 additions & 2 deletions docs/EC2/Server AMI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ api_key=MyAPIKey
headless=0
```

The full list of settings that can be specified is in [settings.ini.sample](https://github.com/WPO-Foundation/webpagetest/blob/master/www/settings/settings.ini.sample)
The full list of settings that can be specified is in [settings.ini.sample](https://github.com/catchpoint/WebPageTest/blob/master/www/settings/settings.ini.sample)

EC2 test agent AMIs can be found [here](https://github.com/WPO-Foundation/webpagetest-docs/blob/master/user/Private%20Instances/ec2_agents.md)
EC2 test agent AMIs can be found [here](https://github.com/catchpoint/WebPageTest.docs/blob/main/src/private-instances/ec2_agents.md)

Connect to a Windows Test Agent:

Expand Down
2 changes: 1 addition & 1 deletion docs/Private Instances/MobileAgentRaspberryPi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ SUBSYSTEM=="usb", ATTR{idVendor}=="2b4c", MODE="0666", GROUP="plugdev", OWNER="<
By far, the easiest way to get the code and keep it up to date is to clone the WebPageTest github repository.

1. ```cd ~```
2. ```git clone https://github.com/WPO-Foundation/webpagetest.git webpagetest```
2. ```git clone https://github.com/catchpoint/WebPageTest.git webpagetest```
3. Test to make sure the python dependencies are working
- ```cd webpagetest/agent/js/lib/video```
- ```python visualmetrics.py --check```
Expand Down
2 changes: 1 addition & 1 deletion docs/adr/0004-adopt-laravel.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ In phase 3 we convert each of the old entry points from `/wpt` to Laravel contro

### Views

In phase 1 we adopt the Blade templating engine. This is already [under way](https://github.com/WPO-Foundation/webpagetest/pull/2228) and the templates live in `www/resources`
In phase 1 we adopt the Blade templating engine. This is already [under way](https://github.com/catchpoint/WebPageTest/pull/2228) and the templates live in `www/resources`

In the same phase we convert the prior template work from `www/templates` (which has API similar to Blade) to Blade, so we avoid having things like three competing footers.

Expand Down
Loading

0 comments on commit ed365f0

Please sign in to comment.