Skip to content

Commit

Permalink
#126 simplified installation for Windows.
Browse files Browse the repository at this point in the history
  • Loading branch information
laurent-martin committed Oct 20, 2023
1 parent 5dbff49 commit 74d43bb
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 24 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,10 +508,10 @@ It is essentially the same procedure, but instead of retrieving files from inter
- Create an archive with necessary gems: <https://help.rubygems.org/kb/rubygems/installing-gems-with-no-network>

```bat
gem install aspera-cli -N -i repo
gem install aspera-cli -N -i my_gems
```

Zip the files `*.gem` from folder `repo/cache`
Zip the files `*.gem` from folder `repo/my_gems`

- Download the SDK from: <https://ibm.biz/aspera_sdk>

Expand All @@ -529,15 +529,17 @@ rubyinstaller-devkit-3.2.2-1-x64.exe /silent /currentuser /noicons /dir=C:\asper
- Install the gems:

```bat
install --force --local *.gem
gem install --force --local *.gem
```

- install the SDK

```bash
ascli conf ascp install --sdk-url=file:///SDK.zip
ascli conf ascp install --sdk-url=file:///sdk.zip
```

> **Note:** An example of installation script is provided: [docs/install.bat](docs/install.bat)
#### macOS: pre-installed or `brew`

macOS 10.13+ (High Sierra) comes with a recent Ruby.
Expand Down Expand Up @@ -677,11 +679,11 @@ ascli conf ascp install
If a local SDK installation is preferred instead of fetching from internet: one can specify the location of the SDK file:

```bash
curl -Lso SDK.zip https://ibm.biz/aspera_sdk
curl -Lso sdk.zip https://ibm.biz/aspera_sdk
```

```bash
ascli conf ascp install --sdk-url=file:///SDK.zip
ascli conf ascp install --sdk-url=file:///sdk.zip
```

The format is: `file:///<path>`, where `<path>` can be either a relative path (not starting with `/`), or an absolute path.
Expand Down Expand Up @@ -726,7 +728,7 @@ ascli conf --show-config --fields=sdk_url
- Download the SDK archive from that URL.

```bash
curl -Lso SDK.zip https://ibm.biz/aspera_sdk
curl -Lso sdk.zip https://ibm.biz/aspera_sdk
```

- Transfer those 2 files to the target system
Expand All @@ -740,7 +742,7 @@ tar zxvf rvm-ascli.tgz

source ~/.rvm/scripts/rvm

