docs: update installation guide

raystack · Aug 21, 2022 · eed56b6 · eed56b6
1 parent a049bbe
commit eed56b6
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,10 @@ Check for installed guardian version
 guardian version
 ```
 
+#### Linux
+
+`guardian` is available as downloadable binaries from the [releases](https://github.com/odpf/guardian/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
+
 #### Windows
 
 `guardian` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/guardian/releases/latest) page:

diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -3,24 +3,72 @@
 There are several approaches to install Guardian CLI
 
 1. [Using a pre-compiled binary](#binary-cross-platform)
-2. [Installing with package manager](#homebrew-installation)
+2. [Installing with package manager](#macOS)
 3. [Installing from source](#building-from-source)
 
-### Binary (Cross-platform)
+#### Binary (Cross-platform)
 
-Guardian binaries are downloadable on the [Releases page](https://github.com/odpf/guardian/releases). Currently, the installer is not available. Once downloaded, the binary can be run from anywhere. You don’t need to install it in a global location. This works well for shared hosts and other systems where you don’t have a privileged account. Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.
+Download the appropriate version for your platform from [releases](https://github.com/odpf/guardian/releases) page. Once downloaded, the binary can be run from anywhere.
+You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account.
+Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.
 
-### Homebrew Installation
+#### macOS
+
+`guardian` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/odpf/guardian/releases/latest) page:
+
+```sh
+brew install odpf/tap/guardian
+```
+
+To upgrade to the latest version:
+
+```
+brew upgrade guardian
+```
+
+Check for installed guardian version
 
 ```sh
-# Install guardian (requires homebrew installed)
-$ brew install odpf/tap/guardian
+guardian version
+```
+
+#### Linux
+
+`guardian` is available as downloadable binaries from the [releases](https://github.com/odpf/guardian/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
 
-# Upgrade guardian (requires homebrew installed)
-$ brew upgrade guardian
+#### Windows
+
+`guardian` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/guardian/releases/latest) page:
+
+```
+scoop bucket add guardian https://github.com/odpf/scoop-bucket.git
+```
 
-# Check for installed guardian version
-$ guardian version
+To upgrade to the latest version:
+
+```
+scoop update guardian
+```
+
+#### Docker
+
+We provide ready to use Docker container images. To pull the latest image:
+
+```
+docker pull odpf/guardian:latest
+```
+
+To pull a specific version:
+
+```
+docker pull odpf/guardian:v0.3.2
+```
+
+If you like to have a shell alias that runs the latest version of pscale from docker whenever you type `pscale`:
+
+```
+mkdir -p $HOME/.config/odpf
+alias guardian="docker run -e HOME=/tmp -v $HOME/.config/odpf:/tmp/.config/odpf --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp odpf/guardian:latest"
 ```
 
 ### Building from source