Upddocumentation (#73)

* wp * created remote connection diagram * updated readme
erigontech · May 29, 2024 · a73e8b6 · a73e8b6
1 parent c580939
commit a73e8b6
Show file tree

Hide file tree

Showing 11 changed files with 161 additions and 179 deletions.
diff --git a/README.md b/README.md
diff --git a/_diagrams/remote_connection.png b/_diagrams/remote_connection.png
diff --git a/_diagrams/remote_connection.puml b/_diagrams/remote_connection.puml
@@ -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
diff --git a/_images/peer_details.png b/_images/peer_details.png
diff --git a/_images/peers.png b/_images/peers.png
diff --git a/_images/process/cmd_line.png b/_images/process/cmd_line.png
diff --git a/_images/process/find_reorgs.png b/_images/process/find_reorgs.png
diff --git a/_images/process/flags.png b/_images/process/flags.png
diff --git a/_images/process/node_info.png b/_images/process/node_info.png
diff --git a/_images/process/sync_stages.png b/_images/process/sync_stages.png
diff --git a/_images/snapshot_sync.png b/_images/snapshot_sync.png