{"id":20272297,"url":"https://github.com/ogoodness/graph-notebook-docker","last_synced_at":"2025-03-04T00:07:51.587Z","repository":{"id":104473026,"uuid":"508726590","full_name":"OGoodness/graph-notebook-docker","owner":"OGoodness","description":"AWS Graph Notebook within a docker container: https://hub.docker.com/repository/docker/ogoodness/graph-notebook","archived":false,"fork":false,"pushed_at":"2022-06-30T15:24:04.000Z","size":5,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-14T06:08:22.629Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OGoodness.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-29T14:30:22.000Z","updated_at":"2023-05-23T17:43:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"c938b32d-c1ad-4b25-bf5c-ba6b1e283d51","html_url":"https://github.com/OGoodness/graph-notebook-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGoodness%2Fgraph-notebook-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGoodness%2Fgraph-notebook-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGoodness%2Fgraph-notebook-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OGoodness%2Fgraph-notebook-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OGoodness","download_url":"https://codeload.github.com/OGoodness/graph-notebook-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241758960,"owners_count":20015251,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T12:42:46.910Z","updated_at":"2025-03-04T00:07:51.567Z","avatar_url":"https://github.com/OGoodness.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\nRun `%load_ext graph_notebook.magics` at the top of a notebook to enable gremlin magic like `%%gremlin`\n\nDefault password is `admin`.\n\n## Example Runs\n```sh\ndocker run --network=\"host\"  -p 8888:8888 ogoodness/graph-notebook\n\n# Sharing directories\ndocker run --network=\"host\"  -p 8889:8889 -p 8888:8888 -v $(pwd)/out:/working \n\n# For connecting with IAM Auth\ndocker run -p 8888:8888 \\\n -e AWS_ACCESS_KEY_ID \\\n -e AWS_SECRET_ACCESS_KEY \\ \n -e AWS_SESSION_TOKEN \\ \n -e AWS_REGION=\"us-east-1\" \\\n ogoodness/graph-notebook\n```\n\nExample Notebooks are placed in the `Example Notebooks` sub-directory\n\nWithin the Jupyter Notebook you must configure the Notebook settings to account for `localhost` or `remote` connections.\n\n### Example Localhost Connection:\n```ipynb\n%%graph_notebook_config\n    {\n        \"host\": \"localhost\",\n        \"port\": 8182,\n        \"ssl\": false,\n        // Proxy port can be defined without attempting to proxy\n        \"proxy_port\":8182,\n        \"proxy_host\": \"\",\n        \"auth_mode\": \"IAM\",\n        \"aws_region\": \"us-east-1\",\n        \"load_from_s3_arn\": \"\"\n    }\n```\n\n### Example Neptune Proxy Connection:\n```ipynb\n    {\n        \"host\": \"clustername.cluster-ididididid.us-east-1.neptune.amazonaws.com\",\n        \"port\": 8182,\n        \"ssl\": true,\n        \"proxy_port\": 8182,\n        \"proxy_host\": \"host.proxy.com\",\n        \"auth_mode\": \"IAM\",\n        \"aws_region\": \"us-east-1\",\n        \"load_from_s3_arn\": \"\"\n    }\n```\n\n\n\n## Configurable Properties\n\n| Parameter      | Description |\n| ----------- | ----------- |\n| WORKING_DIR   | Where installation happens inside of container        |\n| NOTEBOOK_DIR   | Where all Notebooks are held within the container        |\n| EXAMPLE_NOTEBOOK_DIR   | Where automatically created Notebooks are created (Subfolder of NOTEBOOK_DIR)        |\n| NODE_VERSION   | Version of Node used for visualizations        |\n| GRAPH_NOTEBOOK_AUTH_MODE   | What type of auth should be used for connection to the Graph DB        |\n| GRAPH_NOTEBOOK_HOST   | Host Graph Notebook will attempt to connect to for queries         |\n| GRAPH_NOTEBOOK_PORT   | Port graph notebook will use to attempt connection to port        |\n| NEPTUNE_LOAD_FROM_S3_ROLE_ARN   | Text        |\n| AWS_REGION   | Region Neptune instance is located in AWS        |\n| NOTEBOOK_PORT   | Port Jupyter Lab is listening on. (8888)        |\n| LAB_PORT   | Port Jupyter Lab is listening on. (8889)        |\n| GRAPH_NOTEBOOK_SSL   | Whether or not to use SSL for connections        |\n| NOTEBOOK_PASSWORD   | Password to login into jupyter (default: admin)       |\n| pipargs   | Arguments used during pip install        |\n| PROVIDE_EXAMPLES   | Whether or not to automatically copy example notebooks over when a volume is being shared.        |\n| GRAPH_NOTEBOOK_PROXY_HOST   | Host that will proxy requests to Neptune. Will not proxy if not provided.        |\n| GRAPH_NOTEBOOK_PROXY_PORT   | Port for proxy host.        |\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fogoodness%2Fgraph-notebook-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fogoodness%2Fgraph-notebook-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fogoodness%2Fgraph-notebook-docker/lists"}