Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
node_modules
.build
build
.DS_Store
.env
npm-debug.log*
yarn-error.log
**/.docusaurus
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry=https://registry.npmmirror.com
157 changes: 76 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,76 @@
---
description: An overview to Lighthouse
---

# 👋 Introduction

<img src=".gitbook/assets/Screenshot 2023-10-21 at 9.41.08 AM.png" alt="" data-size="original">

***

### What is Lighthouse?

Lighthouse is a **permanent, decentralized storage protocol** powered by **Filecoin and IPFS**.\
It allows individuals, developers, and enterprises to store data **forever** with a simple, one-time payment model—eliminating recurring cloud costs while ensuring verifiable, tamper-proof security.

With Lighthouse, your files are stored across a decentralized network of Filecoin miners and can be accessed anytime through **dedicated IPFS gateways** optimized for speed, media delivery, and scalability.

***

### Why Lighthouse?

* **Perpetual Storage**\
Pay once and preserve your files permanently without renewals.
* **Decentralized Security**\
Your data is stored on IPFS + Filecoin, ensuring immutability and reliability.
* **Encryption & Access Control**\
Use **Kavach Threshold Encryption** and token-gating to keep data private and grant access via tokens, NFTs, passkeys, or zkTLS.
* **Dedicated IPFS Gateways**\
Fast retrieval for files, including **4K video streaming** at scale.
* **Decentralized Image Resizing**\
Optimize images on retrieval—save bandwidth without losing quality.
* **Flexible Payments**\
Choose annual or lifetime plans, pay with credit/debit cards or on-chain tokens.
* **No Vendor Lock-In**\
Retrieve and migrate data anytime with full user control.

***

### Tools for Developers

* **Lighthouse SDK** – Libraries, APIs, and docs to integrate decentralized storage into apps.
* **Lighthouse CLI** – Manage files directly from your terminal with simple commands.
* **Encryption SDK** – Easily secure and token-gate private files across chains and networks.

***

### Expanding the Data Economy

Lighthouse doesn’t just store data—it powers new ecosystems:

* **Data DAOs** – Create decentralized organizations to preserve, govern, and monetize data.
* **AI Data Monetization** – Store datasets, apply access control, and enable AI model training.
* **Private Processing** – Compute over private data while keeping it encrypted.
* **Cross-Ecosystem Support** – Built for AI, DePIN, NFTs, gaming, L1/L2 blockchains, and more.

***

### Backed by Trusted Partners

Lighthouse is already integrated into leading ecosystems like **SingularityNet, Cardano, and OKContract**, and is trusted for secure storage in the **NFT, modular blockchain, and AI data markets**.

***

### Why It Matters

Traditional cloud providers rent your data back to you. Lighthouse redefines storage with **permanent, affordable, and verifiable solutions**, enabling the next generation of apps, DAOs, and AI systems to thrive on **secure and censorship-resistant infrastructure**.

**With Lighthouse, your data doesn’t expire—it lives forever.**

***

### IPFS and Filecoin

While both IPFS (InterPlanetary File System) and Filecoin are pivotal technologies in decentralized storage, they serve distinct but complementary roles:

* **IPFS**: A peer-to-peer hypermedia protocol designed to store and share files in a distributed file system. It uses content-addressing to uniquely identify each file in a global namespace, making it efficient for retrieving cached data and sharing files.
* **Filecoin**: A decentralized storage network that incentivizes storage providers and clients to offer and use storage space. While IPFS handles the distribution and retrieval of files, Filecoin ensures that those files are stored reliably over time through economic incentives.

By leveraging IPFS with Filecoin underneath, Lighthouse leverages the strengths of both technologies: the efficient file retrieval, immutability of IPFS with the reliable, incentivized storage of Filecoin. This combination ensures low-cost, verifiable, and perpetual storage solutions.

***
# Lighthouse Docs (Docusaurus)

