Automate plugin installation (#43)

* Add url parameter to plugin config
* Update docs with more plugin install instructions
* Update modified date

---------

Signed-off-by: Mostafa Moradian <mostafa@gatewayd.io>

Author: mostafa

getting-started/installation.md

@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-01-16 20:49:17 +0100
+last_modified_date: 2024-01-29 21:30:54 +0100
 layout: default
 title: Installation
 description: How to install GatewayD and its plugins on different platforms and how to build it from source.
@@ -95,9 +95,26 @@ docker-compose up -d
 
 ## Installing plugins
 
-Plugins are available as standalone binaries for different platforms. These binaries are available in their GitHub repositories.
+Plugins are available as standalone binaries for different platforms. These binaries are available in their GitHub repositories and are distributed as archives that contain the binary and the default configuration file for the plugin. The README file and the LICENSE file might also be included in the archive.
 
-The plugins can be installed by using the `plugin` subcommand of `gatewayd`:
+There are currently four ways to install plugins using the `gatewayd plugin install` subcommand:
+
+1. Providing the plugins configuration file with the plugins' URLs and versions.
+2. Using the GitHub URL of the plugin plus the version.
+3. Using the already downloaded archive of the plugin.
+4. Manually downloading, extracting and placing the plugins' binaries in your desired location and updating the plugins configuration file.
+
+### 1. Using the plugins configuration file
+
+In the `gatewayd_plugins.yaml` configuration file, you can specify the URLs and versions of the plugins that you want to install. The `gatewayd plugin install` subcommand will download the archives of the plugins from the specified URLs and extract them to the `plugins` directory in the current working directory and will also update the `gatewayd_plugins.yaml` configuration file.
+
+```bash
+gatewayd plugin install
+```
+
+### 2. Using the GitHub URL of the plugin plus the version
+
+You can also install plugins using the GitHub URL of the plugin plus the version. The `gatewayd plugin install` subcommand will download the archive of the plugin from the specified URL and extract it to the `plugins` directory in the current working directory.
 
 ```bash
 gatewayd plugin install github.com/<organization>/<plugin-name>@<version>
@@ -109,9 +126,25 @@ For example, to install the `gatewayd-plugin-cache` plugin:
 gatewayd plugin install github.com/gatewayd-io/gatewayd-plugin-cache@latest
 ```
 
-The plugin binary will be installed in the `plugins` directory in the current working directory. For more flags, please refer to the [CLI](/using-gatewayd/CLI) page or just run `gatewayd plugin install --help`.
+You can also specify that you want to pull only and you don't want to extract the archive of the plugin.
+
+```bash
+gatewayd plugin install --pull-only github.com/gatewayd-io/gatewayd-plugin-cache@latest
+```
+
+### 3. Using the already downloaded archive of the plugin
+
+You can also install plugins using the already downloaded archive of the plugin or using the `--pull-only` flag explained above. The `gatewayd plugin install` subcommand will extract the archive of the plugin to the `plugins` directory in the current working directory. The `--name` flag is mandatory when using this method and it must be the same as the name of the plugin.
+
+```bash
+gatewayd plugin install --name <plugin-name> <path-to-archive>
+```
+
+### 4. Manually downloading, extracting and placing the plugins' binaries in your desired location
+
+You can manually download, extract and place the plugins' binaries in your desired location that is accessible to GatewayD via the plugins configuration file, aka. `gatewayd_plugins.yaml`. Then you must update the plugins configuration file with the desired plugin's configuration that is available in the plugin's repository as `gatewayd_plugin.yaml` (or inside the archive file of the plugin). Checksum files are also available in the plugin's repository as release assets and also inside the archive file of the plugin.
 
-Alternatively you can manually download, extract and place the plugins' binaries in your desired location that is accessible to GatewayD via the plugins configuration file, aka. `gatewayd_plugins.yaml`.
+For more flags, please refer to the [CLI](/using-gatewayd/CLI) page or just run `gatewayd plugin install --help`.
 
 For more information about plugins, please refer to the [plugins configuration](/using-gatewayd/plugins-configuration/plugins-configuration) and the [plugins](/using-plugins/plugins) page.
 

getting-started/running-gatewayd.md

@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-01-16 20:49:17 +0100
+last_modified_date: 2024-01-29 21:30:54 +0100
 layout: default
 title: Running GatewayD
 description: How to run GatewayD and test it with psql
@@ -61,7 +61,7 @@ Download and extract GatewayD and the [gatewayd-cache-plugin](/plugins/gatewayd-
 ```bash
 mkdir gatewayd && cd gatewayd
 curl -L https://github.com/gatewayd-io/gatewayd/releases/download/{% github_latest_release gatewayd-io/gatewayd %}/gatewayd-linux-amd64-{% github_latest_release gatewayd-io/gatewayd %}.tar.gz | tar zxvf -
-./gatewayd plugin install --update --backup github.com/gatewayd-io/gatewayd-plugin-cache@{% github_latest_release gatewayd-io/gatewayd-plugin-cache %}
+./gatewayd plugin install --update --backup github.com/gatewayd-io/gatewayd-plugin-cache@latest
 ```
 
 The last command will do the following:

getting-started/welcome.md

@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-01-16 20:49:17 +0100
+last_modified_date: 2024-01-29 21:04:09 +0100
 layout: default
 title: Welcome
 description: Introduction to GatewayD and its key features
@@ -60,7 +60,8 @@ These are just a few examples and the list is not exhaustive, as new plugins are
 
 ## What GatewayD does not do
 
-GatewayD is not a silver bullet and won't solve all your database problems overnight. 
+GatewayD is not a silver bullet and won't solve all your database problems overnight.
+
 You still have to design and normalize your database schema, take and test backups, secure your database and do whatever you used to do before GatewayD. GatewayD came into existence to fix the black box mentality that surrounds databases to this very day.
 
 Over time many plugins will be developed either by us or the community that will try to solve different issues arose from utilizing databases.

plugins/gatewayd-plugin-cache.md

@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-01-16 20:49:17 +0100
+last_modified_date: 2024-01-29 21:04:09 +0100
 layout: default
 title: gatewayd-plugin-cache
 description: GatewayD plugin for caching query results in Redis.
@@ -68,6 +68,7 @@ plugins:
   - name: gatewayd-plugin-cache
     enabled: True
     localPath: ../gatewayd-plugin-cache/gatewayd-plugin-cache
+    url: github.com/gatewayd-io/gatewayd-plugin-cache@latest
     args: ["--log-level", "info"]
     env:
       - MAGIC_COOKIE_KEY=GATEWAYD_PLUGIN