Skip to content

[docs]: add configuration reference #397

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

Merged
merged 86 commits into from
Apr 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
15d9ea4
[misc]: update deps
0x009922 Aug 30, 2023
6b17267
[style]: remove brand colors and `SButton`; revert prettier
0x009922 Aug 30, 2023
d13775b
[refactor]: use headless dialog; revert plugin-pwa
0x009922 Sep 1, 2023
793959a
[chore]: disable `vue/no-v-html` in Mermaid
0x009922 Sep 1, 2023
122f05f
[refactor]: remove sora components from MermaidRender
0x009922 Sep 1, 2023
c472637
[chore]: format
0x009922 Sep 1, 2023
6bd761d
[chore]: remove `@soramitsu-ui/*` packages
0x009922 Sep 1, 2023
15f8e10
[refactor]: remove `vite-plugin-pwa`
0x009922 Sep 1, 2023
6d39164
[docs]: introduce "Reference" section
0x009922 Sep 8, 2023
6a9e6dd
[chore]: remove logo temporarily
0x009922 Sep 8, 2023
1d091a7
Merge branch 'service-update' into 392-draft-config-reference
0x009922 Sep 8, 2023
29736bd
[chore]: fix ffi link
0x009922 Sep 8, 2023
c88c48e
[chore]: update deps
0x009922 Sep 11, 2023
17fc897
[refactor]: simplify logging, remove `log-update`
0x009922 Sep 11, 2023
e123ac0
Merge branch 'service-update' into 392-draft-config-reference
0x009922 Sep 11, 2023
f6bb470
[docs]: change headings
0x009922 Sep 11, 2023
e2ecaa7
[docs]: format chores
0x009922 Sep 11, 2023
6786935
Merge remote-tracking branch 'hyperledger/main' into service-update
0x009922 Sep 15, 2023
ce9bf11
[chore]: update pnpm
0x009922 Sep 15, 2023
5828496
[fix]: remove `SSpinner` import
0x009922 Sep 15, 2023
134a275
[chore]: bump vitepress
0x009922 Sep 15, 2023
de585ca
[fix]: fix version of unocss
0x009922 Sep 15, 2023
4bafdab
[chore]: fix format
0x009922 Sep 15, 2023
cd0cede
[chore]: bump vitepress to `rc.14`
0x009922 Sep 18, 2023
1fe2a67
Merge branch 'service-update' into 392-draft-config-reference
0x009922 Sep 18, 2023
cbe8885
[docs]: use tex math syntax across
0x009922 Sep 18, 2023
13fe5ce
[docs]: move `/reference/` to `/api/`; split config reference
0x009922 Sep 18, 2023
5e2265a
[docs]: describe duration type
0x009922 Sep 18, 2023
eff21b2
[docs]: describe byte size type
0x009922 Sep 18, 2023
18b614b
[docs]: remove `*.actor-channel-capacity`
0x009922 Sep 18, 2023
32008ad
[fix]: dead links
0x009922 Sep 18, 2023
2adbbf9
[docs]: restore `snake_case`
0x009922 Sep 20, 2023
cfabb36
[docs]: update config reference
0x009922 Sep 21, 2023
6d88337
Merge branch 'main' into 392-draft-config-reference
0x009922 Sep 21, 2023
c9e4fcf
[chore]: remove dead code
0x009922 Sep 21, 2023
07fd463
Apply suggestions from code review
0x009922 Sep 22, 2023
60edf4e
Apply suggestions from code review
yamkovoy Sep 26, 2023
a0bc81f
[docs]: use TODO marks
0x009922 Sep 27, 2023
b1c7ef8
[docs]: add Snapshot section
0x009922 Sep 27, 2023
12a026d
Merge remote-tracking branch '0x009922/392-draft-config-reference' in…
0x009922 Sep 27, 2023
2db62aa
[chore]: fix format
0x009922 Sep 27, 2023
08532e0
[docs]: change TODO notation
0x009922 Sep 27, 2023
bb938ef
Merge branch 'main' into 392-draft-config-reference
0x009922 Sep 27, 2023
35a0974
Apply suggestions from code review
0x009922 Sep 29, 2023
5b3dd60
Merge branch 'main' into 392-draft-config-reference
0x009922 Sep 29, 2023
0efcf1c
[docs]: put TODOs
0x009922 Sep 29, 2023
ea286e6
Merge remote-tracking branch '0x009922/392-draft-config-reference' in…
0x009922 Sep 29, 2023
9dd1a49
[chore]: remove dead sidebar link
0x009922 Sep 29, 2023
76b850c
[docs]: expand logger params
0x009922 Sep 29, 2023
38dd466
[docs]: expand sections, update naming, rethink structure
0x009922 Sep 29, 2023
6688e80
Apply suggestions from code review
0x009922 Oct 2, 2023
d5d1156
[docs]: refactor the reference
0x009922 Oct 4, 2023
e9aa302
[chore]: fix typo and format
0x009922 Oct 4, 2023
fc9bd81
[docs]: combine sumeragi and block_sync
0x009922 Oct 4, 2023
2750023
Merge branch 'main' into 392-draft-config-reference
0x009922 Oct 10, 2023
df7415b
[docs]: torii bindings
0x009922 Oct 10, 2023
bde027d
Apply suggestions from code review
0x009922 Oct 20, 2023
b86a04c
Update src/api/config/sumeragi-params.md
0x009922 Oct 23, 2023
5e5582a
bunch of updates
0x009922 Nov 3, 2023
b9177e7
Merge remote-tracking branch 'hyperledger/main' into 392-draft-config…
0x009922 Nov 3, 2023
0d949c6
Merge remote-tracking branch '0x009922/392-draft-config-reference' in…
0x009922 Nov 3, 2023
f74845e
[docs]: fix broken link
0x009922 Nov 3, 2023
99698dd
[docs]: a bunch of edits of config
0x009922 Nov 22, 2023
7d9c926
[docs]: update configuration guides (wip)
0x009922 Nov 22, 2023
128e675
Merge branch 'main' into 392-draft-config-reference
0x009922 Nov 22, 2023
2be984d
Merge branch 'main' into 392-draft-config-reference
0x009922 Feb 12, 2024
4c78fe2
[chore]: update deps
0x009922 Feb 12, 2024
8841a0b
[chore]: `type: module`, fixing warning from Vitest
0x009922 Feb 12, 2024
3d26c72
[revert]: project is not ready for ESM
0x009922 Feb 12, 2024
c704b6f
Merge branch 'housekeeping' into 392-draft-config-reference
0x009922 Feb 12, 2024
a96fa91
[docs]: update reference section
0x009922 Feb 21, 2024
b21c68e
[docs]: migration guide; edits
0x009922 Mar 25, 2024
cfe5ae4
[revert]: remove `Specs` component
0x009922 Mar 25, 2024
dfd5498
[feat]: add sidebar link
0x009922 Mar 25, 2024
ca2f813
[chore]: fix format
0x009922 Mar 25, 2024
eb231f3
misc: update dependencies
0x009922 Nov 7, 2024
aae25ba
Merge branch 'housekeeping' into 392-draft-config-reference
0x009922 Nov 7, 2024
9fe82b7
docs: revamp config reference
0x009922 Nov 8, 2024
1e3b453
Merge branch 'main' into 392-draft-config-reference
0x009922 Nov 8, 2024
39cfe97
docs: fix links
0x009922 Nov 8, 2024
790686a
docs: complete structure of config reference & related docs
0x009922 Nov 13, 2024
1f1c868
docs: chores
0x009922 Nov 13, 2024
a44d9b4
chore: fix format
0x009922 Nov 13, 2024
dd64c4a
Merge branch 'main' into 392-draft-config-reference
0x009922 Apr 7, 2025
16b5b31
docs: update config, reflect logger changes, chores
0x009922 Apr 7, 2025
54b1b72
chore: format
0x009922 Apr 7, 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
68 changes: 33 additions & 35 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// <reference types="vite/client" />

