Skip to content

feat: added information on How It Works to homepage #74

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.

Sign up for GitHub

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

Open
JosiahBull wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: added information on How It Works to homepage #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
414 changes: 414 additions & 0 deletions components/NetworkDiagram.vue
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions layout_diagram.drawio
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile host="Electron" modified="2022-10-28T02:28:21.451Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/20.3.0 Chrome/104.0.5112.114 Electron/20.1.3 Safari/537.36" etag="JY-eubgZ5rSOxCCBkuWV" version="20.3.0" type="device"><diagram id="39jZaSDva-AjaTIId7KA" name="Page-1">5Vtbk+IoFP41PrYVQm4+eum5VPVsdY0zOzNPW3SChp0YrARHnV+/YEgMIe2ktWNi75PhBBC+cz7OB+IATle79wlah59ogKOBaQS7AZwNTNMEtss/hGWfWTzgZIZlQoLMBI6GOfmNpdGQ1g0JcKpUZJRGjKxVo0/jGPtMsaEkoVu12oJG6reu0RJrhrmPIt36jQQslLMw3aP9AybLMP9m4IyyNyuUV5YzSUMU0G3JBO8HcJpQyrKn1W6KIwFejkvW7t0zb4uBJThmTRpsnDFzfPcp9b3JP6P1bBWE7A7aWTe/ULSRM5ajZfscgoRu4gCLXsAATrYhYXi+Rr54u+VO57aQrSL5OkBpWNRdRigV+Bv8uZi+KCxIFE1pRBNejmnMu5rIceCE4d2zMwQFbjzgMF1hlux5FdnAcSTUMtackSxvj54DeZ1Q8Zo0Ihkty6LvI6D8QWL6EnytN4RvQUqJr+Xq+FpmDb7QaQ1f2Ca+7cB4Z1ZgbBqmptcajOZLYDR6AaNpqTC6RlO2G63BCG4PRqsCo90DGI3bg7Eajc1hHLUFY65RSqjhgIsbWaQJC+mSxii6P1onKq7HOg+UriWA/2LG9lKpoQ2jKtZ4R9j30vMP0dXQtGVxtpNdHwr7vBDzCX8vF8rNRPnY7lDKG6YMJWwsdB43+CIdEj83vyNRPqgMCDH70+7lYNFN4uMTqErBxL9gidmJel59uCQ4Qoz8Usfx+q73+uN697TrFQ9KPpbdZ3TjvtGF7pNNHynhIyxWCVBRULbtDq2R2ks2BdmwrOcrffElRunLgabWVzZNrS8ON9qXqq1FhfTEsM3qsL2TQwPuZfUdqGxl+EM24iMhCpeczxFLT9Zf1xFFAbfx2MO1DHpAT3yDq0Q9isgyFqsPj0XMk8pE5BHCd5Bj+WJFgiAjGE7Jb/R06E+EtYSdd25PBvbsVCKS21vZeFBsKssUOLESPJu2jKHhQRk0F8Y2VFxYZJ+8A7pYpJhV3PoqjtS3sHOccAy5bbzEMvLP1g6vLBdyRpg18qBu69TazgnosI0DEfvzkM+iy/RhDO1yAmkoHIaFVPiR99dUN7SfdZyGWcfuUjQ4WkB8JmtGAh4MxjQiPWVS7SHPdZmk7046Yws4iy3GH9jyikzwrqS/LpPPTpce7WDn1P4K2NTvptWl4z1tCfyGn1Lq/xTKxfgoBN5CLG99Wgfz7UDl8Lt7hWHaN88it2csGt0Ei0Yaiz58+fJ4awRyQNcEAqP+CIs3IcOBewvqIx9lJQtxStwCbdzu8w7QcLombZS80zDtgIGSdnqWdXLv/ZE2WeR2xRtL/y34b4K3xXGeMcMMkSitjY7bO9g7TUtjCKAHFGbK0rnHfO0f5MFu891ZgrHC3L4JxsbU7TTj5b+dlpg7o9v4zR3Gw2dQLjgLoeEpnL27kLTFlZOrncabui+5euGGibiMJ07l+6dhHK93Gka/NzZDPOJQ2ksRaPXu8AHqp9lfD9FnfEJ+SGIdRj571t5iIvJOmqUgcFjyE/oTVxzRzgF57fUyo8YXsDVf6BuaqciKSLQcP358+6545pJQ3QVK76qe0Q88pVb+jH2yrv3N5606x6leQuicN5a+hl22+Ct3hMuXh9tKq3BoVwLeaZYXQGtXXS19MXq4f3//1+x/FOiO5hY91N2rRrq+Dj0m1MepvlnvgdpxjWpc24Ye13ULudUWgLauuqc0ZogLnQsV9xXuztbg6YBmidFuC0/9cth8nzK8EhsZAR+SX3KTf+TQAXdAQ8BfHsC8ePyTU7bLPP5VDN7/Bw==</diagram></mxfile>
24 changes: 24 additions & 0 deletions pages/index.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,30 @@
>.
</p>
</div>

<div class="body-text mt-5" >
<h2 class="mb-4 is-size-3 has-text-centered">How it works</h2>

<NetworkDiagram/>
<p>
Riptide relies on a server agent running locally on your machine as a
systemd service. This agent is responsible for managing the file
transfer and communicating with the Riptide server over a websocket
connection. When a downloader requests a file from you, the agent will
POST the file to the central server. The server will then begin to
stream the file to the downloader.
<br />
This process is entirely secure, running over https with complete
end-to-end encryption. Your server agent authenticates with a 256-bit
key, which is generated when you first install the agent. This key is
used for all authentication - so no one can pretend to be you or
upload a file.
<br/>
We are entirely open source, and hosting your own central-api is
encouraged for those who want maximum security.

</p>
</div>
</div>
</template>

Expand Down