Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,14 @@ For more in depth Docker instructions, follow the [Docker environment for Jetpac

## Setting up Jurassic Tube

In order to test features that require a WordPress.com connection and other network related Jetpack features, you'll need a test site that can create local HTTP tunnels. If you're an Automattician, we recommend using Jurassic Tube.
**Note:** This is for Automattician use only. For other methods, check out [ngrok](../tools/docker/README.md#using-ngrok-with-jetpack) or [another similar service](https://alternativeto.net/software/ngrok/).

Note: This is for Automattician use only. For other methods, check out [ngrok](../tools/docker/README.md#using-ngrok-with-jetpack) or [another similar service](https://alternativeto.net/software/ngrok/).
In order to test features that require a WordPress.com connection and other network related Jetpack features, you'll need a test site that can create local HTTP tunnels. If you're an Automattician, we recommend using Jurassic Tube.

To set up Jurassic Tube and establish a tunnel to your local machine, use the following instructions: PCYsg-GJ2-p2

For detailed information about using Jurassic Tube with Docker, including recommended proxy configurations, see the [Jurassic Tube Tunneling Service](../tools/docker/README.md#jurassic-tube-tunneling-service) section in the Docker documentation.

## Development Workflow

Once you have a local copy of Jetpack and all development tools installed, you can start developing.
Expand Down
44 changes: 27 additions & 17 deletions tools/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,31 +269,41 @@ define( 'JETPACK__SANDBOX_DOMAIN', '{your sandbox}.wordpress.com' );

## Jurassic Tube Tunneling Service

This is for Automatticians only. More information: PCYsg-snO-p2.
This is for Automatticians only.

If you have persistent trouble with the `jetpack docker jt-*` commands complaining that "Tunneling scripts are not installed", it could be because Docker wasn't running properly when you ran the installer.
Jurassic Tube is a tunneling service that allows you to expose your local Docker environment to the internet, enabling you to connect Jetpack to WordPress.com for testing.

To solve this problem, run these commands from the repo root:
### Setup

```
jetpack docker up -d
chmod +x tools/docker/bin/jt/installer.sh && tools/docker/bin/jt/installer.sh
```
To set up Jurassic Tube and establish a tunnel to your local machine, follow the instructions here: PCYsg-GJ2-p2

### Recommended Proxy Configuration

Once you have successfully installed Jurassic Tube, you can use these commands during development:
When using Jurassic Tube with Docker, you may need to configure proxy settings to ensure proper connectivity with WordPress.com. If you experience connection issues (such as cURL SSL errors), use one of these methods:

* Start the tunnel: `jetpack docker jt-up your-username your-subdomain`
* Break the connection: `jetpack docker jt-down`
**Method 1: Configure Docker Desktop Proxy Settings**

You can also set default values:
1. Open Docker Desktop
2. Click the gear icon in the top right
3. Navigate to **Resources** → **Proxy**
4. Enable "Manual proxy configuration"

```shell script
jetpack docker jt-config username your-username
jetpack docker jt-config subdomain your-subdomain
**Method 2: Configure Proxy in wp-config.php**

Add the following lines to `tools/docker/wordpress/wp-config.php`:

```php
define( 'WP_PROXY_HOST', 'socks://host.docker.internal' );
define( 'WP_PROXY_PORT', '8080' );
```
That will let you omit those parameters while initiating the connection:
```shell script
jetpack docker jt-up

**Note:** If you're not using Autoproxxy or working with Jetpack Boost alongside a Boost Cloud dev environment, these proxy settings may cause issues. Only apply them if needed.

After applying either method, restart your Docker container:

```bash
jetpack docker down
jetpack docker up -d
```

## Using Ngrok with Jetpack
Expand Down