Skip to content

Commit 90461d0

Browse files
authored
Merge pull request #107 from ceramicnetwork/JustinaPetr-patch-2
Update outdated pieces
2 parents 25f0228 + 4a24b52 commit 90461d0

3 files changed

Lines changed: 32 additions & 15 deletions

File tree

docs/composedb/create-ceramic-app.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,35 @@ Get up and running quickly with a basic ComposeDB application with one command.
1111
- **Node.js v20** - If you are using a different version, please use `nvm` to install Node.js v20 for best results.
1212
- **npm v10** - Installed automatically with NodeJS v20
1313

14+
You will also need to run a ceramic-one node in the background which provides Ceramic
15+
data network access. To set it up, follow the steps below:
16+
17+
:::note
18+
The instructions below cover the steps for the MacOS-based systems. If you are running on a Linux-based system, you can find the
19+
instructions [here](https://github.com/ceramicnetwork/rust-ceramic?tab=readme-ov-file#linux---debian-based-distributions).
20+
:::
21+
22+
1. Install the component using [Homebrew](https://brew.sh/):
23+
24+
```bash
25+
brew install ceramicnetwork/tap/ceramic-one
26+
```
27+
28+
2. Start the `ceramic-one` using the following command:
29+
```bash
30+
ceramic-one daemon --network in-memory
31+
```
32+
33+
:::note
34+
By default, the command above will spin off a node which connects to a `in-memory`. You can change this behaviour by providing a `--network` flag and specifying a network of your choice. For example:
35+
36+
```ceramic-one daemon --network testnet-clay```
37+
:::
38+
39+
---
40+
41+
## Start the ComposeDB example app
42+
1443
You can easily create a simple ComposeDB starter project by using our CLI and running the following command:
1544

1645
<Tabs

docs/composedb/guides/composedb-server/server-configurations.mdx

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -183,18 +183,6 @@ Only Postgres is currently supported for production usage.
183183

184184
:::
185185

186-
## History Sync
187-
By default, Ceramic nodes will only index documents they observe using pubsub messages. In order to index documents created before the node was deployed or configured to index some models, **History Sync** needs to be enabled on the Ceramic node, in the `daemon.config.json` file:
188-
189-
```json
190-
{
191-
...
192-
"indexing": {
193-
...
194-
"enable-historical-sync": true
195-
}
196-
}
197-
```
198186

199187
## IPFS Process
200188
### Available Configurations

docs/wheel/wheel-reference.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ This section dives deeper into the Ceramic parameters you can configure when you
112112

113113
An option to define if IFPS runs in the same compute process as Ceramic. You have two options to choose from:
114114

115-
- Bundled - IPFS running in same compute process as Ceramic; recommended for early prototyping.
116-
- Remote - IPFS running in separate compute process; recommended for production and everything besides early prototyping.
117-
This assumes that you have the IPFS process setup and can provide an IPFS Hostname.
115+
- 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`
116+
- Bundled - IPFS running in same compute process as Ceramic; used only with older Ceramic versions that use Kubo.
117+
118118

119119
### State Store
120120

0 commit comments

Comments
 (0)