Skip to content

Commit

Permalink
Merge branch 'dev' into trunk
Browse files Browse the repository at this point in the history
  • Loading branch information
blaander committed Oct 2, 2023
2 parents ba9d654 + be0688c commit 6404a19
Show file tree
Hide file tree
Showing 22 changed files with 3,540 additions and 400 deletions.
13 changes: 10 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,21 @@ coverage_report: clean
cd unit_tests && gcovr -r ../src/libmerc

.PHONY: doc
doc: doc/mercury.pdf
doc: doc/mercury.pdf sphinx

doc/mercury.pdf:
doxygen
cd doc/latex; make; mv refman.pdf ../mercury.pdf

.PHONY: clean
clean:
.PHONY: sphinx sphinx-clean
sphinx:
cd doc/sphinx && $(MAKE) html

sphinx-clean:
cd doc/sphinx && $(MAKE) clean

.PHONY:
clean: sphinx-clean
for file in Makefile README.md configure.ac Doxyfile; do if [ -e "$$file~" ]; then rm -f "$$file~" ; fi; done
ifneq ($(wildcard src/Makefile), src/Makefile)
@echo $(COLOR_RED) "error: run ./configure before running make (src/Makefile is missing)" $(COLOR_OFF)
Expand Down
15 changes: 8 additions & 7 deletions doc/batch-gcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,21 @@ Authors: Brandon Enright, Andrew Chi, David McGrew

## Installation

The easiest way to try Batch GCD is to use the Docker image of the `mercury`
package, hosted at the path `ghcr.io/cisco/mercury:latest`. We also provide
instructions for building the mercury package from source.
The easiest way to try Batch GCD is by building a Docker image of the `mercury`
package. We also provide instructions for building the mercury package from source.

### Docker

The Docker image for `mercury` also includes the tools `batch_gcd`,
`cert_analyze`, and `tls_scanner`. Note that depending on your Docker
configuration, the docker command may require sudo.
```
$ docker pull ghcr.io/cisco/mercury:latest
$ alias batch_gcd='docker run --rm -i --entrypoint /usr/local/bin/batch_gcd --volume .:/root ghcr.io/cisco/mercury:latest'
$ alias cert_analyze='docker run --rm -i --entrypoint /usr/local/bin/cert_analyze --volume .:/root ghcr.io/cisco/mercury:latest'
$ alias tls_scanner='docker run --rm -i --entrypoint /usr/local/bin/tls_scanner --volume .:/root ghcr.io/cisco/mercury:latest'
$ git clone https://github.com/cisco/mercury.git
$ cd mercury
$ docker build -t mercury:latest .
$ alias batch_gcd='docker run --rm -i --entrypoint /usr/local/bin/batch_gcd --volume .:/root mercury:latest'
$ alias cert_analyze='docker run --rm -i --entrypoint /usr/local/bin/cert_analyze --volume .:/root mercury:latest'
$ alias tls_scanner='docker run --rm -i --entrypoint /usr/local/bin/tls_scanner --volume .:/root mercury:latest'
```
You can then run the commands with `--help`. For example: `batch_gcd --help`.

Expand Down
Loading

0 comments on commit 6404a19

Please sign in to comment.