aspera connect sdk js

适用于 JavaScript 的官方 Aspera Connect SDK

使 Web 应用程序能够利用 Aspera 文件传输功能。

查看 GitHub Pages 获取文档。

安装

从 npm 安装：

$ npm install --save @ibm-aspera/connect-sdk-js

从源安装：

$ git clone https://github.com/IBM/aspera-connect-sdk-js.git
$ cd aspera-connect-sdk-js
$ npm install

从 CDN 加载：

 < script src =" https://d3gcli72yxqn2z.cloudfront.net/@ibm-aspera/connect-sdk-js/latest/connect-sdk.js " > </ script >

如果您通过 CDN 嵌入 Connect SDK，强烈建议您使用特定版本而不是最新版本。最新的 Connect SDK 可能随时发生重大更改，这可能会影响您的网站。

用法

启动并建立与 Connect 桌面应用程序的连接：

 import { Connect } from '@ibm-aspera/connect-sdk-js' ;

const connectClient = new Connect ( ) ;
connectClient . initSession ( ) ;

开始下载：

 try {
  const transferSpec = {
    authentication : 'token' ,
    paths : [
      {
        source : 'my_awesome_movie.drp'
      }
    ] ,
    remote_host : 'example.com' ,
    remote_user : 'foo' ,
    token : 'ATV7_HtfhDa-JwWfc6RkTwhkDUqjHeLQePiOHjIS254_LJ14_7VTA' ,
    direction : 'receive'
  } ;

  const response = await connectClient . startTransferPromise ( transferSpec ) ;
  console . log ( `Transfer started: ${ response } ` ) ;
} catch ( err ) {
  throw new Error ( `Could not start transfer: ${ err } ` ) ;
}

查看提供的示例以获取更多代码示例。

从 3.x/4.x 迁移到 5.0.0

请参阅迁移以查看将代码更新到v5.0.0时所需的更改。

发展

先决条件

• Node.js v12+
  • 如果您使用的是 macOS，我们建议通过 nvm 等包管理器安装 Node.js。
• git

建造

$ git clone https://github.com/IBM/aspera-connect-sdk-js.git
$ cd aspera-connect-sdk-js
$ npm install
$ npm run build

本地托管 Connect 桌面安装程序

用户可以在本地托管安装程序，而不是让用户从 Cloudfront 下载 Connect。如果您的服务器在离线环境中运行（即用户无法访问 Cloudfront）或者您只是希望用户从您的服务器下载 Connect，则此功能特别有用。

下载connect-deployer Docker 镜像：

$ docker pull icr.io/ibmaspera/connect-deployer:latest

从 Connect 4.2.2 开始，版本标签也可用（例如： docker pull icr.io/ibmaspera/connect-deployer:4.2.2 ）。

要在基本 Web 服务器上托管安装程序：

$ docker run -it --rm -d -p 8080:80 icr.io/ibmaspera/connect-deployer:latest

使用上述命令，可以通过http://127.0.0.1:8080/aspera/connect获取 Connect 安装程序。要将 Connect SDK 配置为从此 URL 为 Connect 安装程序提供服务，您必须将sdkLocation更新为上述 URL。

要通过安全的 Web 服务器托管安装程序：

$ docker run -it --rm -d -p 8443:443  -v /path/to/your/ssl/certs:/etc/ssl/certs icr.io/ibmaspera/connect-deployer:latest

注意：服务器证书和私钥必须分别命名为cert.pem和key.pem 。

贡献

我们一直在寻找贡献者来帮助我们修复错误、构建新功能或帮助我们改进项目文档。如果您有兴趣，请务必查看我们的贡献指南。

故障排除

在浏览器的开发者控制台中运行AW4.Logger.setLevel(2)以启用跟踪日志记录。

有关 Connect 桌面应用程序的帮助，请访问 IBM 支持。