aspera connect sdk js

JavaScript 用の公式 Aspera Connect SDK

Web アプリケーションが Aspera ファイル転送機能を利用できるようにします。

ドキュメントについては GitHub ページを確認してください。

インストール

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 は重大な変更を伴って随時変更される可能性があり、Web サイトに影響を与える可能性があります。

使用法

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

上記のコマンドを使用すると、Connect インストーラーはhttp://127.0.0.1:8080/aspera/connect経由で利用可能になります。この URL から Connect インストーラーを提供するように Connect SDK を構成するには、 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 サポートにアクセスしてください。