ascli conf ascp install --sdk-url=file:///SDK.zip
ascli conf ascp install --sdk-url=file:///sdk.zip
```

- Add those lines to shell init (`.profile`)
Expand Down
20 changes: 12 additions & 8 deletions docs/Manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -514,9 +514,9 @@ <h3 data-number="3.2.3" id="windows-installer"><span
href="https://help.rubygems.org/kb/rubygems/installing-gems-with-no-network"
class="uri">https://help.rubygems.org/kb/rubygems/installing-gems-with-no-network</a></p>
<div class="sourceCode" id="cb43"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb43-1"><a href="#cb43-1" aria-hidden="true" tabindex="-1"></a>gem install aspera<span class="at">-cli</span> <span class="at">-N</span> <span class="at">-i</span> repo</span></code></pre></div>
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb43-1"><a href="#cb43-1" aria-hidden="true" tabindex="-1"></a>gem install aspera<span class="at">-cli</span> <span class="at">-N</span> <span class="at">-i</span> my_gems</span></code></pre></div>
<p>Zip the files <code>*.gem</code> from folder
<code>repo/cache</code></p></li>
<code>repo/my_gems</code></p></li>
<li><p>Download the SDK from: <a href="https://ibm.biz/aspera_sdk"
class="uri">https://ibm.biz/aspera_sdk</a></p></li>
</ul>
Expand All @@ -533,12 +533,16 @@ <h3 data-number="3.2.3" id="windows-installer"><span
<li>Install the gems:</li>
</ul>
<div class="sourceCode" id="cb45"><pre
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb45-1"><a href="#cb45-1" aria-hidden="true" tabindex="-1"></a>install -<span class="at">-force</span> -<span class="at">-local</span> *.gem</span></code></pre></div>
class="sourceCode bat"><code class="sourceCode dosbat"><span id="cb45-1"><a href="#cb45-1" aria-hidden="true" tabindex="-1"></a>gem install -<span class="at">-force</span> -<span class="at">-local</span> *.gem</span></code></pre></div>
<ul>
<li>install the SDK</li>
</ul>
<div class="sourceCode" id="cb46"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb46-1"><a href="#cb46-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ascli</span> conf ascp install <span class="at">--sdk-url</span><span class="op">=</span>file:///SDK.zip</span></code></pre></div>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb46-1"><a href="#cb46-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ascli</span> conf ascp install <span class="at">--sdk-url</span><span class="op">=</span>file:///sdk.zip</span></code></pre></div>
<blockquote>
<p><strong>Note:</strong> An example of installation script is provided:
<a href="docs/install.bat">docs/install.bat</a></p>
</blockquote>
<h3 data-number="3.2.4" id="macos-pre-installed-or-brew"><span
class="header-section-number">3.2.4</span> macOS: pre-installed or
<code>brew</code></h3>
Expand Down Expand Up @@ -654,9 +658,9 @@ <h2 data-number="3.4" id="fasp-protocol"><span
<p>If a local SDK installation is preferred instead of fetching from
internet: one can specify the location of the SDK file:</p>
<div class="sourceCode" id="cb61"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb61-1"><a href="#cb61-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-Lso</span> SDK.zip https://ibm.biz/aspera_sdk</span></code></pre></div>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb61-1"><a href="#cb61-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-Lso</span> sdk.zip https://ibm.biz/aspera_sdk</span></code></pre></div>
<div class="sourceCode" id="cb62"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb62-1"><a href="#cb62-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ascli</span> conf ascp install <span class="at">--sdk-url</span><span class="op">=</span>file:///SDK.zip</span></code></pre></div>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb62-1"><a href="#cb62-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ascli</span> conf ascp install <span class="at">--sdk-url</span><span class="op">=</span>file:///sdk.zip</span></code></pre></div>
<p>The format is: <code>file:///&lt;path&gt;</code>, where
<code>&lt;path&gt;</code> can be either a relative path (not starting
with <code>/</code>), or an absolute path.</p>
Expand Down Expand Up @@ -703,7 +707,7 @@ <h2 data-number="3.5" id="installation-in-air-gapped-environment"><span
<li>Download the SDK archive from that URL.</li>
</ul>
<div class="sourceCode" id="cb65"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb65-1"><a href="#cb65-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-Lso</span> SDK.zip https://ibm.biz/aspera_sdk</span></code></pre></div>
class="sourceCode bash"><code class="sourceCode bash"><span id="cb65-1"><a href="#cb65-1" aria-hidden="true" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-Lso</span> sdk.zip https://ibm.biz/aspera_sdk</span></code></pre></div>
<ul>
<li><p>Transfer those 2 files to the target system</p></li>
<li><p>On target system</p></li>
Expand All @@ -715,7 +719,7 @@ <h2 data-number="3.5" id="installation-in-air-gapped-environment"><span
<span id="cb66-4"><a href="#cb66-4" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb66-5"><a href="#cb66-5" aria-hidden="true" tabindex="-1"></a><span class="bu">source</span> ~/.rvm/scripts/rvm</span>
<span id="cb66-6"><a href="#cb66-6" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb66-7"><a href="#cb66-7" aria-hidden="true" tabindex="-1"></a><span class="ex">ascli</span> conf ascp install <span class="at">--sdk-url</span><span class="op">=</span>file:///SDK.zip</span></code></pre></div>
<span id="cb66-7"><a href="#cb66-7" aria-hidden="true" tabindex="-1"></a><span class="ex">ascli</span> conf ascp install <span class="at">--sdk-url</span><span class="op">=</span>file:///sdk.zip</span></code></pre></div>
<ul>
<li>Add those lines to shell init (<code>.profile</code>)</li>
</ul>
Expand Down
Binary file modified docs/Manual.pdf
Binary file not shown.
18 changes: 10 additions & 8 deletions docs/README.erb.md
Original file line number Diff line number Diff line change
Expand Up @@ -502,10 +502,10 @@ It is essentially the same procedure, but instead of retrieving files from inter
- Create an archive with necessary gems: <https://help.rubygems.org/kb/rubygems/installing-gems-with-no-network>

```bat
gem install aspera-cli -N -i repo
gem install aspera-cli -N -i my_gems
```

Zip the files `*.gem` from folder `repo/cache`
Zip the files `*.gem` from folder `repo/my_gems`

- Download the SDK from: <https://ibm.biz/aspera_sdk>

Expand All @@ -523,15 +523,17 @@ rubyinstaller-devkit-3.2.2-1-x64.exe /silent /currentuser /noicons /dir=C:\asper
- Install the gems:

```bat
install --force --local *.gem
gem install --force --local *.gem
```

- install the SDK

```bash
<%=cmd%> conf ascp install --sdk-url=file:///SDK.zip
<%=cmd%> conf ascp install --sdk-url=file:///sdk.zip
```

> **Note:** An example of installation script is provided: [docs/install.bat](docs/install.bat)
#### macOS: pre-installed or `brew`

macOS 10.13+ (High Sierra) comes with a recent Ruby.
Expand Down Expand Up @@ -671,11 +673,11 @@ This can be installed either be installing an Aspera transfer software, or using
If a local SDK installation is preferred instead of fetching from internet: one can specify the location of the SDK file:

```bash
curl -Lso SDK.zip https://ibm.biz/aspera_sdk
curl -Lso sdk.zip https://ibm.biz/aspera_sdk
```

```bash
<%=cmd%> conf ascp install --sdk-url=file:///SDK.zip
<%=cmd%> conf ascp install --sdk-url=file:///sdk.zip
```

The format is: `file:///<path>`, where `<path>` can be either a relative path (not starting with `/`), or an absolute path.
Expand Down Expand Up @@ -720,7 +722,7 @@ cd $HOME && tar zcvf rvm-<%=cmd%>.tgz .rvm
- Download the SDK archive from that URL.

