Skip to content
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
43 changes: 43 additions & 0 deletions .github/workflows/build-deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Build and deploy docs

on:
pull_request:
branches:
- main
push:
branches:
- main
workflow_dispatch: # manually triggered

jobs:
build:
name: Build docs website
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 10
run_install: |
- args: [--frozen-lockfile]

- name: Setup node
uses: actions/setup-node@v4
with:
node-version: 22
cache: 'pnpm'

- name: Build docs website
run: pnpm build

- name: Deploy to GitHub Pages
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
45 changes: 0 additions & 45 deletions .github/workflows/build-docs.yml

This file was deleted.

54 changes: 0 additions & 54 deletions .github/workflows/deploy-docs.yml

This file was deleted.

6 changes: 3 additions & 3 deletions docs/composedb/core-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ type Posts @createModel(accountRelation: LIST, description: "A simple Post") {

#### Account to Model Relations

Any document can always be queried by its author's account using the required `accountRelation` property. See [Account to Model Relations](./guides/data-modeling/relations.mdx#account-to-model-relations) for more.
Any document can always be queried by its author's account using the required `accountRelation` property. See [Account to Model Relations](./guides/data-modeling/relations.mdx#account-to-model) for more.

##### Model

Expand All @@ -85,7 +85,7 @@ Let's query the `DisplayName` using the author's account:

#### Model to Account Relations

Enable a document to be queried by a referenced account using the `@accountReference` directive. See [Model to Account Relations](./guides/data-modeling/relations.mdx#model-to-account-relations) for more.
Enable a document to be queried by a referenced account using the `@accountReference` directive. See [Model to Account Relations](./guides/data-modeling/relations.mdx#model-to-account) for more.

##### Model

Expand Down Expand Up @@ -113,7 +113,7 @@ Let's query messages based on recipient using `@accountReference`:

#### Model to Model Relations

Enable a document to be queried by its relationship to other documents using the `@documentReference` and `@relationFrom` directives. See [Model to Model Relations](./guides/data-modeling/relations.mdx#model-to-model-relations) for more.
Enable a document to be queried by its relationship to other documents using the `@documentReference` and `@relationFrom` directives. See [Model to Model Relations](./guides/data-modeling/relations.mdx#model-to-model) for more.

##### Model

Expand Down
2 changes: 1 addition & 1 deletion docs/composedb/examples/tutorials-and-examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Looking for code samples, starter applications, and tutorials to kickstart your

## Starter Applications

- [**Official ComposeDB Example App**](https://github.com/ceramicstudio/ComposeDbExampleApp) - A starter application built around a social media platform use-case (this application utilizes the same data models used by the [ComposeDB Sandbox](/docs/composedb/sandbox)). A great first step if you haven't done anything with ComposeDB yet.
- [**Official ComposeDB Example App**](https://github.com/ceramicstudio/ComposeDbExampleApp) - A starter application built around a social media platform use-case. A great first step if you haven't done anything with ComposeDB yet.
- [**Lit Protocol with ComposeDB**](https://github.com/ceramicstudio/lit-composedb) - Encrypt and decrypt data based on on-chain condition logic using Lit Protocol while storing on ComposeDB
- [**Ethereum Attestation Service on ComposeDB**](https://github.com/ceramicstudio/ceramic-eas) - Save attestations generated using the Ethereum Attestation Service to the Ceramic Network using ComposeDB.
- [**OpenAI Realtime Chat with ComposeDB**](https://github.com/ceramicstudio/ceramic-ai) - Interact with an OpenAI API endpoint in the form of a realtime chat application with storage on ComposeDB.
Expand Down
1 change: 0 additions & 1 deletion docs/composedb/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ ComposeDB on Ceramic stores and manages data while delivering fast queries and a

## How to Get Started

- [**See how it works**](./sandbox) - Explore the ComposeDB Sandbox, a web-based environment to interact with ComposeDB. Run some queries, interact with data, learn about the core concepts.
- [**Create your first Ceramic app**](./create-ceramic-app) - As easy as running `npx create-ceramic-app`, run your first local Ceramic app and start diving into code.
- [**Set up your environment**](./set-up-your-environment) - Learn how to set up your development environment to start building with ComposeDB. Experience the real Ceramic network, either on the testnet or mainnet.
- [**Create your composite**](./create-your-composite) - Learn how to create your first composite, a reusable data model that can be used across different applications.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ docker run -d \

### Editing the `daemon.config.json` file

To have the settings persist in your Ceramic node, edit the `daemon.config.json` file to include the configurations. The default location is `~/.ceramic/daemon.config.json`. For a full file example, see the [Ceramic](../../../protocol/js-ceramic/guides/ceramic-nodes/running-cloud#example-daemonconfigjson) docs.
To have the settings persist in your Ceramic node, edit the `daemon.config.json` file to include the configurations. The default location is `~/.ceramic/daemon.config.json`. For a full file example, see the [Ceramic](./server-configurations#default-configurations) docs.

```bash
...
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,16 +192,14 @@ Only Postgres is currently supported for production usage.
| remote | IPFS running in separate compute process; recommended for production and everything besides early prototyping | ✅ |

### Persistent Storage
To run a Ceramic node in production, it is critical to persist the [Ceramic state store](../../../protocol/js-ceramic/guides/ceramic-nodes/running-cloud#ceramic-state-store) and the [IPFS datastore](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#datastorespec). The form of storage you choose should also be configured for disaster recovery with data redundancy, and some form of snapshotting and/or backups.
To run a Ceramic node in production, it is critical to persist the [Ceramic state store](#ceramic-state-store) and the [IPFS datastore](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#datastorespec). The form of storage you choose should also be configured for disaster recovery with data redundancy, and some form of snapshotting and/or backups.

**Loss of this data can result in permanent loss of Ceramic streams and will cause your node to be in a corrupt state.**

The Ceramic state store and IPFS datastore are stored on your machine's filesystem by default. The Ceramic state store defaults to `$HOME/.ceramic/statestore`. The IPFS datastore defaults to `ipfs/blocks` located wherever you run IPFS.

The fastest way to ensure data persistence is by mounting a persistent volume to your instances and configuring the Ceramic and IPFS nodes to write to the mount location. The mounted volume should be configured such that the data persists if the instance shuts down.

You can also use AWS S3 for data storage which is supported for both Ceramic and IPFS. Examples of the configuration are shared on the Ceramic docs [here](../../../protocol/js-ceramic/guides/ceramic-nodes/running-cloud#example-aws-s3-policies).

### IPFS Datastore

The IPFS datastore stores the raw IPFS blocks that make up Ceramic streams. To prevent data corruption, use environment variables written to your profile file, or otherwise injected into your environment on start so that the datastore location does not change between reboots.
Expand Down
5 changes: 1 addition & 4 deletions docs/composedb/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ Thank you for being a ComposeDB pioneer and understanding that great Web3 protoc
### [Get Started →](./getting-started)
Build a Hello World application and interact from the CLI.

### [ComposeDB Sandbox →](/docs/composedb/sandbox)
Test example queries to ComposeDB directly in your browser.

### [Development Guides →](./getting-started)
Learn about data modeling, application set up, and data interactions.
<!-- Server Config-->
Expand All @@ -49,4 +46,4 @@ Learn about data modeling, application set up, and data interactions.
Dive deeper into the ComposeDB protocol and its components.

### [Community →](../ecosystem/community.mdx)
Connect with the ComposeDB developer community.
Connect with the ComposeDB developer community.
Loading