import { defineConfig, DefaultTheme } from 'vitepress'
import { DefaultTheme, defineConfig } from 'vitepress'
import footnote from 'markdown-it-footnote'
import { resolve } from 'path'
import ViteSvgLoader from 'vite-svg-loader'
Expand Down Expand Up @@ -28,7 +28,7 @@ function nav(): DefaultTheme.NavItem[] {
{
text: 'Reference',
link: '/reference/torii-endpoints',
activeMatch: '/reference/',
activeMatch: '^/reference/',
},
{
text: 'Help',
Expand Down Expand Up @@ -93,6 +93,10 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
text: 'JavaScript',
link: '/guide/tutorials/javascript',
},
{
text: 'Compatibility Matrix',
link: '/reference/compatibility-matrix',
},
],
},
{
Expand All @@ -103,18 +107,6 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
text: 'Configure Iroha',
collapsed: true,
items: [
{
text: 'Configuration Types',
link: '/guide/configure/configuration-types',
},
{
text: 'Samples',
link: '/guide/configure/sample-configuration',
},
{
text: 'Peer Configuration',
link: '/guide/configure/peer-configuration',
},
{
text: 'Client Configuration',
link: '/guide/configure/client-configuration',
Expand Down Expand Up @@ -307,10 +299,10 @@ function sidebarChain(): DefaultTheme.SidebarItem[] {
]
}

function sidebarAPI(): DefaultTheme.SidebarItem[] {
function sidebarReference(): DefaultTheme.SidebarItem[] {
return [
{
text: 'About',
text: 'Reference',
items: [
{
text: 'Glossary',
Expand All @@ -320,23 +312,6 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
text: 'Naming Conventions',
link: '/reference/naming.md',
},
{
text: 'Compatibility Matrix',
link: '/reference/compatibility-matrix',
},
{
text: 'Foreign Function Interfaces',
link: '/reference/ffi',
},
],
},
{
text: 'Reference',
items: [
{
text: 'Torii Endpoints',
link: '/reference/torii-endpoints.md',
},
{
text: 'Data Model Schema',
link: '/reference/data-model-schema',
Expand All @@ -357,6 +332,30 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
text: 'Binaries',
link: '/reference/binaries.md',
},
{
text: 'irohad CLI',
link: '/reference/irohad-cli.md',
},
{
text: 'Torii HTTP API',
link: '/reference/torii-endpoints.md',
},
{
text: 'Foreign Function Interfaces',
link: '/reference/ffi',
},
{
text: 'Peer Configuration',
link: '/reference/peer-config/index.md',
items: [
{ text: 'Parameters', link: '/reference/peer-config/params.md' },
{ text: 'Migration from pre-rc.20', link: '/reference/peer-config/migration.md' },
],
},
{
text: 'Genesis Block',
link: '/reference/genesis.md',
},
],
},
]
Expand Down Expand Up @@ -473,13 +472,12 @@ export default defineConfig({
},

nav: nav(),
outline: [2, 3],

sidebar: {
'/get-started/': sidebarStart(),
'/guide/': sidebarGuide(),
'/blockchain/': sidebarChain(),
'/reference/': sidebarAPI(),
'/reference/': sidebarReference(),
'/help/': sidebarHelp(),
},

Expand Down
37 changes: 31 additions & 6 deletions .vitepress/theme/style/index.scss
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
@import url('https://fonts.googleapis.com/css2?family=Sora:[email protected]&display=swap');
@import url("https://fonts.googleapis.com/css2?family=Sora:[email protected]&display=swap");

:root {
--vp-font-family-mono: 'JetBrains Mono', 'Fira Code', Menlo, Monaco, Consolas, 'Courier New', monospace;
--vp-font-family-base: 'Sora', 'Inter', ui-sans-serif, system-ui, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji';

--vp-font-family-mono:
"JetBrains Mono", "Fira Code", Menlo, Monaco, Consolas, "Courier New",
monospace;
--vp-font-family-base:
"Sora", "Inter", ui-sans-serif, system-ui, sans-serif, "Apple Color Emoji",
"Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";

--vp-c-brand-1: var(--vp-c-red-1);
--vp-c-brand-2: var(--vp-c-red-2);
--vp-c-brand-3: var(--vp-c-red-3);
Expand All @@ -15,7 +19,11 @@
color: var(--vp-c-text-1);
}

.VPSidebarItem.level-1 .text, .VPSidebarItem.level-2 .text, .VPSidebarItem.level-3 .text, .VPSidebarItem.level-4 .text, .VPSidebarItem.level-5 .text {
.VPSidebarItem.level-1 .text,
.VPSidebarItem.level-2 .text,
.VPSidebarItem.level-3 .text,
.VPSidebarItem.level-4 .text,
.VPSidebarItem.level-5 .text {
font-weight: 400 !important;
color: var(--vp-c-text-2);
}
Expand All @@ -25,7 +33,7 @@
}

.vp-doc {
div[class*='language-'] {
div[class*="language-"] {
pre {
font-size: 14px;
font-variant-ligatures: none;
Expand All @@ -44,4 +52,21 @@
line-height: 1.75;
font-weight: 300;
}

tr.transposed-table:nth-child(2n+1) {
background: var(--vp-c-bg-soft);

pre {
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
}
}

tr.transposed-table:nth-child(2n) {
background: transparent;
}

section.footnotes {
font-size: 0.8rem;
}
}
2 changes: 0 additions & 2 deletions etc/snippet-sources.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,9 @@ export default [
},
{
src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/docs/source/references/client.template.toml`,
filename: 'client-cli-config-template.toml',
},
{
src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/docs/source/references/peer.template.toml`,
filename: 'peer-config-template.toml',
},
{
src: `https://raw.githubusercontent.com/hyperledger-iroha/iroha/${IROHA_RC_1}/defaults/genesis.json`,
Expand Down
6 changes: 3 additions & 3 deletions src/blockchain/wasm.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ non-portable architecture and OS-specific static manner, but WASM is a
portable format. Since C ABI is the _lingua franca_ of the programming
world and there is no other stable Rust ABI (yet), Iroha relies on the
C-linkage to generate WASM bindings. Thankfully, `iroha_wasm` takes care of
everything related to [foreign function interfaces](/reference/ffi.md) (FFI), so
you don't have to worry about things like `unsafe`, `repr(C)`, padding,
alignment, and others.
everything related to [foreign function interfaces](/reference/ffi.md)
(FFI), so you don't have to worry about things like `unsafe`, `repr(C)`,
padding, alignment, and others.

The `iroha_wasm` crate contains all of the bindings, macros, and trait
implementations that you'd need to write the program, most notably the
Expand Down
3 changes: 1 addition & 2 deletions src/blockchain/world.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
consists of:

- Iroha [configuration parameters](/guide/configure/client-configuration.md)
- the list of
[trusted peers](/guide/configure/peer-configuration#trusted-peers)
- TODO: peers
- registered domains
- registered [triggers](/blockchain/triggers.md)
- registered
Expand Down
6 changes: 0 additions & 6 deletions src/guide/advanced/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@ This topic will be updated as part of the new configuration reference.
The progress on the configuration reference can be tracked in the following GitHub issue:\
[iroha-2-docs > Issue #392: Tracking issue for Configuration Reference as per RFC](https://github.com/hyperledger-iroha/iroha-2-docs/issues/392).

::: note

For examples, see [Sample Configuration Files](../configure/sample-configuration.md).

:::

After the above is configured, you can use the IP address set in the `"TORII_TELEMETRY_URL"` variable to access the metrics data from within a running Iroha instance.

**Example**:
Expand Down
17 changes: 4 additions & 13 deletions src/guide/advanced/running-iroha-on-bare-metal.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,12 @@ error-prone, particularly for exotic systems (Windows).
::: info

For this chapter, we assume you have learned about
[configuration](/guide/configure/sample-configuration.md) and
[management](/guide/configure/peer-management.md) in Iroha 2. Here we offer
you instructions to run Iroha on bare metal without going into details
about various configuration options available.

You can always check
[sample configuration files](/guide/configure/sample-configuration.md) for
`configs/peer/genesis.json` and `configs/peer/config.json`, or refer to
[peer configuration options](/guide/configure/peer-configuration.md) for
more details.
TODO extend with a relevant config guide

<!-- TODO: Add the new configuration reference, once its ready. Issue: https://github.com/hyperledger-iroha/iroha-2-docs/issues/392
The full list of available options is in the [Iroha Configuration Reference](https://github.com/hyperledger-iroha/iroha/blob/iroha2-dev/docs/source/references/config.md). -->

:::

Expand Down Expand Up @@ -448,13 +441,11 @@ Iroha in the real world.
```

3. Register your peer to a network, and make sure to add at least four of
the peers on that network to the
[`TRUSTED_PEERS`](/guide/configure/peer-configuration.md#trusted-peers)
the peers on that network to the trusted peers
array in your configuration file.

4. Determine the web socket that the other peers will use to connect to
you. Make sure that the port is open and use that address
([`P2P_ADDR`](/guide/configure/peer-configuration.md#p2p-addr)) in your
4. Determine the socket address that the other peers will use to connect to
you. Make sure that the port is open and use that address in your
`configs/peer/config.json` file.

5. After you have finished editing the configuration file, deploy Iroha by
Expand Down
Loading