Sandbox Client

Sandbox Client is a proxy server that routes bidirectional requests between your development machine and the Akamai network via a secure gateway. You need to download the client, set up the connection to your sandbox, and configure it to point to your development environment as origin.

Technical setup requirements

In order to use Sandbox Client, you need:

Download client from GitHub

📘

If you are using Sandbox CLI, this process is automated.

  1. Launch https://github.com/akamai/sandbox-client in a browser.

  2. Download the sandbox-client-1.4.0-RELEASE-default.zip file and extract the contents.
    The extracted folder contains the binary files required to launch Sandbox Client.

Configure your sandbox client

📘

If you are using Sandbox CLI, this process is automated.

Follow these steps to define the origin mappings for your development environment.

  1. Locate the files you extracted from sandbox-client-1.X-RELEASE-default.zip.

  2. Open config.json in a text editor.

  3. Set the originMappings appropriate for your development environment.

  4. Paste your jwtToken where it says <ENTER JWT HERE>.

    📘

    You need a jwtToken to configure the client. Get this from the response body when you Create a sandbox.

  5. Save the file.

  6. In a command line tool, navigate to the directory that contains Sandbox Client, then run the script appropriate for your operating system.

    • Windows: /bin/sandbox.bat
    • Linux/Mac: /bin/sandbox.sh

Test sandbox connection

To confirm that a request is routed to the sandbox in your development environment, you'll point a requestHostname to your sandbox then validate that Sandbox Client routes requests securely through your sandbox. Once it's set up properly, the browser retrieves content from the development machine rather than the production origin.

  1. Open your /etc/hosts/ file, and add the requestHostname you want to test within your sandbox.

  2. Enter that requestHostname in your browser.

  3. Confirm you can see the response header X-Akamai-Sandbox=true which indicates that the response was returned from your developer sandbox.

Once you confirm requests are being routed through your sandbox, you can Test site changes or Test property changes and view the results in your development environment.


Did this page help you?