-
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.
[TechDebt] Adding documentation for #113
- Loading branch information
1 parent
342a47b
commit 00fa74d
Showing
2 changed files
with
51 additions
and
7 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,6 @@ RUN mkdir /app | |
COPY gdg /app/gdg | ||
VOLUME /app/conf | ||
VOLUME /app/exports | ||
|
||
WORKDIR /app | ||
ENTRYPOINT ["/app/gdg"] |
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 |
---|---|---|
|
@@ -4,18 +4,60 @@ weight: 1 | |
--- | ||
## Installation | ||
|
||
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 are not yet supported but will be coming soon since goreleaser has that feature. | ||
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. | ||
|
||
Planned package [support](https://github.com/esnet/gdg/issues/89) for: | ||
- HomeBrew | ||
- Debian | ||
- RPMs | ||
The following packages are currently supported: | ||
- RPM | ||
- APK | ||
- Docker | ||
|
||
### Package Installation | ||
|
||
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.3.1_amd64.rpm | ||
dpkg -i ./gdg_0.3.1_amd64.deb | ||
``` | ||
|
||
### Docker usage | ||
|
||
The docker tags are released started with 0.3.1. Each release will generate a major version and minor version tag. | ||
|
||
You can see the available images [here](https://github.com/esnet/gdg/pkgs/container/gdg) | ||
|
||
```sh | ||
docker pull ghcr.io/esnet/gdg:0.3.1 | ||
``` | ||
|
||
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 | ||
|
||
Example compose. | ||
|
||
```yaml | ||
version: '3.7' | ||
services: | ||
gdg: | ||
image: ghcr.io/esnet/gdg:0.3.1 | ||
command: "--help" ## Add additional parameters here | ||
# command: "ds export" ## Pass any commands on here. | ||
volumes: | ||
- ./conf:/app/conf ## where the configuration lives | ||
- ./exports:/app/exports ## doesn't need to be /app/exports but you should export the destination of where exports are being written out to. | ||
``` | ||
From the CLI: | ||
```sh | ||
docker run -it --rm -v $(pwd)/conf:/app/conf -v $(pwd)/exports:/app/exports ghcr.io/esnet/gdg:latest ds --help | ||
|
||
### Installing via Go | ||
|
||
If you have go install you may run the following command to install gdg | ||
|
||
```sh | ||
go install github.com/esnet/gdg@latest | ||
go install github.com/esnet/gdg@latest #for latest | ||
go install github.com/esnet/[email protected] #for a specific version | ||
``` | ||
|
||
You can verify the version by running `gdg version`. | ||
|
@@ -24,4 +66,4 @@ You can verify the version by running `gdg version`. | |
|
||
You can then create a simple configuration using `gdg 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/configuration/) | ||
|
||
|
||
**NOTE**: wizard doesn't currently support ALL features but it should help you get a head start. |