-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
262 additions
and
332 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,23 @@ | ||
--- | ||
path: "/docs" | ||
title: "Downloading and installing" | ||
title: "Installing options" | ||
--- | ||
|
||
There are a few options available for downloading and installing Galasa. Prerequisites vary, depending on the options that are chosen. | ||
There are a few options available when installing Galasa. Prerequisites vary, depending on the option that is chosen. | ||
|
||
You can install Galasa for using in the command-line, for using Eclipse, or for sharing with your department (using the Galasa zipped distribution). | ||
|
||
## Download and Install options | ||
There are benefits of installing Galasa for using in the command-line. Much of the configuration set-up that is required is done for you automatically by scripts, so less manual intervention is needed. You can then import the configuration into an IDE of your choice, rather than having to use Eclipse. | ||
|
||
You can download Galasa as a binary of the Galasa CLI tool from the GitHub `cli` repository, or as an Eclipse plug-in, which can be downloaded either directly from an external update site, or as a zip file (zipped distribution). | ||
If you are using only Eclipse for your IDE, do not have restricted internet access and want to use open-source Galasa you might choose to install the Galasa Eclipse plug-in directly from the external update site for using in Eclipse. | ||
|
||
The Galasa binary that is stored in the `cli` repository is installed by using the Galasa command line (Galasa CLI). The benefit of using the command-line to install Galasa is that much of the configuration set-up that is required is done for you automatically by scripts, so there is less manual intervention needed. You can then import the configuration into an IDE of your choice. | ||
|
||
If you are using only Eclipse for your IDE, you might choose to download the Galasa Eclipse plug-in directly from the external update site or as a zipped distribution. Users without restricted internet access who want to use open-source Galasa, can install the Galasa Eclipse plug-in directly. The zipped distribution of Galasa allows users who do not have access to Maven Central, Eclipse Marketplace and Docker Hub from their company network to use Galasa. | ||
If you do not have access to Maven Central, Eclipse Marketplace, and Docker Hub from your company network, you can use the Galasa zipped distribution. | ||
|
||
|
||
## Next steps | ||
|
||
Once you have decided on your download and install options, take a look at the [Prerequisites](../markdown-pages/docs/prerequisites) documentation to find out what software you need to install. | ||
If you are installing Galasa for using in the command-line, following the instructions in [Getting started using the CLI](/docs/cli-command-reference/cli-command-reference) documentation. | ||
|
||
If you are installing Galasa for using in the Eclipse, or if you are installing the zipped distribution of Galasa, follow the instructions in the [Getting started using Eclipse](/docs/getting-started) documentation. | ||
|
||
You can then choose to view either the [Getting started using the CLI](/docs/cli-command-reference/cli-command-reference) documentation or the [Getting started using Eclipse](/docs/getting-started) documentation. | ||
To find out about the architecture of Galasa and some of its key components, take a look at the [Galasa architecture](/docs/architecture) documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
src/markdown-pages/docs/cli-command-reference/installing-cli-tool.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
path: "/docs/cli-command-reference/installing-cli-tool" | ||
title: "Downloading and installing the Galasa CLI" | ||
--- | ||
|
||
This section provides details about prerequisite software requirements and information about how to download and install the Galasa CLI on your local machine. | ||
|
||
## Prerequisites | ||
|
||
| Software | Description | | ||
| :---- | :-------- | | ||
| Java JDK | Required. Galasa tests and Managers are written in Java - you need to install a Java version 11 JDK or later to use it. _Note:_ We do not currently support Java 17 or later. | | ||
| Maven or Gradle | You must install either Maven or Gradle in order to build Galasa projects. Galasa projects are hierarchical file structures that provide the ability to store and run Galasa tests. All Galasa versions are compatible with Gradle releases 6.8.x and later. | | ||
| 3270 emulator | Optional. Although you do not need a 3270 emulator to run a Galasa test (even if it tests a 3270 application) you can use one to explore Galasa Simbank, a simulated version of an application that helps you get acquainted with Galasa before connecting to a real mainframe to run your own tests. There are many such emulators available but IBM's Personal Communications (PCOMM) is frequently used, as is IBM's Host on Demand software, which includes support for Windows, Linux and MacOS.| | ||
|
||
|
||
## Downloading the Galasa CLI | ||
|
||
To install Galasa for using in the command-line you first need to download the binary file for the Galasa CLI from the Galasa cli respository in GitHub. | ||
|
||
The following versions of the Galasa CLI are available to download for different operating systems and machine architectures: | ||
|
||
| Operating system | Download | | ||
| :---- | :-------- | | ||
| MacOSX | galasactl-darwin-x86_64 | | ||
| MacOSX | galasactl-darwin-arm64 | | ||
| Linux 64-bit x86 | galasactl-linux-x86_64 | | ||
| Linux arm64 | galasactl-linux-arm64 | | ||
| zLinux | galasactl-linux-s390x | | ||
| Windows | galasactl-windows-x86_64.exe | | ||
|
||
You can find out the architecture of your machine by typing the command `uname -m` into your Mac or Linux terminal. | ||
|
||
|
||
## Installing the Galasa CLI | ||
|
||
Complete the following steps to install Galasa for using the command line: | ||
|
||
On Mac or Unix: | ||
|
||
1. Find out the architecture of your machine by typing the command `uname -m` into your terminal. | ||
2. Download the appropriate binary of the Galasa CLI for your machine architecture from the [Galasa cli repository](https://github.com/galasa-dev/cli/releases) in GitHub and re-name it to `galasactl`. | ||
3. Add Galasa CLI to your PATH to enable you to run CLI commands from anywhere on your file system without having to specify the absolute path. To set the path permanently, you need add the Galasa CLI path to your shell's initialization file. For example, if you downloaded the galasactl executable to a folder called `~/tools` in your home directory, you need to add `~/tools` to the list of directories that your shell searches through when you enter a command. You can do this by adding the line ```export PATH=$PATH:$HOME/tools``` to your shell’s initialization file (for example `~/.bashrc` or `~/.zshrc`). You should now be able to run the Galasa CLI too from any directory in your file system. | ||
4. Set execute permission on the binary by running the `chmod +x galasactl` command in the directory containing `galasactl`. | ||
5. If you are using a Mac, you can set permission to open the Galasa CLI tool by running the `spctl --add galasactl` command in the directory containing `galasactl`. You are prompted by a security panel asking you to log in to show that you are issuing the command. | ||
|
||
You are now able to run Galasa CLI commands from the command line. | ||
|
||
|
||
On Windows (Powershell) | ||
|
||
1. Download the binary and re-name it to `galasactl`. | ||
2. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. | ||
3. Open `cmd.exe` and type `start galasactl.exe` in the directory containing `galasactl`. | ||
|
||
You are now able to run Galasa CLI commands from the command line. | ||
|
||
|
||
## Next steps | ||
|
||
Read the [Initialising your local environment](/docs/initialising-home-folder) documentation to help you to set up some basic file structures and files in your home folder so that you can start using Galasa. | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.