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

Update Oasis Docs #739

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

Update Oasis Docs #739

wants to merge 4 commits into from

Conversation

3xz1
Copy link

@3xz1 3xz1 commented Feb 19, 2024

Summary of Changes:

This pull request addresses crucial documentation updates in two sections: paratime-client-node.mdx and system-configuration.mdx. Issue #731

paratime-client-node.mdx Updates:

A new section titled "Configuring for Confidential States" has been included to guide users through enabling access to confidential states on their ParaTime Client Node using SGX. This addition emphasizes the importance of configuring the node to interact securely with sensitive data and ensures users are aware of the specific settings required for proper functionality.

system-configuration.mdx Updates:

The documentation now emphasizes the significance of adding SGX permissions for running a ParaTime Node or a ParaTime Client Node with SGX support. It instructs users to add the oasis user to the sgx group to grant access to SGX resources, crucial for the proper functioning of the nodes.

Requested Updates:

Detailed steps have been provided in both sections to facilitate users in implementing the necessary configurations.

ISSUE TYPE:

Documentation Improvements

COMPONENT NAME:

oasis docs.

Copy link

netlify bot commented Feb 19, 2024

Deploy Preview for oasisprotocol-docs failed.

Name Link
🔨 Latest commit 74246ab
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-docs/deploys/65d31a68e9df540008664a42

allowed_queries:
- all_expensive: true
sgx_loader: /node/bin/oasis-core-runtime-loader

Copy link
Member

Choose a reason for hiding this comment

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

Missing closing ``` ticks?


```bash
sudo usermod -aG sgx oasis

Copy link
Member

Choose a reason for hiding this comment

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

Missing closing ``` ticks?

@@ -208,6 +208,32 @@ Before using this configuration you should collect the following information to
* You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]).
* `{{ runtime_orc_path }}`: Path to the [ParaTime bundle](paratime-client-node.mdx#the-paratime-bundle) of the form `/node/runtimes/foo-paratime.orc`.
* You can find the current Oasis-supported ParaTimes in the Network Parameters page ([Mainnet], [Testnet]).
## Configuring for Confidential States
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Configuring for Confidential States
## Configuring for Confidential States

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants