Install and start GUAC

Prerequisites

• Docker
• Docker Compose
• jq

Optional - Verify images and binaries

• Follow Verification of the GUAC images and binaries

Download GUAC

1. Download the GUAC CLI guacone binary for your machine’s OS and architecture from the latest GUAC release if you have not already done so. For example:

   • Linux x86_64 : guacone-linux-amd64
   • MacOS x86_64 : guacone-darwin-amd64
   • Windows x86_64 : guacone-windows-amd64.exe

2. Rename the binary to guacone, mark it executable if necessary, and add it to your shell’s path.

3. Download the compose yaml from the latest GUAC release.

4. Download and unzip the demo data used in these examples.

Start the GUAC server

1. From the directory you downloaded the guac-demo-compose.yaml, run:

   docker compose -f guac-demo-compose.yaml -p guac up --force-recreate
   

2. Verify that GUAC is running:

   docker compose ls --filter "name=guac"
   

   You should see:

   NAME                STATUS              CONFIG FILES
   guac                running(2)          /Users/lumb/go/src/github.com/guacsec/guac/docker-compose.yml,/Users/lumb/go/src/github.com/guacsec/guac/guac/container_files/mem.yaml
   guac-demo           running(5)          /Users/lumb/go/src/github.com/guacsec/guac-demo/guac-demo-compose.yaml
   

   If you don’t see the above, run docker compose down and try starting up GUAC again. Because Docker Compose caches the containers used, the unclean state can cause issues.

GUAC Ports

Port Number	GUAC Component	Note
8080	GraphQL server	To see the GraphQL playground, visit http://localhost:8080
2782	Collector Subscriber	This service is notified whenever you run a collector, such as guacone collect files below. Then subscribers can collect more data on any packages ingested.

Now that you’ve installed GUAC, it’s time to ingest data.