From 15c7637f69b60bc6616ea21d63e6ffb1e712e681 Mon Sep 17 00:00:00 2001 From: Justina Petraityte Date: Mon, 2 Sep 2024 18:26:58 +0100 Subject: [PATCH] update the quickstart guide --- docs/composedb/set-up-your-environment.mdx | 16 +++++++++------- docs/wheel/wheel-reference.mdx | 8 ++++---- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/composedb/set-up-your-environment.mdx b/docs/composedb/set-up-your-environment.mdx index 3444382c..96047ec6 100644 --- a/docs/composedb/set-up-your-environment.mdx +++ b/docs/composedb/set-up-your-environment.mdx @@ -15,15 +15,9 @@ By the end of this guide you'll have a good understanding of how to get started ## 2. Installation -There are a few ways to set up your environment. Choose the one that best fits your needs: - -- [Using `create-ceramic-app`](#installation-using-create-ceramic-app) - get up and running quickly with a basic ComposeDB application with one command. Good for the first quick experience with Ceramic and ComposeDB. -- [Using the Wheel](#installation-using-wheel) - the recommended and the easiest way to configure your full working environment and install the necessary dependencies. -- [Using JavaScript package managers](#installation-using-javascript-package-managers) - an alternative, more manual, way to configure your working environment which supports `npm`, `pnpm` and `yarn`. - **Install and start the `ceramic-one` binary** -All of the configuration options listed above **require a `ceramic-one` binary up and running**, which provides a data network access. You can run `ceramic-one` on your +All of the ComposeDB configuration options listed below **require a `ceramic-one` binary up and running**, which provides a data network access. You can run `ceramic-one` on your local machine using two simple steps listed below. :::note @@ -59,6 +53,14 @@ ceramic-one daemon --store-dir ~/.ceramic-one --p2p-key-dir ~/.ceramic-one With `ceramic-one` binary up and running you can move on with the ComposeDB installation and configuration method of your choice. +**Install ComposeDB** + +There are a few ways to set up your environment to run ComposeDB. Choose the one that best fits your needs: + +- [Using `create-ceramic-app`](#installation-using-create-ceramic-app) - get up and running quickly with a basic ComposeDB application with one command. Good for the first quick experience with Ceramic and ComposeDB. +- [Using the Wheel](#installation-using-wheel) - the recommended and the easiest way to configure your full working environment and install the necessary dependencies. +- [Using JavaScript package managers](#installation-using-javascript-package-managers) - an alternative, more manual, way to configure your working environment which supports `npm`, `pnpm` and `yarn`. + --- diff --git a/docs/wheel/wheel-reference.mdx b/docs/wheel/wheel-reference.mdx index 3e01390b..20071fcf 100644 --- a/docs/wheel/wheel-reference.mdx +++ b/docs/wheel/wheel-reference.mdx @@ -108,13 +108,13 @@ An option to start your Ceramic daemon which will spin up the node using the Cer This section dives deeper into the Ceramic parameters you can configure when you choose `Advanced: Configure all ceramic options` option in your wheel prompt. -### Bundled or Remote IPFS +### Remote or Bundlesd IPFS An option to define if IFPS runs in the same compute process as Ceramic. You have two options to choose from: -- Bundled - IPFS running in same compute process as Ceramic; recommended for early prototyping. -- Remote - IPFS running in separate compute process; recommended for production and everything besides early prototyping. - This assumes that you have the IPFS process setup and can provide an IPFS Hostname. +- Remote - IPFS running in separate compute process; recommended for all Ceramic versions that use `ceramic-one`. This configuration requires an IPFS Hostname. Default value is `http://localhost:5101` +- Bundled - IPFS running in same compute process as Ceramic; used only with older Ceramic versions that use Kubo. + ### State Store