Skip to content

docs: small fixes for v1.4.0 #636

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 29, 2025
Merged

docs: small fixes for v1.4.0 #636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aab1ba4
docs: fix some broken values in env-vars.md and and improve table for…
linconvidal Oct 29, 2025
54792ed
docs: fix page author info by updating fetch-depth in actions/checkou…
linconvidal Oct 29, 2025
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
2 changes: 2 additions & 0 deletions .github/workflows/deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ jobs:
working-directory: docs
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Copy OpenAPI spec
run: mkdir -p docs/static && cp api/src/main/resources/rosetta-specifications-1.4.15/api.yaml docs/static/api.yaml
Expand Down
28 changes: 21 additions & 7 deletions docs/docs/install-and-deploy/env-vars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ The root folder contains several example `.env` files for different deployment s
**Testing:**
- `.env.IntegrationTest` - Integration tests with yaci devkit

> **Note**: Hardware profile files should be used **in combination** with a base `.env.docker-compose` file to apply performance tuning settings. See the Hardware Profile Variables section below.
:::note
Hardware profile files should be used **in combination** with a base `.env.docker-compose` file to apply performance tuning settings. See the Hardware Profile Variables section below.
:::

## Main Environment Variables

<div class="env-vars-table">

| Variable | Description | Default | Notes |
|-----------------------------------------------|-----------------------------------------------------------------------|----------------------------------------|-------------------------|
| `LOG` | Log level | INFO | added in release 1.0.0 |
Expand All @@ -50,14 +54,14 @@ The root folder contains several example `.env` files for different deployment s
| `CARDANO_NODE_SUBMIT_HOST` | Cardano node submit API host | cardano-submit-api | added in release 1.0.0 |
| `NODE_SUBMIT_API_PORT` | Cardano node submit API port | 8090 | added in release 1.0.0 |
| `CARDANO_NODE_DIR` | Cardano node base directory | /node | added in release 1.0.0 |
| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket file path | ${CARDANO_NODE_DIR}/node.socket | added in release 1.0.0 |
| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket file path | /node/node.socket | added in release 1.0.0 |
| `CARDANO_NODE_DB` | Cardano node db path | /node/db | added in release 1.0.0 |
| `CARDANO_CONFIG` | Cardano node config path | ./config/node/${NETWORK} | added in release 1.0.0 |
| `CARDANO_CONFIG` | Cardano node config path | ./config/node/mainnet | added in release 1.0.0 |
| `MITHRIL_VERSION` | Mithril client version | 2524.0 | added in release 1.2.9 |
| `SNAPSHOT_DIGEST` | Mithril snapshot digest | latest | added in release 1.0.0 |
| `AGGREGATOR_ENDPOINT` | Mithril aggregator endpoint (uses default if not set) | | added in release 1.0.0 |
| `GENESIS_VERIFICATION_KEY` | Mithril genesis verification key (uses default if not set) | | added in release 1.0.0 |
| `ANCILLARY_VERIFICATION_KEY` | Mithril ancillary verification key (uses default if not set) | | added in release 1.2.9 |
| `AGGREGATOR_ENDPOINT` | Mithril aggregator endpoint (uses default if not set) | (empty) | added in release 1.0.0 |
| `GENESIS_VERIFICATION_KEY` | Mithril genesis verification key (uses default if not set) | (empty) | added in release 1.0.0 |
| `ANCILLARY_VERIFICATION_KEY` | Mithril ancillary verification key (uses default if not set) | (empty) | added in release 1.2.9 |
| `API_DOCKER_IMAGE_TAG` | Docker Tag for API Image | main | added in release 1.0.0 |
| `API_SPRING_PROFILES_ACTIVE` | API spring profile | staging | added in release 1.0.0 |
| `API_PORT` | Rosetta API exposed port | 8082 | added in release 1.0.0 |
Expand Down Expand Up @@ -101,15 +105,19 @@ The root folder contains several example `.env` files for different deployment s
| `POSTGRESQL_EXPORTER_PORT` | PostgreSQL exporter port for Prometheus | 9187 | added in release 1.3.0 |
| `PEER_DISCOVERY` | Enable peer discovery job for automatic peer refreshing | false | added in release 1.3.2 |
| `TOKEN_REGISTRY_ENABLED` | Enable token registry integration for native token metadata | false | added in release 1.4.0 |
| `TOKEN_REGISTRY_BASE_URL` | Base URL for the token registry API | | added in release 1.4.0 |
| `TOKEN_REGISTRY_BASE_URL` | Base URL for the token registry API | (empty) | added in release 1.4.0 |
| `TOKEN_REGISTRY_CACHE_TTL_HOURS` | Cache TTL for token metadata in hours | 12 | added in release 1.4.0 |
| `TOKEN_REGISTRY_LOGO_FETCH` | Enable fetching token logos from registry (increases response size) | false | added in release 1.4.0 |
| `TOKEN_REGISTRY_REQUEST_TIMEOUT_SECONDS` | Token registry request timeout in seconds | 2 | added in release 1.4.0 |

</div>

## Hardware Profile Variables

The following variables are available only in hardware profile configuration files (`.env.docker-compose-profile-*-level`).

