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 支援。