Setup
Create your Vellumine account and set up your first search collection.
Create an Account
Head to app.vellumine.com and sign up. Once you're logged in, you'll be taken to your dashboard.
Create a Collection
A collection is a search index for one Ghost blog. To create one, click New Collection and follow the three-step wizard.
Step 1: Enter Your Blog Details
You'll need to provide:
| Field | Description |
|---|---|
| Name | A label for this collection (e.g. your blog's name). |
| Description | An optional description for your own reference. |
| Ghost Admin URL | The URL of your Ghost site (e.g. https://yourblog.com). |
| Ghost Admin API Key | An Admin API key from your Ghost settings. |
Finding Your Ghost Admin API Key
- In your Ghost admin panel, go to Settings > Integrations.
- Click Add custom integration.
- Give it a name (e.g. "Vellumine") and click Create.
- Copy the Admin API Key value.
Vellumine uses the Admin API key in read-only mode to fetch your posts, pages, authors, and tags for indexing. It never creates, modifies, or deletes any content on your Ghost site. Your API key is encrypted at rest and is only used server-side -- it is never exposed to the browser or included in any client-side code.
Vellumine works with any Ghost installation -- Ghost(Pro), self-hosted, or any third-party hosting provider. As long as your Ghost Admin API is accessible, Vellumine can connect to it.
Step 2: Initial Sync
After submitting the form, Vellumine will index all your posts, pages, authors, and tags. This usually takes a few seconds, depending on the size of your blog.
Step 3: Get Your Script Tag
Once the sync completes, you'll see a script tag that looks like this:
<script
src="https://app.vellumine.com/search.min.js"
id="vellumine"
data-collection-id="your-collection-id"
></script>
Copy this script tag -- you'll need it for the next step.