<div class="env-vars-table">

| Variable | Description | Default (mid-level profile) | Notes |
|-----------------------------------------------|-----------------------------------------------------------------------|----------------------------------------|-------------------------|
| `API_DB_POOL_MIN_COUNT` | Minimum number of connections API↔DB | 150 | added in release 1.2.5 |
Expand All @@ -133,10 +141,14 @@ The following variables are available only in hardware profile configuration fil
| `DB_POSTGRES_BGWRITER_DELAY` | Delay between background writer cycles | 200ms | added in release 1.2.5 |
| `DB_POSTGRES_AUTOVACUUM_MAX_WORKERS` | Maximum number of autovacuum workers | 5 | added in release 1.4.0 |

</div>

## Deprecated Environment Variables (Previous Versions)

The following environment variables were available in previous versions but are no longer supported:

<div class="env-vars-table">

| Variable | Description | Default | Notes |
|-----------------------|-----------------------------------------------------------------|--------------------|-----------------------------------------------------------------------------------------------|
| `DB_IMAGE_NAME` | Postgres docker image name | postgres | available in releases 1.0.0 - 1.2.8, replaced by `PG_VERSION_TAG` in 1.2.9 |
Expand All @@ -145,3 +157,5 @@ The following environment variables were available in previous versions but are
| `PRUNING_SAFE_BLOCKS` | Number of recent blocks to keep spent UTXOs for (safety margin) | 2160 | available in releases 1.2.4 - 1.2.8, replaced by `REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT` |
| `PRUNING_INTERVAL` | Interval in seconds between pruning cleanup jobs | 600 | available in releases 1.2.4 - 1.2.8, no longer configurable |
| `LIMIT` | Search limit | 100 | available in releases 1.0.0 - 1.3.1, replaced by `SEARCH_LIMIT` in 1.3.2 |

</div>
48 changes: 46 additions & 2 deletions docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ const config = {
'**/_test-results/**', // Exclude directories with underscore prefix
],
},
blog: false, // Disable blog functionality
theme: {
customCss: './src/css/custom.css',
},
Expand Down Expand Up @@ -146,7 +147,7 @@ const config = {
{
label: 'API Reference',
route: '/cardano-rosetta-java/api',

configuration: {
url: '/cardano-rosetta-java/api.yaml',
hideDownloadButton: true,
Expand All @@ -166,7 +167,7 @@ const config = {
--scalar-font: 'Helvetica Neue', Helvetica, Arial, sans-serif;
}
`


},
},
Expand All @@ -180,6 +181,49 @@ const config = {
indexPages: true,
},
],
function suppressDrawioSvgWarnings() {
// Store original console methods
const originalWarn = console.warn;
const originalError = console.error;

// Filter function to check if message should be suppressed
// @ts-ignore
const shouldSuppress = (args) => {
const message = args[0]?.toString() || '';
return message.includes('.drawio.svg') ||
message.includes('unsupported file type');
};

return {
name: 'suppress-drawio-svg-warnings',
configureWebpack() {
// Patch console.warn and console.error
console.warn = function(...args) {
if (!shouldSuppress(args)) {
originalWarn.apply(console, args);
}
};

console.error = function(...args) {
if (!shouldSuppress(args)) {
originalError.apply(console, args);
}
};

return {
ignoreWarnings: [
(warning) => {
if (!warning.message) return false;
return (
warning.message.includes('.drawio.svg') ||
warning.message.includes('unsupported file type')
);
},
],
};
},
};
},
],
};

Expand Down
26 changes: 22 additions & 4 deletions docs/src/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -876,7 +876,8 @@ article th {
letter-spacing: 0.01em;
text-transform: uppercase;
font-size: 0.8rem;
padding: 1rem;
padding: 0.6rem 0.75rem;
line-height: 1.25;
background-color: var(--ifm-table-stripe-background, var(--grey-50));
color: var(--grey-1000);
border: none;
Expand All @@ -901,8 +902,8 @@ article tbody tr:hover {
background-color: rgba(0, 0, 0, 0); /* Hovered row remains normal */
}
article td {
padding: 0.9rem 1rem;
line-height: 1.4;
padding: 0.5rem 0.75rem;
line-height: 1.25;
vertical-align: middle;
border: none;
border-top: 1px solid var(--ifm-table-border-color, var(--grey-200));
Expand All @@ -928,6 +929,23 @@ article td:nth-child(3) {
font-size: 0.9rem;
}

/* Compact layout for environment variable tables */
.env-vars-table th,
.env-vars-table td {
padding: 0.35rem 0.6rem;
line-height: 1.2;
}

.env-vars-table th:last-child,
.env-vars-table td:last-child {
white-space: normal;
min-width: 0;
}

.env-vars-table td code {
padding: 0.05rem 0.3rem;
}

/* Dark Mode for Tables */
[data-theme='dark'] article table {
box-shadow: 0 0 0 1px rgba(255, 255, 255, 0.1);
Expand Down Expand Up @@ -1436,4 +1454,4 @@ details.alert--info summary h3 {
background: rgba(0, 224, 255, 0.07);
border-left: 2px solid var(--blue-1);
}