Xray Graph Koios Tiny

https://github.com/xray-network/xray-graph-koios-tiny
Admin
A tool for fast and predictable deployment of the Koios (Cardano-Db-Sync) stack in a Docker...
Tokens:2,928
Snippets:15
Trust Score:6.6
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Dependencies

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Installs necessary system dependencies (zstd, jq, wget) required for snapshot restoration.

```console
sudo apt update && sudo apt install zstd jq wget -y
```

--------------------------------

### Koios API Status Check Examples

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Provides raw CURL examples to check the status of the Koios API endpoints for 'tip' and 'blocks'.

```console
curl 0.0.0.0:8050/rpc/tip
curl 0.0.0.0:8050/rpc/blocks
```

--------------------------------

### Integrate with Traefik Reverse Proxy

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Guides on setting up Traefik as a reverse proxy for the Koios stack. Involves cloning the Traefik Docker repository, starting Traefik, and then deploying Koios with Traefik integration using a specific docker-compose file and environment variables.

```console
git clone https://github.com/xray-network/traefik-docker.git \
&& cd traefik-docker \
&& docker compose up -d

NETWORK=mainnet \
POSTGRES_PASSWORD=your_secret_password \
BEARER_RESOLVER_TOKEN=your_access_token \
docker compose -f docker-compose.xray.yaml -p koios-tiny-mainnet up -d --build
```

--------------------------------

### Clone Repository

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Clones the xray-graph-koios-tiny repository and its submodules to prepare for installation.

```console
git clone \
  --recurse-submodules \
  https://github.com/xray-network/xray-graph-koios-tiny.git \
  && cd xray-graph-koios-tiny
```

--------------------------------

### Download Koios DB Snapshot

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Downloads the latest Mainnet Koios (cardano-db-sync) database snapshot.

```bash
wget 'https://share.koios.rest/api/public/dl/xFdZDfM4/dbsync/mainnet-dbsyncsnap-latest.tgz' -O ./snapshot/mainnet-dbsyncsnap-latest.tgz
```

--------------------------------

### Deploy Koios for Preview Network

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Deploys the Koios stack for the Preview network using Docker Compose. Allows customization of various ports and requires setting the PostgreSQL password.

```console
NETWORK=preview \
POSTGRES_PASSWORD=your_secret_password \
POSTGRES_PORT=5434 \
OGMIOS_PORT=1339 \
CARDANO_PORT=3002 \
KOIOS_PORT=8052 \
OGMIOS_PROXY_PORT=8702 \
RAPIDOC_KOIOS_PORT=2702 \
docker compose -f docker-compose.yaml -p koios-tiny-preview up -d --build
```

--------------------------------

### Deploy Koios for Preprod Network

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Deploys the Koios stack for the Preprod network using Docker Compose. Allows customization of various ports and requires setting the PostgreSQL password.

```console
NETWORK=preprod \
POSTGRES_PASSWORD=your_secret_password \
POSTGRES_PORT=5433 \
OGMIOS_PORT=1338 \
CARDANO_PORT=3001 \
KOIOS_PORT=8051 \
OGMIOS_PROXY_PORT=8701 \
RAPIDOC_KOIOS_PORT=2701 \
docker compose -f docker-compose.yaml -p koios-tiny-preprod up -d --build
```

--------------------------------

### Download Cardano Node DB Snapshot

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Downloads the latest Mainnet Cardano Node DB snapshot using wget and jq to parse the snapshot information.

```bash
wget -c -O - "https://downloads.csnapshots.io/mainnet/$(wget -qO- https://downloads.csnapshots.io/mainnet/mainnet-db-snapshot.json | jq -r .[].file_name)" | zstd -d -c | tar -x -C ./snapshots
```

--------------------------------

### Deploy Koios for Mainnet

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Deploys the Koios stack for the Mainnet using Docker Compose. Requires setting the network and PostgreSQL password.

```console
NETWORK=mainnet \
POSTGRES_PASSWORD=your_secret_password \
docker compose -f docker-compose.yaml -p koios-tiny-mainnet up -d --build
```

--------------------------------

### Koios API Documentation

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Provides access to the Koios API documentation through Rapidoc Playground and OpenAPI Schema. Includes links to the TypeScript client and original Koios resources.

```APIDOC
Koios API Documentation:
  Rapidoc Playground: https://graph.xray.app/output/services/koios/mainnet/api/v1/
  OpenAPI Schema (JSON): https://graph.xray.app/output/services/koios/mainnet/api/v1/openapi.json
  TypeScript Client: https://github.com/xray-network/cardano-koios-client
  Original Koios: https://koios.rest/
  Original Koios OpenAPI Schema: https://api.koios.rest/
```

--------------------------------

### Related Cardano Ecosystem Tools

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Lists essential tools and projects within the Cardano ecosystem that are relevant to the Xray Graph Koios Tiny project.

```APIDOC
Related Cardano Ecosystem Tools:
  Cardano-Db-Sync: https://github.com/IntersectMBO/cardano-db-sync/
  Ogmios: https://ogmios.dev/
  Traefik: https://traefik.io/traefik/
```

--------------------------------

### Restore Koios DB with Snapshot

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Restores the Koios database from a downloaded snapshot using Docker Compose. Requires the snapshot file to be present and specifies network and PostgreSQL password.

```console
RESTORE_SNAPSHOT=/snapshots/mainnet-dbsyncsnap-latest.tgz \
NETWORK=mainnet \
POSTGRES_PASSWORD=your_secret_password \
docker compose -f docker-compose.yaml -p koios-tiny-mainnet up -d --build
```

--------------------------------

### Register Custom RPCs and Cron Tasks

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Explains how to register custom SQL RPC files and shell scripts for cron jobs within the Koios container. Requires rebuilding the container with `--force-rebuild`.

```console
Place the `.sql` files in the `koios/extra-rpc` folder to register with Postgrest. Place the .sh files in `koios/extra-cron-jobs` and edit the `koios/cron-schedule`.

Then you must rebuild container with `--force-rebuild` command.
```

--------------------------------

### XRAY/Graph Koios Tiny API Documentation

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/rapidoc-koios/index.html

This section details the API for XRAY/Graph Koios Tiny. It outlines the structure and styling of the API documentation interface.

```APIDOC
rapi-doc {
  font-size: 14px;
}

rapi-doc::part(section-navbar) {
  border-right: 1px solid #dadde1;
  padding-top: 10px;
}

rapi-doc::part(section-header) {
  box-shadow: 0 1px 2px 0 #dadde1;
  position: relative;
  z-index: 100;
}

rapi-doc::part(label-header-title) {
  font-weight: bold;
}
```

--------------------------------

### Update Git Submodules

Source: https://github.com/xray-network/xray-graph-koios-tiny/blob/main/README.md

Updates all git submodules recursively, fetching the latest remote changes and merging them.

```bash
git submodule update --recursive --remote --merge
```
Tokens:
Raw