IPFS Companion 安装与使用教程

IPFS Companion 安装与使用教程

ipfs-companion项目地址:https://gitcode.com/gh_mirrors/ipf/ipfs-companion

1. 项目介绍

IPFS Companion 是一个浏览器扩展，旨在简化对 IPFS（InterPlanetary File System）资源的访问。它允许用户直接在浏览器中使用 ipfs:// 和 ipns:// 地址，自动加载 IPFS 网关上的网站和文件路径。IPFS Companion 支持与本地运行的 IPFS 节点（通过 IPFS Desktop 应用或命令行守护进程）直接集成，提供了强大的功能和便捷的用户体验。

2. 项目快速启动

2.1 安装依赖

首先，确保你已经安装了 Node.js 和 npm。然后，克隆项目仓库并安装依赖：

git clone https://github.com/ipfs-shipyard/ipfs-companion.git
cd ipfs-companion
npm install

2.2 构建和启动

IPFS Companion 支持在多个浏览器中运行。以下是构建和启动的命令：

2.2.1 在 Chromium 浏览器中启动

npm run dev-build chromium

2.2.2 在 Firefox 浏览器中启动

npm run dev-build firefox

2.3 安装扩展

构建完成后，你可以在浏览器的扩展管理页面加载已解压的扩展。具体步骤如下：

1. 打开浏览器的扩展管理页面（通常在 chrome://extensions/ 或 about:addons）。
2. 启用“开发者模式”。
3. 点击“加载已解压的扩展”，选择 ipfs-companion/build 目录。

3. 应用案例和最佳实践

3.1 案例一：使用 IPFS 托管静态网站

通过 IPFS Companion，你可以轻松地将静态网站托管在 IPFS 上，并使用 ipfs:// 地址访问。例如，你可以将网站的 HTML、CSS 和 JavaScript 文件上传到 IPFS，然后在浏览器中直接访问这些文件。

3.2 案例二：跨设备共享文件

IPFS Companion 允许你在多个设备之间共享文件，而无需依赖传统的中心化服务。你可以在一台设备上上传文件到 IPFS，然后在另一台设备上通过 IPFS Companion 访问这些文件。

3.3 最佳实践

• 优化资源使用：如果你发现 IPFS Companion 占用过多 CPU 资源，可以考虑使用更高效的替代方案，如 DScan。
• 管理存储：合理管理 IPFS 节点上的存储，避免不必要的文件占用空间。

4. 典型生态项目

4.1 IPFS Desktop

IPFS Desktop 是一个图形化界面的 IPFS 节点管理工具，它与 IPFS Companion 紧密集成，提供了便捷的节点管理和文件上传功能。

4.2 IPFS Cluster

IPFS Cluster 是一个分布式系统，用于管理多个 IPFS 节点上的文件复制和分发。它可以帮助你更好地管理和分发大型文件。

4.3 IPFS Gateway

IPFS Gateway 是一个公共网关，允许用户通过 HTTP 访问 IPFS 上的内容。IPFS Companion 可以自动将 ipfs:// 地址重定向到这些网关，方便用户访问。

通过以上步骤，你可以快速上手并充分利用 IPFS Companion 的功能，享受去中心化网络带来的便利。

ipfs-companion项目地址:https://gitcode.com/gh_mirrors/ipf/ipfs-companion