-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating documentation for installs.
Addresses #248
- Loading branch information
1 parent
8d22d88
commit 8cc8380
Showing
4 changed files
with
20 additions
and
9 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
File renamed without changes.
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 |
---|---|---|
|
@@ -17,8 +17,8 @@ The following packages are currently supported: | |
Install from package involves downloading the appropriate package from the [release](https://github.com/esnet/gdg/releases) and installing it as you usually do on your favorite Distro. | ||
|
||
```sh | ||
rpm -Uvh ./gdg_0.5.1_amd64.rpm | ||
dpkg -i ./gdg_0.5.1_amd64.deb | ||
rpm -Uvh ./gdg_0.5.2_amd64.rpm | ||
dpkg -i ./gdg_0.5.2_amd64.deb | ||
``` | ||
|
||
### Homebrew Installation | ||
|
@@ -43,7 +43,7 @@ The docker tags are released started with 0.3.1. Each release will generate a m | |
You can see the available images [here](https://github.com/esnet/gdg/pkgs/container/gdg) | ||
|
||
```sh | ||
docker pull ghcr.io/esnet/gdg:0.5.1 | ||
docker pull ghcr.io/esnet/gdg:0.5.2 | ||
``` | ||
|
||
NOTE: ghcr.io/esnet/gdg:0.3 will also point to 0.3.1 until 0.3.2 is released after which it'll point to 0.3.2 | ||
|
@@ -54,7 +54,7 @@ Example compose. | |
version: '3.7' | ||
services: | ||
gdg: | ||
image: ghcr.io/esnet/gdg:0.5.1 | ||
image: ghcr.io/esnet/gdg:0.5.2 | ||
command: "--help" ## Add additional parameters here | ||
# command: "ds export" ## Pass any cmd on here. | ||
volumes: | ||
|
@@ -70,13 +70,24 @@ docker run -it --rm -v $(pwd)/config:/app/config -v $(pwd)/exports:/app/exports | |
|
||
### Installing via Go | ||
|
||
If you have go install you may run the following command to install gdg | ||
If you have go install you may run the following command to install gdg. Keep in mind there are two binaries you may install. | ||
|
||
- gdg ==> Main binary that manages the various entities supported. | ||
- gdg-generate => Helper utility that allows you to generate multiple dashboards given a valid configuration and seed data. | ||
|
||
** gdg ** | ||
```sh | ||
go install github.com/esnet/gdg@latest #for latest | ||
go install github.com/esnet/[email protected].1 #for a specific version | ||
go install github.com/esnet/gdg/cmd/gdg@latest #for latest | ||
go install github.com/esnet/[email protected].3 #for a specific version | ||
``` | ||
|
||
** gdg-generate ** | ||
```sh | ||
go install github.com/esnet/gdg/cmd/gdg-generate@latest #for latest | ||
go install github.com/esnet/[email protected] #for a specific version | ||
``` | ||
|
||
|
||
You can verify the version by running `gdg version`. | ||
|
||
## Configuration | ||
|