Skip to content

Commit

Permalink
- added doc for private location
Browse files Browse the repository at this point in the history
  • Loading branch information
sker65 committed Sep 12, 2024
1 parent 7f4e503 commit 7da1386
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 1 deletion.
Binary file added images/plw-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
},
{
"group": "Advanced",
"pages": ["variables", "rate-limiting"]
"pages": ["variables", "rate-limiting", "private-location"]
},
{
"group": "Changelog",
Expand Down
49 changes: 49 additions & 0 deletions private-location.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Private Location Worker
description: "How to access applications that are not publicly available"
icon: "key"
---
## Overview

Check warning on line 6 in private-location.mdx

View workflow job for this annotation

GitHub Actions / eslint

Insert `⏎`

<Frame caption="private location worker overview">
<img src="/images/plw-overview.png" alt="private location worker overview" />
</Frame>

The Private Location Worker allows customers to include non-publicly available applications in Octomind discovery and test execution. It is run by the customer within their private network, enabling it to reach internal applications for testing.

The worker acts as a combination of a proxy and tunneling mechanism, connecting the private network with the Octomind platform. This feature ensures secure access to applications hosted behind firewalls or other private environments.

## Features

### Tunneling with FRP
- The tunneling is managed using [FRP](https://github.com/fatedier/frp), connecting the worker’s frp-client to Octomind’s proxy servers (EU or US).

Check warning on line 19 in private-location.mdx

View workflow job for this annotation

GitHub Actions / eslint

Insert `⏎`
- Requires access permission to specific public IPs: `35.192.162.70` or `34.159.153.198`.

### Access to Private Web Applications
- The embedded Squid proxy server allows requests from the private network, mimicking public proxy requests from within the customer’s network.

Check warning on line 23 in private-location.mdx

View workflow job for this annotation

GitHub Actions / eslint

Insert `⏎`

Check warning on line 24 in private-location.mdx

View workflow job for this annotation

GitHub Actions / eslint

Delete `··`
### Test Execution and Discovery

Check warning on line 25 in private-location.mdx

View workflow job for this annotation

GitHub Actions / eslint

Insert `⏎`
- After registering the worker with Octomind, users can configure the proxy location for executing discovery or test runs.

## Configuration

The Private Location Worker can be configured using environment variables:

- **API-KEY**: API key from the Octomind platform.
- **NAME**: Worker name displayed in the Octomind platform.
- **PROXY_USER**: Proxy username.
- **PROXY_PASS**: Proxy password.
- **SERVER_ADDR**: Tunnel server address (default: `35.159.153.198`).

## Security Considerations

- The container image is open-source, allowing customers to review and build their own versions. [GitHub Repository](https://github.com/OctoMind-dev/private-location-worker).
- Network access can be restricted to the tunnel server and test targets.
- The Squid proxy requires authentication, ensuring secure access.

## Additional Links

Check warning on line 44 in private-location.mdx

View workflow job for this annotation

GitHub Actions / eslint

Insert `⏎`
- [Two IP Addresses Documentation](https://octomind.dev/docs/data-governance/no-code-access#two-ip-addresses)
- [Quickstart Guide for API Key](https://octomind.dev/docs/integrations/quickstart-GitHub#1-create-an-api-key)
- [Github Fast Reverse Proxy](https://github.com/fatedier/frp)
- [Github Repository for Private Location Worker](https://github.com/OctoMind-dev/private-location-worker)
- [API Ref: register a private location](https://octomind.dev/docs/api-reference/register-a-private-location)

0 comments on commit 7da1386

Please sign in to comment.