Skip to content

Commit

Permalink
Add mac docker settings recommendations.
Browse files Browse the repository at this point in the history
  • Loading branch information
charlielye committed Dec 10, 2023
1 parent e908703 commit d1ebc72
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
21 changes: 16 additions & 5 deletions aztec-up/bin/aztec-install
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,16 @@ function title() {
echo -e "Welcome to the ${bold}${b}Aztec${r} installer! Your journey into blockchain privacy begins... ${bold}${p}now${r}."
echo -e "We presently leverage docker to simplify releases of our complex project."
echo -e "Please ensure it's installed for your platform: https://docs.docker.com/engine/install"
echo
if [ "$(uname -s)" == "Darwin" ]; then
echo
echo -e "${y}WARNING: For best performance we recommend adjusting your default docker settings:"
echo -e " - Under general, enable VirtioFS."
echo -e " - Under resources, set CPUs to ~80-100% your maximum."
echo -e " - Under resources, set Memory to ~80% your maximum."
echo -e "You may receive a warning about your home directory being mounted into a container."
echo -e "This is requested so we can read and write project files, that is all."
echo -e "${r}"
fi
echo -e "This will install the following scripts and update your PATH if necessary:"
echo -e " ${bold}${g}aztec${r} - launches various infrastructure subsystems (sequencer, prover, pxe, etc)."
echo -e " ${bold}${g}aztec-cli${r} - a command line tool for interfacing and experimenting with infrastructure."
Expand Down Expand Up @@ -91,10 +100,12 @@ function pull_container {
fi
}

info "Pulling aztec version $VERSION..."
pull_container aztec-sandbox
pull_container cli
pull_container noir
if [ -z "${SKIP_PULL:-}" ]; then
info "Pulling aztec version $VERSION..."
pull_container aztec-sandbox
pull_container cli
pull_container noir
fi

# Download the Docker Compose file. Used by aztec-start.
curl -fsSL http://$INSTALL_HOST/docker-compose.yml -o $BIN_PATH/docker-compose.yml
Expand Down
2 changes: 1 addition & 1 deletion build_manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -216,4 +216,4 @@ docs:
yellow-paper:
buildDir: yellow-paper
rebuildPatterns:
- ^yellow-paper/
- ^yellow-paper/

0 comments on commit d1ebc72

Please sign in to comment.