github.com/esnet/gdg@v0.6.1-0.20240412190737-6b6eba9c14d8/website/content/docs/gdg/installation.md (about)

     1  ---
     2  title: "Installation"
     3  weight: 1
     4  ---
     5  ## Installation
     6  
     7  The easiest way to install GDG is to get one of the pre-compiled binaries from our release page which can be found [here](https://github.com/esnet/gdg/releases).  Packages for a few distributions have been added.  The release cycle relies on goreleaser so anything that is well supported can be added it at some point.  There is no APT or such you can connect to but the packages are available for download.
     8  
     9  The following packages are currently supported:
    10    - RPM
    11    - APK
    12    - Docker
    13    - Brew
    14  
    15  ### Package Installation
    16  
    17  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.
    18  
    19  ```sh
    20  rpm -Uvh ./gdg_0.6.0_amd64.rpm
    21  dpkg -i ./gdg_0.6.0_amd64.deb
    22  ```
    23  
    24  ### Homebrew Installation
    25  
    26  
    27  ```sh
    28  brew tap esnet/gdg
    29  brew update
    30  brew install gdg
    31  ```
    32  
    33  If there is a conflict you can try to be explicit.
    34  
    35  ```sh
    36  brew install esnet/gdg/gdg
    37  ```
    38  
    39  ### Docker usage
    40  
    41  The docker tags are released started with 0.3.1.  Each release will generate a major version and minor version tag.
    42  
    43  You can see the available images [here](https://github.com/esnet/gdg/pkgs/container/gdg)
    44  
    45  ```sh
    46  docker pull ghcr.io/esnet/gdg:0.6.0
    47  ```
    48  
    49  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
    50  
    51  Example compose.
    52  
    53  ```yaml
    54  version: '3.7'
    55  services:
    56    gdg:
    57      image:  ghcr.io/esnet/gdg:0.6.0
    58      command: "--help"            ## Add additional parameters here
    59  #    command: "ds export"       ## Pass any cmd on here.
    60      volumes:
    61        - ./config:/app/config      ## where the configuration lives
    62        - ./exports:/app/exports  ## doesn't need to be /app/exports but you should export the destination of where exports are being written out to.
    63  ```
    64  
    65  From the CLI:
    66  
    67  ```sh
    68  docker run -it --rm -v $(pwd)/config:/app/config -v $(pwd)/exports:/app/exports ghcr.io/esnet/gdg:latest  ds --help
    69  ```
    70  
    71  ### Installing via Go
    72  
    73  If you have go install you may run the following command to install gdg.  Keep in mind there are two binaries you may install.
    74  
    75  - gdg ==> Main binary that manages the various entities supported.
    76  - gdg-generate => Helper utility that allows you to generate multiple dashboards given a valid configuration and seed data.
    77  
    78  ---
    79  
    80  **gdg**
    81  ```sh
    82  go install github.com/esnet/gdg/cmd/gdg@latest  #for latest
    83  go install github.com/esnet/gdg/cmd/gdg@v0.6.0  #for a specific version
    84  ```
    85  
    86  You can verify the version by running `gdg version`.
    87  
    88  **gdg-generate**
    89  ```sh
    90  go install github.com/esnet/gdg/cmd/gdg-generate@latest  #for latest
    91  go install github.com/esnet/gdg/cmd/gdg-generate@v0.6.0  #for a specific version
    92  ```
    93  
    94  ---
    95  
    96  ## Configuration
    97  
    98  You can then create a simple configuration using `gdg tools ctx new` which will do a best effort to guide to setup a basic config that will get you up and going or read the more detailed documentation that can be found [here](/gdg/docs/gdg/configuration/)
    99  
   100  
   101  **NOTE**: wizard doesn't currently support ALL features but it should help you get a head start.