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.

Sign up for GitHub

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

Improved docs for custom env #41

Merged
merged 5 commits into from
Oct 28, 2024
Merged

Improved docs for custom env #41

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
66e3d64
update configure-pygraphistry for custom py envs
mj3cheun May 6, 2024
08524cf
improved documents for pyenv feature
mj3cheun Jun 10, 2024
b4ef1b1
Merge branch 'master' into doc-for-custom-env
mj3cheun Jun 10, 2024
c59f3d8
correct telemetry local error
mj3cheun Jun 10, 2024
248ba18
Merge branch 'master' into doc-for-custom-env
lmeyerov Oct 28, 2024
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
4 changes: 4 additions & 0 deletions docs/configure-dashboards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,7 @@ Graphistry maintains [graph-app-kit](http://github.com/graphistry/graph-app-kit)
2. Disable the dashboard services:
* Edit your `docker-compose.override.yml`
* Services: `graph-app-kit-public` and `graph-app-kit-private`

## Add or modify python libraries

Python libraries can be added or modified as desired. See [graph-app-kit documentation](https://github.com/graphistry/graph-app-kit/blob/master/docs/additional-packages.md) for more information on how to use this feature.
14 changes: 13 additions & 1 deletion docs/configure-pygraphistry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,19 @@ config_paths = [

If you are using Graphistry's built-in Jupyter server, it autoconfigures `PYGRAPHISTRY_CONFIG` and `graphistry.config`. Modify `docker-compose.yml`'s `notebook` section's volume mounts for new behavior. You can check the container's default config by running `! cat /home/graphistry/pygraphistry.config` from a notebook.

Libraries can be added using `pip` in the built-in Jupyter server. To enable new library install or existing library override, enter the server running the notebook container and change the permissions of the python env directory using `sudo chown -R ubuntu:ubuntu /home/ubuntu/graphistry/data/py_envs/jupyter`.
To enable new library install or existing library override, enter the server running the notebook container and change the permissions of the python env directory using `sudo chown -R ubuntu:ubuntu /home/ubuntu/graphistry/data/py_envs/jupyter`.

Libraries can be added using `pip` in the built-in Jupyter server. See examples below:

```bash
# inside JupyterLab terminal
pip install graphistry[AI]==0.33.8
```

```python
# inside Jupyter notebook
!pip install graphistry[AI]==0.33.8
```

## Examples

Expand Down
1 change: 0 additions & 1 deletion docs/telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ For example, this is the configuration template for a local development env that
```bash
ENABLE_OPEN_TELEMETRY=true

OTEL_COLLECTOR_OTLP_HTTP_ENDPOINT="https://hostname.grafana.net/otlp" # e.g. Grafana OTLP HTTP endpoint
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mj3cheun I think I may have lost this in the mere, and don't know what the right thing to do here, can you check in case a new PR needed to reintroduce?

(pushing updates in a few sec)

OTEL_COLLECTOR_COMPOSE_FILE=compose/otel-collector.dev.yml
OTEL_COLLECTOR_CONF_FILE=./etc/otel-collector/otel-collector-config.dev.yml
OTEL_COLLECTOR_PUB_COMPOSE_FILE=compose/otel-collector-pub.yml
Expand Down