Gephi Lite

https://docs.gephi.org/lite
Admin
Gephi Lite is a web-based network visualization and analysis tool that enables users to explore and...
Tokens:5,369
Snippets:51
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Build Gephi Lite from Source

Source: https://docs.gephi.org/lite/integration/deploying

This sequence of commands outlines the process of building Gephi Lite from its source code. It includes cloning the Git repository, navigating into the project directory, installing npm dependencies, and building the project. The `BASE_URL` environment variable can be set to control the application's base path during the build.

```bash
git clone https://github.com/gephi/gephi-lite.git
cd gephi-lite
npm install
export BASE_URL=/ && npm run build
```

--------------------------------

### Serve Gephi Lite Static Files with Python HTTP Server

Source: https://docs.gephi.org/lite/integration/deploying

This command starts a simple HTTP server using Python's built-in module to serve the static files generated by the Gephi Lite build process. The server will be accessible at http://0.0.0.0:8000. This is useful for quickly testing the built application locally.

```bash
python -m http.server
```

--------------------------------

### Embed Gephi Lite using iframe and Graph URL

Source: https://docs.gephi.org/lite/integration/embed

This snippet demonstrates how to embed Gephi Lite into an HTML page using an iframe. The `src` attribute points to the Gephi Lite instance, and a query parameter `file` specifies the URL of the graph data (a JSON file in this example). Ensure the graph file is hosted on a CORS-enabled server. The iframe attributes control its size and fullscreen capability.

```html
<iframe  
  width="100%"  
  height="600px"  
  allowfullscreen="true"  
  src="https://lite.gephi.org/?file=https://gist.githubusercontent.com/jacomyal/08b9cdd4c629f64c299eaa8b922bc37b/raw/a85f7bb53a6f6bb17cf3f5c0991142708f120146/arctic-shaded.json"  
/>  

```

--------------------------------

### Serve Gephi Lite Static Files with Npx HTTP-Serve

Source: https://docs.gephi.org/lite/integration/deploying

This command initiates a static file server using the `http-serve` package via npx. It serves files from the current directory, making the built Gephi Lite application accessible locally. The server is typically available at http://127.0.0.1:8081.

```bash
npx http-serve
```

--------------------------------

### Configure Nginx to Serve Gephi Lite

Source: https://docs.gephi.org/lite/integration/deploying

This Nginx configuration block sets up a server to host the built Gephi Lite application. It specifies the root directory for static files and includes a crucial `location` block to handle React routing by attempting to serve files directly or fallback to a 404. Additionally, it configures a proxy for GitHub authentication to work correctly with CORS headers.

```nginx
server {
  listen 80 default_server;
  listen [::]:80 default_server;
  server_name _;
  
  # Replace this location with the one where you placed the Gephi Lite files
  root /var/www/html/gephi-lite;
  
  # Required for React applications
  location / {
    try_files $uri $uri/ =404;
  }
  
  # For GitHub authentication to work
  # We need to create a GitHub proxy to `https://github.com/login` that accepts CORS
  location /_github/login {
    add_header Access-Control-Allow-Origin "*";
    add_header Access-Control-Allow-Methods "GET, POST, OPTIONS";
    add_header Access-Control-Allow-Headers "Origin, X-Requested-With, Content-Type, Accept, user-agent";

    if ($request_method = OPTIONS) {
      return 204;
    }

    proxy_pass https://github.com/login;
  }
}
```

--------------------------------

### Share Graphs as URL

Source: https://docs.gephi.org/lite/user-manual/share-graph-as-url

Gephi Lite allows users to open Gexf, GraphMl, or Gephi-Lite JSON files hosted on the web by appending a 'file' query parameter to the Gephi Lite URL.

```APIDOC
## GET /gephi_lite

### Description
This endpoint allows loading a graph file directly into Gephi Lite via a URL.

### Method
GET

### Endpoint
https://lite.gephi.org/

### Query Parameters
- **file** (string) - Required - The URL to the graph file (GEXF, GraphML, or Gephi Lite JSON format).

### Request Example
```
https://lite.gephi.org/?file=URL_TO_YOUR_GRAPH
```

### Response
#### Success Response (200)
The graph is loaded and displayed within the Gephi Lite interface.

#### Response Example
(No direct response body, the result is the loaded graph visualization)

### Notes
- The graph file must be hosted on a server that authorizes Cross-origin resource sharing (CORS) with `lite.gephi.org` or allows all domains (`*`).
- Supported file extensions are `.gexf`, `.graphml`, and `.json`.
- GitHub repositories (raw links) and Gists are recommended hosting options due to their open CORS policy.
```

--------------------------------

### Control Gephi Lite Instance with TypeScript Driver

Source: https://docs.gephi.org/lite/integration/typescript-driver

This TypeScript function demonstrates how to instantiate the GephiLiteDriver, open a new Gephi Lite tab, set its graph dataset, appearance, and filters, and then destroy the driver. It requires the `@gephi/gephi-lite-broadcast` package and internal Gephi Lite typings.

```typescript
import { GephiLiteDriver } from "@gephi/gephi-lite-broadcast";
import {
  AppearanceState,
  FiltersState,
  GraphDataset,
} from "@gephi/gephi-lite-sdk";

export async function openInNewTab({
  dataset,
  appearance,
  filters,
}: { dataset?: GraphDataset; appearance?: AppearanceState; filters?: FiltersState } = {}) {
  const driver = new GephiLiteDriver();
  await driver.openGephiLite({ baseUrl: location.pathname });
  await Promise.all([
    driver.setAppearance(appearance),
    driver.setFilters(filters),
    driver.setGraphDataset(dataset),
  ]);
  driver.destroy();
}
```

--------------------------------

### Deploy Gephi Lite with Docker

Source: https://docs.gephi.org/lite/integration/deploying

This snippet demonstrates how to deploy Gephi Lite using its official Docker image. It pulls the latest image from Docker Hub and runs it as a detached container, mapping port 80 on the host to port 80 in the container. Access Gephi Lite by navigating to http://localhost in your browser.

```bash
docker pull ouestware/gephi-lite:latest
docker run --name gephi-lite -d -p 80:80 ouestware/gephi-lite:latest
```
Tokens:
Raw