From b871dff396a6a69330fbee608058bc48dbd8a776 Mon Sep 17 00:00:00 2001 From: Marek Date: Sun, 21 May 2023 21:29:00 +0200 Subject: [PATCH] fix(docs): Fix some inaccuracies in Docker docs (#6723) * Fix dead links * Fix the `docker build` command The `docker build` command requires a `PATH` at its end, otherwise it doesn't work. * Remove redundant sections * Restore & refactor the `Alternatives` subsection --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- book/src/user/docker.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/book/src/user/docker.md b/book/src/user/docker.md index 2d6ea608f..65760f71f 100644 --- a/book/src/user/docker.md +++ b/book/src/user/docker.md @@ -6,7 +6,7 @@ We've embraced Docker in Zebra for most of the solution lifecycle, from developm ## Quick usage -You can deploy Zebra for a daily use with the images available in [Docker Hub](https://hub.docker.com/repository/docker/zfnd/zebra) or build it locally for testing +You can deploy Zebra for a daily use with the images available in [Docker Hub](https://hub.docker.com/r/zfnd/zebra) or build it locally for testing ### Ready to use image @@ -18,27 +18,16 @@ docker run --detach zfnd/zebra:1.0.0-rc.8 ```shell git clone --depth 1 --branch v1.0.0-rc.8 https://github.com/ZcashFoundation/zebra.git -docker build --file docker/Dockerfile --target runtime --tag zebra:local +docker build --file docker/Dockerfile --target runtime --tag zebra:local . docker run --detach zebra:local ``` ### Alternatives -See the Zebra [build instructions](https://github.com/ZcashFoundation/zebra#build-instructions). - -## Images - -The Zebra team builds multiple images with a single [Dockerfile](https://github.com/ZcashFoundation/zebra/blob/main/docker/Dockerfile) using [multistage builds](https://docs.docker.com/build/building/multi-stage/). The `test` stage adds needed features and tools (like [lightwalletd](https://github.com/adityapk00/lightwalletd)) and the `runtime` stage just adds the _zebrad_ binary and required _zcash-params_ for Zebra to run correctly. - -As a result the Zebra team builds four images: - -- [zcash-params](us-docker.pkg.dev/zealous-zebra/zebra/zcash-params): built Zcash network parameters -- [lightwalletd](us-docker.pkg.dev/zealous-zebra/zebra/lightwalletd): a backend service that provides an interface to the Zcash blockchain -- [zebrad-test](us-docker.pkg.dev/zealous-zebra/zebra/zebrad-test): a zebrad binary with lightwalletd included, and test suites enabled -- [zebra](https://hub.docker.com/repository/docker/zfnd/zebra): a streamlined version with the zebrad binary and just the needed features needed to run _as-is_ +See [Building Zebra](https://github.com/ZcashFoundation/zebra#building-zebra) for more information. ## Registries The images built by the Zebra team are all publicly hosted. Old image versions meant to be used by our [CI pipeline](https://github.com/ZcashFoundation/zebra/blob/main/.github/workflows/continous-integration-docker.yml) (`zebrad-test`, `lighwalletd`) might be deleted on a scheduled basis. -We use [Docker Hub](https://hub.docker.com/repository/docker/zfnd/zebra) for end-user images and [Google Artifact Registry](https://console.cloud.google.com/artifacts/docker/zealous-zebra/us/zebra) to build external tools and test images +We use [Docker Hub](https://hub.docker.com/r/zfnd/zebra) for end-user images and [Google Artifact Registry](https://console.cloud.google.com/artifacts/docker/zealous-zebra/us/zebra) to build external tools and test images