Sign inSign up

katalonstudio/katalon-tunnel

By katalonstudio

•Updated 4 months ago

Katalon Tunnel Docker Images

Image
0

1.1K

katalonstudio/katalon-tunnel repository overview

⁠Katalon Tunnel

Docker Pulls Docker Image Version License

Katalon Tunnel enables secure, encrypted connections between your local or private network environments and the Katalon Platform. It allows you to run tests against internal services without exposing them to the public internet.

⁠Table of Contents

⁠Quick Start

docker pull katalonstudio/katalon-tunnel:latest

⁠Usage

There are two supported ways to run the Katalon Tunnel container.

⁠Option 1 — Environment Variables

Pass authentication parameters directly as environment variables at runtime. This is the recommended approach for CI/CD pipelines and automated workflows.

docker run --rm \
    -e KATALON_API_KEY=xxx-e777-436a-xxx-xxx \
    -e KATALON_ACCOUNT_ID=xxxx-285e-549f-806c-xxx \
    -e KATALON_ORGANIZATION_ID=12345678 \
    -e [email protected] \
    katalonstudio/katalon-tunnel:latest

Note: You can use either KATALON_GROUP or KATALON_ACCOUNT_ID to identify your group/account. If KATALON_GROUP is specified, it takes precedence over KATALON_ACCOUNT_ID.

⁠Option 2 — Configuration File

Mount a tunnelconfig file from your host machine into the container. This is useful when you want to manage credentials outside of environment variables or share a consistent configuration across teams.

Step 1. Obtain your tunnelconfig file from the Katalon Platform and save it to your local machine (e.g., /path/to/tunnelconfig).

Step 2. Run the container with the file mounted:

docker run --rm \
    -v /path/to/tunnelconfig:/opt/katalon/tunnelconfig \
    katalonstudio/katalon-tunnel:latest

⁠Environment Variables

VariableRequiredDescription
KATALON_API_KEYYesYour Katalon API key for authentication.
KATALON_USERNAMEYesThe Katalon account email address (e.g., [email protected]).
KATALON_ORGANIZATION_IDYesThe numeric ID of your Katalon organization.
KATALON_GROUPNoGroup identifier (UUID). Takes precedence over KATALON_ACCOUNT_ID when specified.
KATALON_ACCOUNT_IDYesAccount identifier (UUID). Used when KATALON_GROUP is not set.

⁠Tags

TagDescription
1.0.0-rcRelease candidate for v1.0.0
latestLatest stable release

Browse all available tags on the Tags page⁠.

⁠License

By using this Docker image, you agree to the Katalon License Agreement⁠. This image is intended for use with a valid Katalon account.

⁠Support

Tag summary

Content type

Image

Digest

sha256:dccc4fcda…

Size

11.9 MB

Last updated

4 months ago

docker pull katalonstudio/katalon-tunnel