Skip to content

Update extension docs #16

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

Merged
adsharma merged 1 commit into from
Feb 3, 2026
Merged

Update extension docs #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 5 additions & 29 deletions src/content/docs/extensions/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,6 @@ Ladybug has an extension API that is designed to dynamically extend its capabili
you to dynamically load the functionality you need at runtime, while helping limit the size of
the core Ladybug library.

:::caution[Note]
Ladybug no longer provides an official extensions server, from where you can directly install the official extensions.

If you've upgraded to the latest version v0.11.3, Ladybug has pre-installed and pre-loaded four commonly used extensions (`algo`, `fts`, `json`, `vector`) for you.
You do not need to manually INSTALL or LOAD these extensions.

For Ladybug versions before v0.11.3, or to install extensions that haven't been pre-installed into v0.11.3, you have to set up a local extension server.
The instructions of setting up a local extension server can be found [here](/extensions#host-your-own-extension-server).
:::

## Available extensions

The following extensions are currently implemented:
Expand Down Expand Up @@ -54,15 +44,10 @@ CALL SHOW_OFFICIAL_EXTENSIONS() RETURN *;

Ladybug requires you to install the extension before loading and using it.

:::caution[Note]
In the latest version v0.11.3 Ladybug has pre-installed four commonly used extensions (`algo`, `fts`, `json`, `vector`) for you.
You do not need to manually INSTALL these extensions.
:::

Official extensions can be installed from a [local extension server](/extensions#host-your-own-extension-server) by running the `INSTALL` command.
Official extensions can be installed from the official extension server by running the `INSTALL` command.

```cypher
INSTALL <EXTENSION_NAME> FROM 'http://localhost:8080/';
INSTALL <EXTENSION_NAME>;
```
You only need to install an extension once.

Expand All @@ -80,11 +65,6 @@ UPDATE <EXTENSION_NAME>;

### Load an extension

:::caution[Note]
In the latest version v0.11.3, Ladybug has pre-loaded four commonly used extensions (`algo`, `fts`, `json`, `vector`) for you.
You do not need to manually LOAD these extensions anymore.
:::

You must load extensions before you can use them:

```cypher
Expand Down Expand Up @@ -131,17 +111,13 @@ Uninstalling a currently loaded extension won't affect the running database inst

### Host your own extension server

You can host your own extension server for Ladybug using Docker.
If you need to host your own extension server for custom extensions, you can do so using Docker.

The extension server is based on NGINX and is hosted on [GitHub](https://ghcr.io/ladybugdb/extension-repo). You can pull the Docker image and run it in your environment:
You can pull the Docker image and run it in your environment:

```bash
docker pull ghcr.io/ladybugdb/extension-repo:latest
docker run -d -p 8080:80 ghcr.io/ladybugdb/extension-repo:latest
```

In this example, the extension server will be available at `http://localhost:8080`. You can then install extensions from your server by appending the `FROM` clause to the `INSTALL` command:

```cypher
INSTALL <EXTENSION_NAME> FROM 'http://localhost:8080/';
```
In this example, the extension server will be available at `http://localhost:8080`.