This repository now uses [Docusaurus](https://docusaurus.io/) to render the Lighthouse documentation.

## Getting started

1. Install dependencies:
```bash
npm install
```
2. Start a local dev server:
```bash
npm run start
```
The site will open at http://localhost:3000/ with hot reloading.
3. Build a production bundle:
```bash
npm run build
```
4. Preview the production build locally:
```bash
npm run serve
```

### Troubleshooting installs/builds

- If `npm install` fails with a 403 from the registry, ensure any corporate proxy variables are unset (`npm config delete proxy` and `npm config delete https-proxy`) and retry.
- Set an explicit registry if needed:
```bash
npm config set registry https://registry.npmjs.org
```
- Some environments block the default registry outright. You can also try the included `.npmrc` mirror (`https://registry.npmmirror.com`), but if the registry itself is blocked you will need network access to an allowed npm mirror before running `npm run build`.

## Deploying to Vercel

The repository already includes `vercel.json` with the correct defaults for Docusaurus. Use either the dashboard or the CLI:

### Deploy from the Vercel dashboard (recommended)

1. Create a new project and connect this Git repository.
2. In **Project Settings → General** set:
- **Framework Preset:** `Docusaurus` (or `Other` if unavailable)
- **Install Command:** `npm install`
- **Build Command:** `npm run build`
- **Output Directory:** `build`
3. Save the settings and trigger a new deployment. The site will be served from the URL shown in the Vercel dashboard and should match the `url` in `docusaurus.config.ts` (currently `https://lighthouse-docs.vercel.app`).

### Deploy from the Vercel CLI (alternative)

1. Install the Vercel CLI if needed:
```bash
npm install -g vercel
```
2. Log in and link the project (requires a Vercel account):
```bash
vercel login
vercel link
```
3. Deploy using the configuration in `vercel.json`:
```bash
vercel --prod
```
The CLI will build the site, upload the `build/` directory, and print the production URL.

## Project structure

- `docs/` contains all documentation content (migrated from GitBook).
- `static/` holds static assets such as images and the site favicon.
- `src/pages/` and `src/css/` contain the homepage and styling overrides.
- `docusaurus.config.ts` and `sidebars.ts` configure the Docusaurus site.

## Adding or updating docs

1. Create or edit Markdown files inside `docs/`.
2. Update `sidebars.ts` to add new pages to the navigation.
3. Run `npm run start` to verify the pages render correctly.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion filecoin-first/podsi.md → docs/filecoin-first/podsi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ hidden: true

**Proof of Data Segment Inclusion (PoDSI)** is like a certificate of authenticity. It assures that your file is safely tucked inside a special package, known as a "deal", made by the Lighthouse Node. This node combines several files, gives them a unique ID, offers proof of their inclusion, and even throws a mini-proof of the entire package's structure.

<figure><picture><source srcset="../.gitbook/assets/Group 1707478178.png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/Api de.png" alt=""></picture><figcaption></figcaption></figure>
<figure><picture><source srcset="/img/Group 1707478178.png" media="(prefers-color-scheme: dark)" /><img src="/img/Api de.png" alt="" /></picture><figcaption></figcaption></figure>

{% hint style="warning" %}
The time between uploading and being able to get your PoDSI varies from testnet from mainnet. Ideally it would be 6hr in testnet and 1 day in mainnet. You can get the PoDSI for your file by calling the `getProof` function in one of the following ways:
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Start an instance of the self-hosted RaaS by deploying a contract that inherits

The [RaaS Starter Kit](https://github.com/filecoin-project/raas-starter-kit) comes with a frontend that allows you to upload your file to Lighthouse, get a CID for the uploaded file, then seamlessly submit the CID to the smart contract (accessible via `yarn start`).

![RaaS Starter Kit Frontend](../.gitbook/assets/Frontend.png)
![RaaS Starter Kit Frontend](/img/Frontend.png)

If you're hosting your own RaaS service (specifically, the one in the [RaaS Starter Kit](https://github.com/filecoin-project/raas-starter-kit)), there's an event listener inside that you can use to listen for new deal requests.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions how-to/create-a-datacoin.md → docs/how-to/create-a-datacoin.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ In short: **DataCoins turn raw data into a tradable, liquid asset.**

### **Step 1: Connect Wallet**

<figure><img src="../.gitbook/assets/Screenshot_2025-09-26_at_8.56.13_AM.webp" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/Screenshot_2025-09-26_at_8.56.13_AM.webp" alt="" /><figcaption></figcaption></figure>

Connect wallet and click on create data coin.

***

### **Step 2: Enter Personal Information**

<figure><img src="../.gitbook/assets/Screenshot_2025-09-26_at_8.58.04_AM.webp" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/Screenshot_2025-09-26_at_8.58.04_AM.webp" alt="" /><figcaption></figcaption></figure>

Fill out the form with the following details:

Expand All @@ -40,7 +40,7 @@ The website link should point to your **DataDAO app**, which defines the logic f

### **Step 3: Add Social Information**

<figure><img src="../.gitbook/assets/Screenshot_2025-09-26_at_9.01.40_AM.webp" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/Screenshot_2025-09-26_at_9.01.40_AM.webp" alt="" /><figcaption></figcaption></figure>

Provide your social links such as **Telegram, Farcaster, X, GitHub, and LinkedIn**.

Expand All @@ -50,7 +50,7 @@ All fields are optional—you can fill in whichever ones you prefer.

### **Step 4: Configure Tokenomics** of your choice.

<figure><img src="../.gitbook/assets/Screenshot_2025-09-26_at_9.04.07_AM.webp" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/Screenshot_2025-09-26_at_9.04.07_AM.webp" alt="" /><figcaption></figcaption></figure>

Set up the economics of your data coin:

Expand All @@ -76,7 +76,7 @@ Once configured, click **Submit Data Coin**. Two transactions will follow:

### **Step 5: View and Manage Your Coin**

<figure><img src="../.gitbook/assets/Screenshot_2025-09-26_at_9.17.17_AM.webp" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/Screenshot_2025-09-26_at_9.17.17_AM.webp" alt="" /><figcaption></figcaption></figure>

After successful creation, you’ll be able to view your coin’s details.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Navigate to [Files Dapp](https://files.lighthouse.storage/) and either register

Click on the `migration` option in the left panel.

<figure><img src="../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/image (2).png" alt="" /><figcaption></figcaption></figure>

### Step 3: Create a New Migration

Expand All @@ -32,7 +32,7 @@ Select the `Create Migration` button to start the process.

Enter the CID (Content Identifier) for your content. Alternatively, if you have multiple CIDs, you can upload a CSV file with all the CIDs listed.

<figure><img src="../../.gitbook/assets/image (4).png" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/image (4).png" alt="" /><figcaption></figcaption></figure>

### Step 5: Execute Migration

Expand Down
4 changes: 2 additions & 2 deletions how-to/overview.md → docs/how-to/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following commands are available with the Lighthouse CLI tool

:frame\_photo:**CLI Commands**

<figure><img src="../.gitbook/assets/Screenshot 2023-10-20 195553.png" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/Screenshot 2023-10-20 195553.png" alt="" /><figcaption></figcaption></figure>

## Go SDK CLI Tool

Expand Down Expand Up @@ -159,4 +159,4 @@ Run the following command to see all available commands:
lhctl --help
```

<figure><img src="../.gitbook/assets/go-cli.png" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/go-cli.png" alt="" /><figcaption></figcaption></figure>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions docs/how-to/upload-data/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# 🔼 Upload Data

This section covers the steps to upload a file to Lighthouse. You can upload a file, buffer, or text/JSON payload.

1. [Upload File](file.md)
2. [Upload Text/JSON](text-json.md)
3. [Upload Buffer](buffer.md)

> Looking for Filecoin Virtual Machine workflows? Use the Filecoin Virtual Machine interface as shown below when you need on-chain execution alongside Lighthouse storage.

![Uploading via FVM](/img/Screenshot 2023-10-21 at 10.39.34 AM.png)

File renamed without changes.
83 changes: 83 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Introduction
description: An overview to Lighthouse
slug: /
---

# 👋 Introduction

<img src="/img/Screenshot 2023-10-21 at 9.41.08 AM.png" alt="" data-size="original">

***

### What is Lighthouse?

Lighthouse is a **permanent, decentralized storage protocol** powered by **Filecoin and IPFS**.\
It allows individuals, developers, and enterprises to store data **forever** with a simple, one-time payment model—eliminating recurring cloud costs while ensuring verifiable, tamper-proof security.

With Lighthouse, your files are stored across a decentralized network of Filecoin miners and can be accessed anytime through **dedicated IPFS gateways** optimized for speed, media delivery, and scalability.

***

### Why Lighthouse?

* **Perpetual Storage**\
Pay once and preserve your files permanently without renewals.
* **Decentralized Security**\
Your data is stored on IPFS + Filecoin, ensuring immutability and reliability.
* **Encryption & Access Control**\
Use **Kavach Threshold Encryption** and token-gating to keep data private and grant access via tokens, NFTs, passkeys, or zkTLS.
* **Dedicated IPFS Gateways**\
Fast retrieval for files, including **4K video streaming** at scale.
* **Decentralized Image Resizing**\
Optimize images on retrieval—save bandwidth without losing quality.
* **Flexible Payments**\
Choose annual or lifetime plans, pay with credit/debit cards or on-chain tokens.
* **No Vendor Lock-In**\
Retrieve and migrate data anytime with full user control.

***

### Tools for Developers

* **Lighthouse SDK** – Libraries, APIs, and docs to integrate decentralized storage into apps.
* **Lighthouse CLI** – Manage files directly from your terminal with simple commands.
* **Encryption SDK** – Easily secure and token-gate private files across chains and networks.

***

### Expanding the Data Economy

Lighthouse doesn’t just store data—it powers new ecosystems:

* **Data DAOs** – Create decentralized organizations to preserve, govern, and monetize data.
* **AI Data Monetization** – Store datasets, apply access control, and enable AI model training.
* **Private Processing** – Compute over private data while keeping it encrypted.
* **Cross-Ecosystem Support** – Built for AI, DePIN, NFTs, gaming, L1/L2 blockchains, and more.

***

### Backed by Trusted Partners

Lighthouse is already integrated into leading ecosystems like **SingularityNet, Cardano, and OKContract**, and is trusted for secure storage in the **NFT, modular blockchain, and AI data markets**.

***

### Why It Matters

Traditional cloud providers rent your data back to you. Lighthouse redefines storage with **permanent, affordable, and verifiable solutions**, enabling the next generation of apps, DAOs, and AI systems to thrive on **secure and censorship-resistant infrastructure**.

**With Lighthouse, your data doesn’t expire—it lives forever.**

***

### IPFS and Filecoin

While both IPFS (InterPlanetary File System) and Filecoin are pivotal technologies in decentralized storage, they serve distinct but complementary roles:

* **IPFS**: A peer-to-peer hypermedia protocol designed to store and share files in a distributed file system. It uses content-addressing to uniquely identify each file in a global namespace, making it efficient for retrieving cached data and sharing files.
* **Filecoin**: A decentralized storage network that incentivizes storage providers and clients to offer and use storage space. While IPFS handles the distribution and retrieval of files, Filecoin ensures that those files are stored reliably over time through economic incentives.

By leveraging IPFS with Filecoin underneath, Lighthouse leverages the strengths of both technologies: the efficient file retrieval, immutability of IPFS with the reliable, incentivized storage of Filecoin. This combination ensures low-cost, verifiable, and perpetual storage solutions.

***
File renamed without changes.
13 changes: 7 additions & 6 deletions quick-start.md → docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
title: Quick Start
icon: hammer
---

# Quick Start

In this section, we will see how to

1. [Create an API Key](quick-start.md#create-an-api-key)
2. [Upload a file](quick-start.md#upload-a-file)
3. [View the file](quick-start.md#view-file)
4. [Get Filecoin deals](quick-start.md#get-filecoin-deal)
5. [What's Next?](quick-start.md#id-5.-whats-next)
1. [Create an API Key](#create-an-api-key)
2. [Upload a file](#upload-a-file)
3. [View the file](#view-file)
4. [Get Filecoin deals](#get-filecoin-deal)
5. [What's Next?](#id-5.-whats-next)

This Quick Start guide walks you through the essentials: creating an API key, uploading a file, viewing it, and tracking its storage status. While the examples below use Node.js, you can easily adapt them for other environments using our How-To section

Expand All @@ -26,7 +27,7 @@ This Quick Start guide walks you through the essentials: creating an API key, up
You can also generate the API key from CLI
{% endhint %}

<figure><img src=".gitbook/assets/api key.png" alt=""><figcaption></figcaption></figure>
<figure><img src="/img/api key.png" alt="" /><figcaption></figcaption></figure>

### 2. Upload a File

Expand Down
File renamed without changes.
Loading