@@ -34,19 +34,9 @@ Points are generally not freely available, so you will need to either
34purchase one or get one from a friend. This guide assumes you have found a way
34purchase one or get one from a friend. This guide assumes you have found a way
35to acquire a point.
35to acquire a point.
37−To get Urbit address space, you'll need two things: an Ethereum address and a
37+If you went through the address registration process and used [Wallet Generator](https://github.com/urbit/urbit-wallet-generator),
38−person willing to send you the Urbit address space.
40−You'll probably want to start with a planet. Those are cheap identities for
41−everyday use. Find someone who is willing to part with a point: a friend or a
42−stranger selling address space via smart contract. Once they've sent the address
43−space, you can access it using our Bridge software, or any other interface for
44−the Ethereum blockchain. Make sure they send you the name of the point, which
45−looks something like `~lodleb-ritrul`.
47−If you bought address space from Tlon, then you should have have received a .zip
48−file that contains an Ethereum address and cryptographic secrets in
38+then you should have have received a .zip file that contains an Ethereum address
49−the form of a PDF.
39+and cryptographic secrets in the form of a PDF.
51Your ownership PDF contains two secrets that must be kept safe.
41Your ownership PDF contains two secrets that must be kept safe.
@@ -64,13 +54,17 @@ Your ownership PDF contains two secrets that must be kept safe.
66Bridge is client that we built for accessing and managing your Urbit identities.
56Bridge is client that we built for accessing and managing your Urbit identities.
67−Like Wallet Generator, Bridge comes in the form of an offline HTML application
57+Like Wallet Generator, Bridge is a web application that can also be run in offline mode.
68−that can be run in Firefox on all platforms, and also in Chrome if you're using
58+It can be run in Firefox on all platforms, and also in Chrome if you're using
71−Importantly, Bridge also automates the process of generating the keyfile that
61+Importantly, Bridge also allows you to generate a keyfile that
72−you will need a single time to boot your ship on the Arvo network. Once a ship
62+you will need to boot your ship on the Arvo network for the first time. Once a ship
73−is booted, it isn't booted again. It stays booted forever.
63+with a keyfile, you can restart it later without the keyfile.
65+*Note* Bridge allows you to make _writes_ to the blockchain, but we ask you to confirm
66+anything that will incur a transaction cost. If you plan to do anything heavy-duty, make
67+sure your Ethereum address has some pocket ETH.
75Download bridge [here](https://github.com/urbit/bridge/releases) and follow
69Download bridge [here](https://github.com/urbit/bridge/releases) and follow
76the instructions below.
70the instructions below.
@@ -87,41 +81,47 @@ On the dropdown menu, make sure that `Main Network` is selected. Then click
87#### Step 3: Open a Wallet
81#### Step 3: Open a Wallet
89On this dropdown menu, choose how you'd like to access your Ethereum wallet.
83On this dropdown menu, choose how you'd like to access your Ethereum wallet.
90−If you aren't using Hardware wallets (a Ledger or a Trezor), you'll want to use
84+If you aren't using a hardware wallet (we support Ledger and Trezor), you'll
91−your Ethereum wallet's BIP39 Mnemonic.
85+want to use your Ethereum wallet's BIP39 Mnemonic.
93−If you received a point from Tlon and received paper wallets in the form of
87+If you used Wallet Generator to generate an HD wallet, you have a few choices:
94−PDFs, choose `Urbit Master Ticket`.
88+you can choose `Urbit Master Ticket,` which is high-value, but allows you unfettered
89+permissions to update your point. The mnemonic associated with your management
90+seed is also useful to perform everyday operations (such as boot your ship!).
96Select the appropriate option and click `Continue ->`.
92Select the appropriate option and click `Continue ->`.
98−#### Step 4: Accept Your Transfer
94+#### Step 4: (optional) Accept Your Transfer
100−If you were sent a point, then you should see a graphic under
96+If you were sent a point by a friend, then you should see a graphic under
101`Incoming Transfers`. Click the `Details ->` link under that graphic.
97`Incoming Transfers`. Click the `Details ->` link under that graphic.
103Now you'll be on the management page of your point. The transfer isn't completed
99Now you'll be on the management page of your point. The transfer isn't completed
104yet, so click `Accept incoming transfer`. Then check both boxes and and click
100yet, so click `Accept incoming transfer`. Then check both boxes and and click
105their associated `Sign Transaction` and `Send Transaction` buttons.
101their associated `Sign Transaction` and `Send Transaction` buttons.
107−#### Step 5: Set Your Networking Keys
103+If you already own a point, then click on the `Details ->` under your sigil in the
104+`Your Points` section.
109−You'll be returned to your point screen. Notice that that links and buttons
106+#### Step 5: (optional) Set Your Networking Keys
110−are now clickable. You know own this point!
112−Click the link that says `Set Urbit networking keys`. Choose two different,
108+If you just accepted a point, you'll be returned to your point screen. Notice that
113−64-character long strings of hexademical, check the box, and, like before, check
109+that links and buttons are now clickable. You now own this point!
114−both boxes and press both buttons.
116−#### Step 6: Generate Your Keyfile
111+Click the link that says `Generate Urbit networking keys`. Bridge will let you either
112+download a keyfile derived from your networking keys are you can paste in your own
113+network seed and derive a new keyfile. See our
114+[HD Wallet Spec](https://github.com/urbit/proposals/blob/master/proposals/8.md)
115+for more information.
118−Return to your point by clicking its name at the navigation bar on the top of
117+#### Step 6: Generate Your Keyfile
119+From the detail page associated with your point, click the `Generate Urbit Keyfile`
121−Click the `Generate Urbit Keyfile` button and you'll be taken to a page with a
120+button and you'll be taken to a page with a field titled `Network key`. If you went
122−field titled `Network key`. That field should be filled in already. Click
121+through the address registration process, this should be filled in already.
123−`Generate ->`, which will download a the keyfile onto your machine.
122+Click `Generate ->`, which will download a keyfile onto your machine.
124+With that keyfile in hand, you can now exit Bridge.
@@ -129,14 +129,18 @@ field titled `Network key`. That field should be filled in already. Click
132−Now you're ready to install the Arvo software. You're almost there!
132+Now you're ready to run Arvo. You're almost there!
134+But first, some terminology:
135+- `vere` or `urbit`: the interpreter that runs when you run a command like `urbit` or `/bin/urbit` in your command line
136+- `arvo`: the deterministic OS that lives in a directory whose name matches your Azimuth point, ie `~famreb-todmec` lives in `/famreb-todmec`
134−Arvo can only run on a Unix-like operating system -- Ubuntu,
138+Arvo runs nicely on a Unix-like operating system -- Ubuntu,
135−Fedora, macOS, and FreeBSD all work well. If you're using Windows, you'll need
139+Fedora, macOS, and FreeBSD. If you're using Windows, you'll need
136to get one of the aforementioned systems. Don't worry: most of them are free.
140to get one of the aforementioned systems. Don't worry: most of them are free.
138We have different installation instructions for different platforms. To install
142We have different installation instructions for different platforms. To install
139−Arvo, run the Bash commands that are listed for your operating system.
143+and run Arvo, run the commands that are listed for your operating system.
141On any platform, you can check your Arvo installation by running the `urbit`
145On any platform, you can check your Arvo installation by running the `urbit`
142command. Installation was successful if you get a block of output that begins
146command. Installation was successful if you get a block of output that begins
@@ -148,7 +152,7 @@ Urbit: a personal server operating function
149#### MacOS
153#### MacOS
151−We recommend using the Homebrew package manager to install Arvo on MacOS.
155+We recommend using the Homebrew package manager to run Arvo on MacOS.
@@ -254,7 +258,7 @@ If you just want to use a fake ship for development purposes, you can now use
254the command of the scheme below to boot a fake `~zod`.
258the command of the scheme below to boot a fake `~zod`.
257−urbit -F zod -A /path/to/arvo -s -c zod -S
261+urbit -F zod -A /path/to/arvo -s -c zod
260If you want to get on the Arvo network with your point, then continue to the
264If you want to get on the Arvo network with your point, then continue to the
@@ -263,20 +267,20 @@ next section.
266− ;div(id "boot"): Booting Your Urbit
270+ ;div(id "boot"): Booting Your Ship
271Now the rubber meets the road. You'll be booting your ship with the keyfile
275Now the rubber meets the road. You'll be booting your ship with the keyfile
272−that you downloaded from bridge.
276+that you downloaded from Bridge.
274#### Step 1: Find Your Point's Name
278#### Step 1: Find Your Point's Name
276This will look something like `~lodleb-ritrul`. You can see the name of your
280This will look something like `~lodleb-ritrul`. You can see the name of your
277point(s) when you log into your wallet using the Bridge client.
281point(s) when you log into your wallet using the Bridge client.
279−;img@"media.urbit.org/site/bridge-0.png"(width "100%");
283+;img@"http://media.urbit.org/site/bridge-0.png"(width "100%");
281#### Step 2: Find the path to your keyfile
285#### Step 2: Find the path to your keyfile
@@ -296,6 +300,13 @@ keyfile:
296urbit -w ~sample-planet -k path/to/my-planet.key
300urbit -w ~sample-planet -k path/to/my-planet.key
303+if you'd prefer to copy your key in you can run
306+urbit -w ~sample-planet -G rAnDoMkEy
299This will create a directory called `sample-planet/` and begin building your
310This will create a directory called `sample-planet/` and begin building your
300ship. It may take a few minutes.
311ship. It may take a few minutes.
@@ -346,22 +357,21 @@ This should produce:
346which indicates that the command was processed.
357which indicates that the command was processed.
348`|mount %` will cause a `home/` directory to appear inside your _pier_ folder in
359`|mount %` will cause a `home/` directory to appear inside your _pier_ folder in
349−Unix. Changes to these files are automatically synced into your ship.
360+Unix (the "pier" is our shorthand for the directory whose name corresponds to your Azimuth point). Changes to these files are automatically synced into your ship.
354Use `ctrl-x` to toggle between the Dojo and the Talk prompts.
365Use `ctrl-x` to toggle between the Dojo and the Talk prompts.
356−While on the Talk prompt, let's join the main Urbit chat channel, `/urbit-meta`:
367+While on the Talk prompt, let's join the main Urbit support chat channel, `/urbit-help`:
359−~sample-planet:talk[] ;join /urbit-meta
370+~sample-planet:talk[] ;join /urbit-help
362−Talk is stateful, so your ship will download a backlog. `/urbit-meta` is the
373+Talk is stateful, so your ship will download a backlog. `/urbit-help` is the
363−place to ask questions, get help, talk about anything Urbit-related, and meet
374+place to ask questions about getting up and running.
366#### Shutting Down and Restarting
376#### Shutting Down and Restarting