https://github.com/ipfs-shipyard/ipfs-deploy

Zero-Config CLI to Deploy Static Websites to IPFS
https://github.com/ipfs-shipyard/ipfs-deploy

cli deploying dnslink ipfs need-maintainer pinning service storage

Last synced: 2 days ago
JSON representation

Zero-Config CLI to Deploy Static Websites to IPFS

• Host: GitHub
• URL: https://github.com/ipfs-shipyard/ipfs-deploy
• Owner: ipfs-shipyard
• License: other
• Created: 2019-02-13T02:44:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-31T16:01:55.000Z (9 months ago)
• Last Synced: 2024-10-29T14:19:02.210Z (5 days ago)
• Topics: cli, deploying, dnslink, ipfs, need-maintainer, pinning, service, storage
• Language: JavaScript
• Homepage:
• Size: 1.04 MB
• Stars: 1,160
• Watchers: 26
• Forks: 123
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-cli-apps - ipfs-deploy - Deploy static websites to [IPFS](https://github.com/ipfs/ipfs#overviewhttps://github.com/ipfs/ipfs#overview). (Development / Devops)

README

        
# ipfs-deploy

[![standard-readme

compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)

[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)

[![](https://img.shields.io/github/workflow/status/ipfs-shipyard/ipfs-deploy/Node.js%20CI/master?style=flat-square)](https://github.com/ipfs-shipyard/ipfs-deploy/actions/workflows/ci.yaml)

> Upload static websites to IPFS pinning services and optionally update the DNS.



  



The goal of `ipfs-deploy` is to make it as easy as possible to **deploy a static

website to IPFS.**

- [Maintainer](#maintainer)

- [Install](#install)

- [Usage](#usage)

- [API](#api)

- [Contributing](#contributing)

- [Users](#users)

- [License](#license)

## Maintainer 

This package is community-maintaned. Current go-to maintainer is [@websoftwares](https://github.com/websoftwares).

## Install

```bash

npm install -g ipfs-deploy

```

You can call it either as `ipd` or as `ipfs-deploy`:

```bash

ipd public/

ipfs-deploy public/

```

You can run it directly with [npx](https://www.npmjs.com/package/npx 'npx') so

you don't need to install it:

```bash

npx ipfs-deploy _site

```

It will deploy to a public pinning service and give you a link to

`ipfs.io/ipfs/QmHash` so you can check it out.

## Usage

Please check [md/usage.md](md/usage.md) for further information!

## API

> There is an API so, however it is somewhat unstable and subject to change.

Please check [md/api.md](md/api.md) for further information!

## Contributing

Please check [md/contributing.md](md/contributing.md) for further information!

## Users

- [agentofuser.com](https://agentofuser.com)

- [jaack.me](https://ipfs.jaack.me)

- [kevincox.ca](https://kevincox.ca)

- [xkcd.hacdias.com](https://xkcd.hacdias.com)

- _Your website here_

If you use this package to deploy your website, please send a pull request so I

can add it to the [Users](#users) section in the README. (I reserve the right to

exercise discretion.)

## License

[BlueOak-1.0.0 OR BSD-2-Clause-Patent OR MIT © Agent of User](./LICENSE.md)

(The first two are the most permissive possible ever, more than MIT, which

doesn't have a patent waiver. Use whichever satisfies your lawyer better.)