Skip to content

Commit

Permalink
Update readme with new installation instructions (#116)
Browse files Browse the repository at this point in the history
Signed-off-by: Nicko Guyer <[email protected]>
  • Loading branch information
nguyer authored Nov 18, 2021
1 parent 1eaadbd commit dff1fa0
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,32 @@ In order to run the FireFly CLI, you will need a few things installed on your de

- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
- [Go](https://golang.org/)
- openssl

## Install the CLI

On Go 1.16 and newer:
The easiest way to get up and running with the FireFly CLI is to download a pre-compiled binary of the latest release.

```
$ go install github.com/hyperledger/firefly-cli/ff@latest
```
### Download the package for your OS
Go to the [latest release page](https://github.com/hyperledger/firefly-cli/releases/latest) and download the package for your OS and CPU architecture.

### Extract the binary and move it to `/usr/bin/local`

On earlier versions of Go:
Assuming you downloaded the package from GitHub into you `Downloads` directory, run the following command:

```
$ go get github.com/hyperledger/firefly-cli/ff
sudo tar -zxf ~/Downloads/firefly-cli_*.tar.gz -C /usr/local/bin ff
```

If you downloaded the package from GitHub into a different directory, you will need to change the `tar` command above to wherever the `firefly-cli_*.tar.gz ` file is located.

### macOSUsers
> **NOTE**: On recent versions of macOS, default security settings will prevent the FireFly CLI binary from running, because it was downloaded from the internet. You will need to [allow the FireFly CLI in System Preferences](docs/mac_help.md), before it will run.
### Windows Users
> **NOTE**: For Windows users, we recommend that you use [Windows Subsystem for Linux 2 (WSL2)](https://docs.microsoft.com/en-us/windows/wsl/). Binaries provided for Linux will work in this environment.
### Linux Users
> **NOTE**: For Linux users, it is recommended that you add your user to the `docker` group so that you do not have to run `ff` or `docker` as `root` or with `sudo`. For more information about Docker permissions on Linux, please see [Docker's documentation on the topic](https://docs.docker.com/engine/install/linux-postinstall/).
## Create a new stack
Expand Down
Binary file added docs/allow_ff.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/blocked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/mac_help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Allow the FireFly CLI to run on macOS

On macOS default security settings prevent running arbitrary executable files downloaded from the internet, so you'll need to approve the FireFly CLI. You will only have to go through these steps once after installing, or updating the FireFly CLI. The first time you try to run `ff` in your terminal you will likely see a dialog like this. Simply cancel this dialog.

## If you see this dialog, cancel it

![ff blocked](blocked.png)

## Go to System Preferences and click on Security & Privacy

![System Preferences](system_preferences.png)

## Click on the Allow Anyway button

![Allow ff](allow_ff.png)

## Now try running `ff` again and click Open

Now try running the `ff` command in your terminal and a final confirmation dialog should appear. Click open:

![Open dialog](open.png)


This time the `ff` command should succeed and you should see something like this in your terminal:

![FireFly CLI](firefly_screenshot.png)
Binary file added docs/open.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/system_preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dff1fa0

Please sign in to comment.