Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update outdated pieces #107

Merged
merged 3 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/composedb/create-ceramic-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,35 @@ Get up and running quickly with a basic ComposeDB application with one command.
- **Node.js v20** - If you are using a different version, please use `nvm` to install Node.js v20 for best results.
- **npm v10** - Installed automatically with NodeJS v20

You will also need to run a ceramic-one node in the background which provides Ceramic
data network access. To set it up, follow the steps below:

:::note
The instructions below cover the steps for the MacOS-based systems. If you are running on a Linux-based system, you can find the
instructions [here](https://github.com/ceramicnetwork/rust-ceramic?tab=readme-ov-file#linux---debian-based-distributions).
:::

1. Install the component using [Homebrew](https://brew.sh/):

```bash
brew install ceramicnetwork/tap/ceramic-one
```

2. Start the `ceramic-one` using the following command:
```bash
ceramic-one daemon --network in-memory
```

:::note
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:

```ceramic-one daemon --network testnet-clay```
:::

---

## Start the ComposeDB example app

You can easily create a simple ComposeDB starter project by using our CLI and running the following command:

<Tabs
Expand Down
12 changes: 0 additions & 12 deletions docs/composedb/guides/composedb-server/server-configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,18 +183,6 @@ Only Postgres is currently supported for production usage.

:::

## History Sync
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:

```json
{
...
"indexing": {
...
"enable-historical-sync": true
}
}
```

## IPFS Process
### Available Configurations
Expand Down
6 changes: 3 additions & 3 deletions docs/wheel/wheel-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ This section dives deeper into the Ceramic parameters you can configure when you

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

Expand Down
Loading