feat: Prevent Infura timeouts when only pinner

Was pinning locally then sending Infura the hash for pinning like with
Pinata, but that doesn't work because Infura doesn't take a host_nodes
field to speed up finding the local peer with the data so it ends up
timing out.

Now we just send via HTTPS directly, no need for local daemon or port
forwarding (unless also deploying to Pinata).

Also:

- Add --port option for IPFS daemon used to pin to Pinata

- Check if daemon port is externally reachable (js-ipfs doesn't do port
  forwarding yet)

- Remove ipv6 stuff that is unsupported by Pinata

- Improve status output

Author: agentofuser

README.md

@@ -10,59 +10,22 @@
   </a>
 </p>
 
-## 🚨 WARNING: This is alpha software and very much in "works for me" status. APIs and CLI options will change. Use with caution, but please use it, give feedback, and consider contributing :) If it works for you too, [please let me know on this issue](https://github.com/agentofuser/ipfs-deploy/issues/1 'feedback').
+## 🚨 WARNING: This is beta software and very much in "works for me" status. APIs and CLI options will change. Use with caution, but please use it, give feedback, and consider contributing :) If it works for you too, [please let me know on this issue](https://github.com/agentofuser/ipfs-deploy/issues/1 'feedback').
 
 The goal of `@agentofuser/ipfs-deploy` is to make it as easy as possible to
-deploy a static website to IPFS.
+**deploy a static website to IPFS.**
 
 ## Table of Contents
 
