IPFS-Deploy 使用教程

IPFS-Deploy 使用教程

ipfs-deploy Zero-Config CLI to Deploy Static Websites to IPFS 项目地址: https://gitcode.com/gh_mirrors/ip/ipfs-deploy

1. 项目介绍

IPFS-Deploy 是一个零配置的命令行工具，用于将静态网站部署到 IPFS（InterPlanetary File System，星际文件系统）上，并且可以选择性地更新 DNS。它的目标是尽可能简化部署静态网站到 IPFS 的过程。

2. 项目快速启动

首先，确保你的系统中已经安装了 Node.js。然后，使用以下命令全局安装 IPFS-Deploy：

npm install -g ipfs-deploy

安装完成后，你可以使用 ipd 或 ipfs-deploy 命令来调用它。以下是一个简单的使用示例：

# 将当前目录（假设是静态网站的目录）部署到 IPFS
ipfs-deploy .

这个命令会自动将你的静态网站上传到一个公共的 pinning 服务，并返回一个 IPFS 链接，你可以在 ipfs.io/ipfs/QmHash 上查看部署结果。

3. 应用案例和最佳实践

部署静态网站

将你的静态网站文件放在一个目录中，然后使用 IPFS-Deploy 进行部署。例如，如果你的网站文件位于 public/ 目录，你可以运行以下命令：

ipfs-deploy public/

更新 DNS

如果你想将你的域名指向部署在 IPFS 上的网站，你可以使用 IPFS-Deploy 的 DNS 更新功能。确保你有一个 DNS 服务的 API 密钥，然后按照以下步骤操作：

1. 在命令中包含 --dns 参数以及你的 DNS 提供商和 API 密钥。
2. 运行命令，IPFS-Deploy 会自动更新 DNS 记录。

持续集成

你可以在持续集成（CI）流程中集成 IPFS-Deploy，确保每次代码提交后都会自动部署网站。

4. 典型生态项目

以下是一些使用 IPFS-Deploy 部署的网站案例：

• agentofuser.com
• jaack.me
• kevincox.ca
• xkcd.hacdias.com

如果你使用 IPFS-Deploy 部署了你的网站，欢迎通过 pull request 向我们提供反馈，以便我们添加到上述列表中。

ipfs-deploy Zero-Config CLI to Deploy Static Websites to IPFS 项目地址: https://gitcode.com/gh_mirrors/ip/ipfs-deploy