on master help sign in
adds guide to breaches (#683)

* guide to breaches * guide to breaches * guide to breaches

commitd0b726c09ca9f3fe1961c82e4c62227799253f7b authorrmariani <robert@tlon.io> dateFri 25 Oct 2019, 16:48 (7 years ago) parent99c77f1
2 files changed+44−8
tutorials/guide-to-breaches.md+34 tutorials/ship-troubleshooting.md+10−8
tutorials/guide-to-breaches.mdnew file+34
@@ -0,0 +1,34 @@
1++++
2+title = "Guide to Breaches"
3+weight = 10
4+template = "doc.html"
5++++
6+
7+An important concept on the Arvo network is that of continuity. Continuity refers to ships remember the order of its own network messages and the network messages of others -- these messages are numbered, starting from zero. A _breach_ is when ships on the network agree to forget about this sequence and treat one or more ships like they are brand new.
8+
9+There are two kinds of breaches: **personal breaches** and **network breaches**.
10+
11+## Personal Breaches
12+
13+Ships on the Arvo network sometimes need to reset their continuity. A personal breach is when an individual ship announces to the network: "I forgot who I am, let's start over from scratch." That is, it clears its own event log and sends an announcement to the network, asking all ships that have communicated with it to reset its networking information in their state. This makes it as though the ship was just started for the first time again, since everyone has network has forgotten about it.
14+
15+Personal breaches often fix connectivity issues, but should only be used as a last resort. To perform a personal breach, follow the steps below.
16+
17+- Go to [bridge.urbit.org](https://bridge.urbit.org) and log into your identity.
18+- Under the "Admin" section, cycle your keys in bridge with the "breach" box checked.
19+- Download your new key.
20+- Delete or archive your old pier.
21+- Create a new pier by booting your ship with your new key.
22+- Rejoin your favorite chat channels and subscriptions.
23+
24+## Network Breaches
25+
26+A network breach is an event where all ships on the network are required to update to a new continuity era. The current continuity era is determined by a value in Ames, our networking module, that is incremented when a network; only ships with the same such value are able to communicate with one another. So network breaches happen when an Arvo update is released that is too large to release over the air.
27+
28+If a network breach is happening, follow the steps below.
29+
30+- Delete your old Urbit binary.
31+- Delete or archive your old pier.
32+- Download the new Urbit binary by following the instructions in the [Install page](https://urbit.org/using/install/).
33+- Create a new pier by booting your ship with your key, according to the instructions on the install page. (Note: You do _not_ need to use new a new key to boot into a new continuity era.)
34+- Rejoin your favorite chat channels and subscriptions.
tutorials/ship-troubleshooting.md+10−8
@@ -19,7 +19,9 @@ Urbit is still in the development stage, so there's a chance that your ship won'
1919
2020An ounce of prevention is worth a pound of cure, so let's first go over some best practices to keep your ship in working order.
2121
22−### Only boot with your keyfile once.** Once your ship is booted with your keyfile, you should never use that same keyfile again. If you do boot with the same keyfile twice, any other ship on the network that your ship has communicated with will never be able to talk to it again.
22+### Only boot with your keyfile once
23+
24+Once your ship is booted with your keyfile, you should never use that same keyfile again. If you do boot with the same keyfile twice, any other ship on the network that your ship has communicated with will never be able to talk to it again.
2325
2426If you accidentally booted with the same keyfile twice, the only remedy is performing a [personal breach](#personal-breach), which is explained in the next section.
2527
@@ -27,22 +29,22 @@ If you accidentally booted with the same keyfile twice, the only remedy is perfo
2729
2830Urbit is stateful, meaning that it needs to hold onto all your data. If you delete your pier and start your ship again, you won't be able to talk to any ship you've talked to before. The only solution to this is performing a [personal breach](#personal-breach)
2931
30−### Keep track of the directory that you put your ship in.
32+### Keep track of the directory that you put your ship in
3133
3234When you first start your ship, you should make sure you put it a place where you can find it again and where it won't get accidentally deleted. Remember that you must perform `|mount %` in your ship's Dojo to make your ship visible as a directory in the Unix file system.
3335
34−### Avoid killing the Urbit process directly.
36+### Avoid killing the Urbit process directly
3537The best way to end an urbit process is to use `ctrl-d` from the Dojo. Unix methods to kill the process, such as with `ctrl-z` or with the `kill` Bash command, or simply closing the window, should only be used if `ctrl-d` does not work.
3638
37−### Keep up-to-date builds.
39+### Keep up-to-date builds
3840
3941Check for latest Urbit version at https://github.com/urbit/urbit/releases. If you're behind, update using [this guide](/operations/)
4042
41−### `|hi` your star to see if you're connected.
43+### `|hi` your star to see if you're connected
4244
4345Find out who your star is by running `(sein:title our now our)` in the Dojo. Then, run `|hi ~star`, where `~star` is the star's name, and if things are working properly, you should get the message `hi ~star successful`. It could also be helpful to use `|hi` to check connectivity with `~zod` or another planet that you're in a Talk channel with.
4446
45−### Turn your ship off and on again.
47+### Turn your ship off and on again
4648
4749Use `ctrl-d` to gracefully exit your ship, and then start it again. This can solve many issues.
4850
@@ -64,9 +66,9 @@ So for example, to silence all Ames packet-related errors, try `|knob %hole %hus
6466
6567### Perform a personal breach. {#personal-breach}
6668
67−A breach is when ships on the network reset their continuity. The breaching ship clears its own event log and sends an announcement to the network, asking all ships that have communicated with it to reset its networking information in their state. This makes it as though the ship was just started for the first time again, since everyone has network has forgotten about it.
69+A personal breach is when a ship tells all the other ships that have communicated with it to treat it as though the ship was just started for the first time again, since everyone has network has forgotten about it.
6870
69−Personal breaches often fix connectivity issues, but should only be used as a last resort.
71+Personal breaches often fix connectivity issues, but should only be used as a last resort. To find out how to perform a personal breach, check out our [Guide to Breaches](../guide-to-breaches).
7072
7173## Operation Issues {#operation-issues}
7274