From 6442492117edd5384b7a799257dea4ed188862d2 Mon Sep 17 00:00:00 2001 From: Reckless_Satoshi Date: Mon, 16 May 2022 15:35:32 -0700 Subject: [PATCH] Add quick-start documentation: access robosats --- docs/_data/navigation.yml | 8 +-- docs/_includes/improve | 6 +++ docs/_includes/wip | 2 +- .../docs/00-quick-start/01-lightning.md | 2 +- docs/_pages/docs/00-quick-start/02-tor.md | 2 +- docs/_pages/docs/00-quick-start/03-access.md | 50 +++++++++++++++++++ 6 files changed, 63 insertions(+), 7 deletions(-) create mode 100644 docs/_includes/improve create mode 100644 docs/_pages/docs/00-quick-start/03-access.md diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 7238695a..65d42c84 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -14,12 +14,12 @@ docs: children: - title: "    Lightning Network" url: /docs/lightning/ - - title: "    TOR Network" + - title: "   TOR Network" url: /docs/tor/ - title: "    Access" url: /docs/access/ - - title: " Best Practices" + - title: " Best Practices" url: /docs/best-practices/ children: - title: "    PGP Encryption" @@ -31,12 +31,12 @@ docs: - title: "    Lightning Channels" url: /docs/channels/ - - title: " Features" + - title: " Features" url: /docs/features/ children: - title: "    Private" url: /docs/privacy/ - - title: "    Bonds & Escrow" + - title: "      Bonds & Escrow" url: /docs/bonds-escrow/ - title: "    Swaps" url: /docs/swaps/ diff --git a/docs/_includes/improve b/docs/_includes/improve new file mode 100644 index 00000000..a3dc1c9f --- /dev/null +++ b/docs/_includes/improve @@ -0,0 +1,6 @@ +### You can help improve this page! + +Learn.RoboSats is a joint effort of the RoboSats community. + +**ProTip:** You can directly edit [the content of this page ](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/{{page.src}}) and open a [Pull Request ](https://github.com/Reckless-Satoshi/robosats/pulls), your changes will show right here. +{: .notice--primary} \ No newline at end of file diff --git a/docs/_includes/wip b/docs/_includes/wip index af035ff8..234b8ae8 100644 --- a/docs/_includes/wip +++ b/docs/_includes/wip @@ -7,7 +7,7 @@ This page is under construction. Learn.RoboSats is a joint effort of the RoboSat ### You can complete this page! -**ProTip:** You can directly edit [the content of this page ]({{page.src}}) and open a [Pull Request ](https://github.com/Reckless-Satoshi/robosats/pulls), your changes will show right here. +**ProTip:** You can directly edit [the content of this page ](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/{{page.src}}) and open a [Pull Request ](https://github.com/Reckless-Satoshi/robosats/pulls), your changes will show right here. {: .notice--primary} If you have already used RoboSats, you are an expert! If you understand how it works behind the scenes, you are a master! Please, consider contributing to the Learn.RoboSats' guides and platform documentation. \ No newline at end of file diff --git a/docs/_pages/docs/00-quick-start/01-lightning.md b/docs/_pages/docs/00-quick-start/01-lightning.md index cafa02ca..a577f3c5 100644 --- a/docs/_pages/docs/00-quick-start/01-lightning.md +++ b/docs/_pages/docs/00-quick-start/01-lightning.md @@ -5,6 +5,6 @@ permalink: /docs/lightning/ sidebar: title: " Lightning Network" nav: docs -src: "https://github.com/Reckless-Satoshi/robosats/blob/main/docs/_pages/docs/00-quick-start/01-lightning.md" +src: "_pages/docs/00-quick-start/01-lightning.md" --- {% include wip %} \ No newline at end of file diff --git a/docs/_pages/docs/00-quick-start/02-tor.md b/docs/_pages/docs/00-quick-start/02-tor.md index 243425e7..b63f8303 100644 --- a/docs/_pages/docs/00-quick-start/02-tor.md +++ b/docs/_pages/docs/00-quick-start/02-tor.md @@ -5,6 +5,6 @@ permalink: /docs/tor/ sidebar: title: " TOR" nav: docs -src: "https://github.com/Reckless-Satoshi/robosats/blob/main/docs/_pages/docs/00-quick-start/02-tor.md" +src: "_pages/docs/00-quick-start/02-tor.md" --- {% include wip %} \ No newline at end of file diff --git a/docs/_pages/docs/00-quick-start/03-access.md b/docs/_pages/docs/00-quick-start/03-access.md new file mode 100644 index 00000000..7e8deb97 --- /dev/null +++ b/docs/_pages/docs/00-quick-start/03-access.md @@ -0,0 +1,50 @@ +--- +layout: single +title: "Accessing RoboSats" +permalink: /docs/access/ +toc: true +toc_sticky: true +sidebar: + title: " Access" + nav: docs +src: "_pages/docs/00-quick-start/03-access.md" +--- + +## Privately with TOR +The safest and most private way to use RoboSats is through the Onion address. You need [Tor Browser](/docs/tor/). + +> [robosats6tkf3eva7x2voqso3a5wcorsnw34j
veyxfqi2fu7oyheasid.onion](http://robosats6tkf3eva7x2voqso3a5wcorsnw34jveyxfqi2fu7oyheasid.onion/) + + +## Unsafe in Clearnet +There is an unsafe way to view RoboSats without TOR that relies on third party tor2web services. With this URL you can access RoboSats from any browser, but using this URL is highly unrecommended! + +> [unsafe.robosats.com](https://unsafe.robosats.com) + +Take it for granted: if you use that link, you are being spied on. However, most sensitive tools will be disabled (e.g. the chat) to avoid users giving away sensitive personal data. + +## All in one + +In order to more easily remember how to access, we have set up robosats.com . If you are using Tor Browser, it will directly take you to the Onion Site. Otherwise, it will take you to the unsafe site. + +> [robosats.com](https://robosats.com) + +#### Testnet +You can practice and test all of the functionalities in RoboSats without of losing funds by using [Testnet Bitcoin](https://en.bitcoin.it/wiki/Testnet). All you need is a Testnet Lightning wallet and access the testnet platform + +> [robotestagw3dcxmd66r4rgksb4nmmr43fh7
7bzn2ia2eucduyeafnyd.onion](http://robotestagw3dcxmd66r4rgksb4nmmr43fh77bzn2ia2eucduyeafnyd.onion/) + +Or unsafely on the testnet clearnet bridge. + +> [unsafe.testnet.robosats.com](http://unsafe.testnet.robosats.com) + +#### Clearnet Mirrors +There are several tor2web services that serve as mirrors in case one of them is unavailable + +> [unsafe.robosats.com](https://unsafe.robosats.com/)
+> [unsafe2.robosats.com](https://unsafe2.robosats.com/)
+> [unsafe3.robosats.com](https://unsafe3.robosats.com/)
+> [unsafe.testnet.robosats.com](http://unsafe.testnet.robosats.com/)
+> [unsafe2.testnet.robosats.com](http://unsafe2.testnet.robosats.com/) + +{% include improve %}