```bash
curl -Lso SDK.zip https://ibm.biz/aspera_sdk
curl -Lso sdk.zip https://ibm.biz/aspera_sdk
```

- Transfer those 2 files to the target system
Expand All @@ -734,7 +736,7 @@ tar zxvf rvm-<%=cmd%>.tgz

source ~/.rvm/scripts/rvm

<%=cmd%> conf ascp install --sdk-url=file:///SDK.zip
<%=cmd%> conf ascp install --sdk-url=file:///sdk.zip
```

- Add those lines to shell init (`.profile`)
Expand Down
19 changes: 19 additions & 0 deletions docs/Readme.win.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Aspera CLI installation on Windows

Edit the installation script: `install.bat` to change the target installation folder if required.

Then execute it:

```bat
CD aspera-cli-installer
install.bat
```

It will install all the necessary components:

- Ruby
- Gems
- MS C++ libs
- ascp

Then add the path to bin to your PATH to find ascli.
14 changes: 14 additions & 0 deletions docs/install.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@echo off
echo Aspera CLI Installer script for Windows
rem This is the installation folder
SET TARGET_FOLDER=%USERPROFILE%\aspera-cli
echo Installing Aspera CLI in %TARGET_FOLDER%
rubyinstaller-devkit-3.2.2-1-x64.exe /silent /currentuser /noicons /dir=%TARGET_FOLDER%
echo Installing CLI gems
call %TARGET_FOLDER%\bin\gem install --no-document --silent --force --local cli-gems\*.gem
echo Installing MS redis libs
vc_redist.x64.exe /install /passive
echo Installing Aspera SDK
call %TARGET_FOLDER%\bin\ascli conf ascp install --sdk-url=file:///sdk.zip
echo Aspera Cli is installed at: %TARGET_FOLDER%\bin
echo SET PATH=%%PATH%%;C:\Users\Administrator\aspera-cli\bin

0 comments on commit 74d43bb

Please sign in to comment.