Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation for python endpoint env var #46

Merged
merged 6 commits into from
Oct 28, 2024
Merged
Changes from 1 commit
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
9 changes: 9 additions & 0 deletions docs/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@ Recommendations for SSO when self-hosting:
* Disallow non-SSO account creation
* Decide whether SSO users can automatically join organizations without an invitation

## Features

Certain Graphistry features can be enabled or disabled through environment variables to ensure that these features cannot be accessed without explicit permission from an administrator regardless of in-app permissions configuration. In all cases, access can also be more finely controlled using waffle flags set within Graphistry. All feature configuration is done through the file `data/config/custom.env`. Each feature listed below is assigned a corresponding environment variable name. Environment variables can be set to either `true` or `false` to enable or disable the associated feature. An unset environment variable associated with a given feature is treated as `false`.

### Python Endpoint

The Python endpoint allows any user granted access a way to retrieve datasets stored within Graphistry and process it using unrestricted arbitrary user provided Python code. This Python code can include a limited set of external libraries such as `numpy` and `cudf`, in addition to `graphistry`, and can access all computational resources available to the forge-etl-python server including GPU compute. The result is returned to the user as a string or as JSON.

It is recommended that an administrator checks to ensure that only trusted users are provided access via the `flag_python_endpoint` waffle flag before the `ENABLE_PYTHON_ENDPOINT` environment variable is set to `true`.
lmeyerov marked this conversation as resolved.
Show resolved Hide resolved

## TLS

Expand Down