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

Upddocumentation #74

Merged
merged 4 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
294 changes: 115 additions & 179 deletions README.md

Large diffs are not rendered by default.

Binary file added _diagrams/local_connection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions _diagrams/local_connection.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
@startuml
participant "Erigon Node" as Erigon
participant "Diagnostics cmd" as Diag
participant "Output" as Output

note right of Erigon
"./build/bin/erigon"
end note
Erigon -> Erigon: Run Erigon node

note right of Diag
"./build/bin/diag downloader"
end note
Diag -> Erigon: Query downloader data
Erigon -> Diag: Return queried data
Diag -> Output: Display data

@enduml
Binary file added _diagrams/remote_connection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions _diagrams/remote_connection.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
@startuml
participant "Erigon Node" as Erigon
participant "Diagnostics" as Diag
participant "Support Command" as Support
participant "UI" as UI

note right of Erigon
"./build/bin/erigon"
end note
Erigon -> Erigon: Run Erigon node

note right of Diag
"make run-self-signed"
end note
Diag -> Diag: Run Diagnostics

note right of UI
Automatically opens browser with default address
(address can be specified using flags)
end note
Diag -> UI: Serve UI

note right of UI
Creating diagnostics session to obtain PIN.
PIN is required for support command
end note
UI -> UI: Create diagnostics session

note right of Support
./build/bin/erigon support
end note
Support -> Erigon: Run support command to establish tunnel

Erigon <-> Diag: Create tunnel

UI -> Diag: Query data

Diag -> Erigon: Ask for data queried by UI

Erigon -> Diag: Return queried data

Diag -> UI: Return queried data

UI -> UI: Display data

@enduml
Binary file modified _images/peer_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/peers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/process/cmd_line.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/process/find_reorgs.png
Binary file not shown.
Binary file modified _images/process/flags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/process/node_info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/process/sync_stages.png
Binary file not shown.
Binary file modified _images/snapshot_sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading