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

[docs]: New configuration reference #397

Open
wants to merge 75 commits into
base: main
Choose a base branch
from

Conversation

0x009922
Copy link
Contributor

@0x009922 0x009922 commented Sep 8, 2023

Related issue: #392

Checklist

  • Adapt old "Configuration and Management" articles to the new reference
  • Agree on the new configuration endpoints
  • Document configuration ISIs
  • Assign ENVs to parameters

Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
@0x009922 0x009922 self-assigned this Sep 8, 2023
@vercel
Copy link

vercel bot commented Sep 8, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
iroha-2-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 25, 2024 1:55am

Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
# Conflicts:
#	src/guide/configure/configuration-types.md
#	src/reference/torii-endpoints.md
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
@@ -0,0 +1,5 @@
# On-Chain Parameters

- These parameters are chain-wide, and each peer should have the same
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- These parameters are chain-wide, and each peer should have the same
- These parameters are chain-wide, meaning they are the same for each peer.

# On-Chain Parameters

- These parameters are chain-wide, and each peer should have the same
- It should not be specified in the config file: https://github.com/hyperledger/iroha/issues/4028
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- It should not be specified in the config file: https://github.com/hyperledger/iroha/issues/4028
- On-chain parameters should not be specified in the config file: https://github.com/hyperledger/iroha/issues/4028


## Type: Bytes Amount

Bytes amount is specified as a human-readable string:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Bytes amount is specified as a human-readable string:
The amount of bytes is specified as a human-readable string:

value4 = "1GB 5MB"
```

Iroha can parse sizes in bytes, kilobytes (`K`), megabytes (`M`), gigabytes (`G`), terabytes (`T`),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Iroha can parse sizes in bytes, kilobytes (`K`), megabytes (`M`), gigabytes (`G`), terabytes (`T`),
Iroha can parse sizes in bytes (`B`), kilobytes (`K`), megabytes (`M`), gigabytes (`G`), terabytes (`T`),


For more information on socket addresses and networking, refer to the [IANA Service Name and Transport Protocol Port Number Registry](https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml) or the [RFC 3986](https://tools.ietf.org/html/rfc3986) specification.

## Paths Resolution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Paths Resolution
## Path Resolution

that affects links

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, we can use custom anchors:

# Using custom anchors {#my-anchor}

Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
@0x009922
Copy link
Contributor Author

@BAStos525, you can preview the migration guide (#481) on the deployment (Reference > Config > Migration): link

[network]
address = "localhost:1337"
```

Copy link

@Erigara Erigara Apr 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess new param should go somewhere here:

Suggested change
## `network.idle_timeout` {#param-idle-timeout}
- **Type:** String or Number, [Duration](glossary#type-duration)
- **Default:** 60 seconds
Duration of time after which connection with peer is terminated if peer is idle.
```toml
[network]
idle_timeout = "60s"
```

@nxsaken nxsaken added the L-config Configuration, customization label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L-config Configuration, customization
Projects
None yet
Development

Successfully merging this pull request may close these issues.