-- [Security](#security)
-- [Background](#background)
 - [Install](#install)
 - [Usage](#usage)
 - [API](#api)
+- [Security](#security)
+- [Background](#background)
 - [Contributing](#contributing)
 - [Who's Using](#users)
 - [License](#license)
 
-## Security
-
-We use `dotenv` to handle credentials. Don't commit your `.env` file to source
-control.
-
-## Background
-
-You can start using `ipfs-deploy` without signing up for anything.
-
-Default settings deploy to [infura.io](https://infura.io), which doesn't
-request an account to pin our stuff. They probably do some rate-limiting, but
-either way, take it easy on them. Being able to try things out without friction
-and without giving out personal info is a very important smooth on-ramp.
-
-So far, `ipfs-deploy` integrates with these services:
-
-- [Infura.io](https://infura.io): freemium pinning service. Doesn't require
-  signup.
-- [Pinata.cloud](https://pinata.cloud): freemium pinning service. Gives more
-  control over what's uploaded. You can delete, label, and add metadata.
-- [Cloudflare DNS](https://cloudflare.com): freemium DNS API. Supports CNAME
-  for naked domains and integrates with their IPFS gateway at
-  [cloudflare-ipfs.com](https://cloudflare-ipfs.com).
-
-Feel free to request or add support to other services.
-
-Cloudflare IPFS doesn't host the content itself (it's a cached gateway), so a
-stable pinning service is needed if you don't want to rely on your computer's
-IPFS daemon's availability to serve your website.
-
-These are free services subject to their terms. Not a decentralization nirvana
-by any stretch of the imagination, but a nice way to get started quickly with a
-blog, static website, or frontend web app.
-
-If you use this package to deploy your website, send a pull request so I can
-add it to the README. (I reserve the right to exercise discretion.)
-
 ## Install
 
 ### As a library:
@@ -97,12 +60,37 @@ Just remember to have the credentials properly set up as instructed below.
 
 ## Usage
 
-### As an executable:
+You can get started just by typing out **ipd** and it will have smart defaults.
+
+It deploys to a service that doesn't need signup and gives you a link like
+`ipfs.io/ipfs/hash` that you can use to see if everything went ok.
+
+When you don't specify a path argument to deploy, **ipfs-deploy** tries to
+guess it for you based on the build directories used by the most popular static
+site generators:
+
+```javascript
+const guesses = [
+  '_site', // jekyll, hakyll
+  'site',
+  'public', // gatsby, hugo
+  'dist', // nuxt
+  'output', // pelican
+  'out', // hexo
+  'build', // metalsmith, middleman
+  'website/build', // docusaurus
+  'docs',
+]
+```
+
+---
+
+The `--help` option has some additional usage examples:
 
 ```
 Examples:
   ipfs-deploy                               # Deploys relative path "public" to
-                                            ipfs.infura.io/ipfs/<hash>; doesn't
+                                            ipfs.infura.io/ipfs/hash; doesn't
                                             update DNS; copies and opens URL.
                                             These defaults are chosen so as not
                                             to require signing up for any
@@ -117,16 +105,17 @@ Examples:
                                             DNS
 ```
 
-I won't go over how to set up Pinata and Cloudflare right now, but you can read
-up on that over at:
+To use Pinata and Cloudflare you need to sign up for those services. You can
+read up on that over at:
 
 https://www.cloudflare.com/distributed-web-gateway
 
 and:
 
 https://pinata.cloud/documentation#GettingStarted
 
-(Infura doesn't require creating an account.)
+(Infura doesn't require creating an account and is therefore the default
+pinning service used.)
 
 After setting up your Cloudflare and Pinata accounts, in your website's
 repository root, create or edit the file `.env` with your domain and
@@ -178,13 +167,13 @@ Then to run it, execute:
 npm run deploy
 ```
 
-### As a library:
+## API
 
 This is still pretty unstable and subject to change, so I will just show how
 the executable currently uses the API.
 
 ```javascript
-const deploy = require('ipfs-deploy')
+const deploy = require('@agentofuser/ipfs-deploy')
 
 ;(async () => {
   try {
@@ -212,6 +201,43 @@ const deploy = require('ipfs-deploy')
 })()
 ```
 
+## Security
+
+We use `dotenv` to handle credentials. Don't commit your `.env` file to source
+control.
+
+## Background
+
+So far, `ipfs-deploy` integrates with these services:
+
+- [Infura.io](https://infura.io): freemium pinning service. Doesn't require
+  signup. (Default.)
+- [Pinata.cloud](https://pinata.cloud): freemium pinning service. Gives more
+  control over what's uploaded. You can delete, label, and add metadata.
+- [Cloudflare DNS](https://cloudflare.com): freemium DNS API. Supports CNAME
+  for naked domains and integrates with their IPFS gateway at
+  [cloudflare-ipfs.com](https://cloudflare-ipfs.com).
+
+Feel free to request or add support to other services and send a PR.
+
+You can start using `ipfs-deploy` without signing up for anything.
+
+Default settings deploy to [infura.io](https://infura.io), which doesn't
+request an account to pin stuff. They probably do some rate-limiting, but
+either way, take it easy on them. Being able to try IPFS out without friction
+and without giving out personal info is a very important smooth on-ramp.
+
+Cloudflare IPFS doesn't host the content itself (it's a cached gateway), so a
+stable pinning service is needed if you don't want to rely on your computer's
+IPFS daemon's availability to serve your website.
+
+These are free services subject to their terms. Not a decentralization nirvana
+by any stretch of the imagination, but a nice way to get started quickly with a
+blog, static website, or frontend web app.
+
+If you use this package to deploy your website, please send a pull request so I
+can add it to the README. (I reserve the right to exercise discretion.)
+
 ## Contributing
 
 PRs accepted. Please open an issue first so we can talk about it.

bin/ipfs-deploy.js

@@ -6,7 +6,7 @@ const deploy = require('../index')
 
 require('dotenv').config()
 
-const argv = yargs
+const parser = yargs
   .scriptName('ipfs-deploy')
   .usage(
     '$0 [options] [path]',
@@ -42,6 +42,12 @@ const argv = yargs
               'path'
             )} will be uploaded`,
           },
+          port: {
+            default: '4002',
+            describe:
+              'Externally reachable port for pinners to connect to ' +
+              'local IPFS node',
+          },
         })
         .example(
           '$0',
@@ -67,18 +73,28 @@ const argv = yargs
         )
     }
   )
-  .epilogue(
-    'For help or more information, ping me on Twitter ' +
-      'at https://twitter.com/agentofuser'
-  )
   .help()
-  .alias('h', 'help').argv
+  .alias('h', 'help')
 
 async function main() {
+  const processArgv = process.argv.slice(1)
+  const yargsParse = new Promise((resolve, reject) => {
+    parser.parse(processArgv, (err, argv, output) => {
+      if (err) {
+        reject(err)
+      } else {
+        resolve({ argv, output })
+      }
+    })
+  })
+
+  const { argv, output } = await yargsParse
+
   const deployOptions = {
     publicDirPath: argv.path,
     copyPublicGatewayUrlToClipboard: !argv.noClipboard,
     open: !argv.O,
+    port: argv.port,
     remotePinners: argv.p,
     dnsProviders: argv.d,
     siteDomain: argv.siteDomain,
@@ -94,7 +110,19 @@ async function main() {
     },
   }
 
-  await deploy(deployOptions)
+  process.stdout.write(output)
+
+  if (argv.h) {
+    // Had to do this because couldn't get yargs#epilogue() to work
+    process.stdout.write(`
+  For help or more information, ping me at
+  https://twitter.com/${chalk.whiteBright('agentofuser')}
+    `)
+  } else {
+    await deploy(deployOptions)
+  }
 }
 
-main()
+;(async () => {
+  await main()
+})()