Skip to content

Commit

Permalink
Adapted an env var used in docs to reflect the change in latest ceram…
Browse files Browse the repository at this point in the history
…ic release (#29)

* Changed the docs to reflect the change of an env var used to run a ceramic node with indexing

* Fixed the env var name and added a note about composedb not working on mainnet
  • Loading branch information
pawartur authored Sep 8, 2022
1 parent f8262ac commit b254c83
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions website/docs/first-composite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This page presents how to create your first composite and deploy it to your loca

## Running a local Ceramic node

:::caution

Because ComposeDB is still an experimental feature set built on top of Ceramic, if you want to use it with a Ceramic node, you need to set the `CERAMIC_ENABLE_EXPERIMENTAL_COMPOSE_DB` environment variable to `true`, before running a node. Note that ComposeDB is not yet supported on Ceramic mainnet.

:::

The following steps require a local Ceramic node to be running. If you do not already have it running, you can use the following command:

<Tabs
Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-0.2.x/first-composite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This page presents how to create your first composite and deploy it to your loca

:::caution

Because ComposeDB is still an experimental feature set built on top of Ceramic, if you want to use it with a Ceramic node, you need to set the `CERAMIC_ENABLE_EXPERIMENTAL_INDEXING` environment variable to `true`, before running a node.
Because ComposeDB is still an experimental feature set built on top of Ceramic, if you want to use it with a Ceramic node, you need to set the `CERAMIC_ENABLE_EXPERIMENTAL_COMPOSE_DB` environment variable to `true`, before running a node. Note that ComposeDB is not yet supported on Ceramic mainnet.

:::

Expand Down

0 comments on commit b254c83

Please sign in to comment.