on master help sign in
Merge branch '2018-era-draft' of github.com:urbit/docs into 2018-era-draft
commit764d8c7dbd66a690bd7e9c1911d38c1e08dea24d authorMorgan Sutherland <morgan@morgansutherland.com> dateSun 13 Jan 2019, 21:11 (8 years ago) parentdcca7af00f3572
6 files changed+69−148
getting-started/installation.udon+61−51 introduction.udon+7 introduction/whyurbit.udon−88 learn/azimuth/introduction/blockchain.udon → learn/azimuth/blockchain.udon+1−1 learn/azimuth/introduction.udon−7 learn/azimuth/introduction/wallet.udon → learn/azimuth/wallet.udon−1
getting-started/installation.udon+61−51
@@ -34,19 +34,9 @@ Points are generally not freely available, so you will need to either
3434purchase one or get one from a friend. This guide assumes you have found a way
3535to acquire a point.
3636
37−To get Urbit address space, you'll need two things: an Ethereum address and a
38−person willing to send you the Urbit address space.
39−
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`.
46−
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
49−the form of a PDF.
37+If you went through the address registration process and used [Wallet Generator](https://github.com/urbit/urbit-wallet-generator),
38+then you should have have received a .zip file that contains an Ethereum address
39+and cryptographic secrets in the form of a PDF.
5040
5141Your ownership PDF contains two secrets that must be kept safe.
5242
@@ -64,13 +54,17 @@ Your ownership PDF contains two secrets that must be kept safe.
6454==
6555
6656Bridge 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
68−that can be run in Firefox on all platforms, and also in Chrome if you're using
57+Like Wallet Generator, Bridge is a web application that can also be run in offline mode.
58+It can be run in Firefox on all platforms, and also in Chrome if you're using
6959a Mac.
7060
71−Importantly, Bridge also automates the process of generating the keyfile that
72−you will need a single time to boot your ship on the Arvo network. Once a ship
73−is booted, it isn't booted again. It stays booted forever.
61+Importantly, Bridge also allows you to generate a keyfile that
62+you will need to boot your ship on the Arvo network for the first time. Once a ship
63+with a keyfile, you can restart it later without the keyfile.
64+
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.
7468
7569Download bridge [here](https://github.com/urbit/bridge/releases) and follow
7670the instructions below.
@@ -87,41 +81,47 @@ On the dropdown menu, make sure that `Main Network` is selected. Then click
8781#### Step 3: Open a Wallet
8882
8983On 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
91−your Ethereum wallet's BIP39 Mnemonic.
84+If you aren't using a hardware wallet (we support Ledger and Trezor), you'll
85+want to use your Ethereum wallet's BIP39 Mnemonic.
9286
93−If you received a point from Tlon and received paper wallets in the form of
94−PDFs, choose `Urbit Master Ticket`.
87+If you used Wallet Generator to generate an HD wallet, you have a few choices:
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!).
9591
9692Select the appropriate option and click `Continue ->`.
9793
98−#### Step 4: Accept Your Transfer
94+#### Step 4: (optional) Accept Your Transfer
9995
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
10197`Incoming Transfers`. Click the `Details ->` link under that graphic.
10298
10399Now you'll be on the management page of your point. The transfer isn't completed
104100yet, so click `Accept incoming transfer`. Then check both boxes and and click
105101their associated `Sign Transaction` and `Send Transaction` buttons.
106102
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.
108105
109−You'll be returned to your point screen. Notice that that links and buttons
110−are now clickable. You know own this point!
106+#### Step 5: (optional) Set Your Networking Keys
111107
112−Click the link that says `Set Urbit networking keys`. Choose two different,
113−64-character long strings of hexademical, check the box, and, like before, check
114−both boxes and press both buttons.
108+If you just accepted a point, you'll be returned to your point screen. Notice that
109+that links and buttons are now clickable. You now own this point!
115110
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.
117116
118−Return to your point by clicking its name at the navigation bar on the top of
119−the page.
117+#### Step 6: Generate Your Keyfile
120118
121−Click the `Generate Urbit Keyfile` button and you'll be taken to a page with a
122−field titled `Network key`. That field should be filled in already. Click
123−`Generate ->`, which will download a the keyfile onto your machine.
119+From the detail page associated with your point, click the `Generate Urbit Keyfile`
120+button and you'll be taken to a page with a field titled `Network key`. If you went
121+through the address registration process, this should be filled in already.
122+Click `Generate ->`, which will download a keyfile onto your machine.
124123
124+With that keyfile in hand, you can now exit Bridge.
125125
126126;=
127127 ;h2
@@ -129,14 +129,18 @@ field titled `Network key`. That field should be filled in already. Click
129129 ==
130130==
131131
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!
133+
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`
133137
134−Arvo can only run on a Unix-like operating system -- Ubuntu,
135−Fedora, macOS, and FreeBSD all work well. If you're using Windows, you'll need
138+Arvo runs nicely on a Unix-like operating system -- Ubuntu,
139+Fedora, macOS, and FreeBSD. If you're using Windows, you'll need
136140to get one of the aforementioned systems. Don't worry: most of them are free.
137141
138142We 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.
140144
141145On any platform, you can check your Arvo installation by running the `urbit`
142146command. Installation was successful if you get a block of output that begins
@@ -148,7 +152,7 @@ Urbit: a personal server operating function
148152
149153#### MacOS
150154
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.
152156
153157```
154158#Bash
@@ -254,7 +258,7 @@ If you just want to use a fake ship for development purposes, you can now use
254258the command of the scheme below to boot a fake `~zod`.
255259
256260```
257−urbit -F zod -A /path/to/arvo -s -c zod -S
261+urbit -F zod -A /path/to/arvo -s -c zod
258262```
259263
260264If you want to get on the Arvo network with your point, then continue to the
@@ -263,20 +267,20 @@ next section.
263267
264268;=
265269 ;h2
266− ;div(id "boot"): Booting Your Urbit
270+ ;div(id "boot"): Booting Your Ship
267271 ==
268272==
269273
270274
271275Now 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.
273277
274278#### Step 1: Find Your Point's Name
275279
276280This will look something like `~lodleb-ritrul`. You can see the name of your
277281point(s) when you log into your wallet using the Bridge client.
278282
279−;img@"media.urbit.org/site/bridge-0.png"(width "100%");
283+;img@"http://media.urbit.org/site/bridge-0.png"(width "100%");
280284
281285#### Step 2: Find the path to your keyfile
282286
@@ -296,6 +300,13 @@ keyfile:
296300urbit -w ~sample-planet -k path/to/my-planet.key
297301```
298302
303+if you'd prefer to copy your key in you can run
304+
305+```
306+urbit -w ~sample-planet -G rAnDoMkEy
307+```
308+
309+
299310This will create a directory called `sample-planet/` and begin building your
300311ship. It may take a few minutes.
301312
@@ -346,22 +357,21 @@ This should produce:
346357which indicates that the command was processed.
347358
348359`|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.
350361
351362
352363#### Talk
353364
354365Use `ctrl-x` to toggle between the Dojo and the Talk prompts.
355366
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`:
357368
358369```
359−~sample-planet:talk[] ;join /urbit-meta
370+~sample-planet:talk[] ;join /urbit-help
360371```
361372
362−Talk is stateful, so your ship will download a backlog. `/urbit-meta` is the
363−place to ask questions, get help, talk about anything Urbit-related, and meet
364−everyone on here.
373+Talk is stateful, so your ship will download a backlog. `/urbit-help` is the
374+place to ask questions about getting up and running.
365375
366376#### Shutting Down and Restarting
367377
introduction.udon+7
@@ -7,6 +7,7 @@
77
88# Introduction
99
10+<<<<<<< HEAD
1011Welcome to the documentation for the Urbit project, including the Azimuth identity layer, the Arvo operating system, and the Hoon programming language. This documentation is maintained by [Tlon](https://tlon.io) in a public [Github repository](https://github.com/urbit/docs). Issues and contributions are welcome.
1112
1213The documentation is organized into four high-level sections, and further divided between Azimuth and Arvo. Read on to get acquainted.
@@ -38,3 +39,9 @@ If you're a developer looking for Arvo reference documentation, this section is
3839
3940- Confused about all the new words? Check out the [Glossary](docs/reference/glossary).
4041- Don't miss the helpful Hoon rune [Cheat Sheet](docs/reference/cheat-sheet).
42+=======
43+Urbit is a new software stock for
44+
45+Learn more about the Urbit project here before delving deeper into the developer
46+documentation.
47+>>>>>>> 00f3572eae751223638daa96d6689323ec024b2a
introduction/whyurbit.udondeleted−88
@@ -1,88 +0,0 @@
1−:- :~ title/'Why Urbit Uses a Blockchain'
2− sort/'5'
3− ==
4−;>
5−
6−# Why Urbit Uses a Blockchain
7−
8−Urbit is a network of personal servers. These personal servers, called ships,
9−are stateful, deterministic virtual machines that run on Unix boxes, usually in
10−the cloud.
11−
12−One of the core innovations of Urbit is its system of consistent and trustable
13−online identities. So every ship has an associated secure identity, called a
14−point, that it needs to connect to the network. Your point is your name, your
15−network address, and your cryptographic signature. Apoint can be thought of
16−unified digital identity that performs the functions of a Google login, an IP
17−address, a domain name, and a PGP keypair.
18−
19−There are a limited number of possible points, and such scarcity gives points
20−value. This means that bad actors -- spammers, scammers, and malware-spreaders
21−-- can be made economically unviable. Points can assign reputation information
22−to other points, and can use this information to decide who to treat as a
23−trusted peer.
24−
25−Having one identity for your digital life also means that all the services that
26−you trust recognize you. You no longer need to worry about managing dozens of
27−different logins, or about identity theft. When you’re on a ship, you’re always
28−verified on the Urbit network thanks to its associated identity.
29−
30−But we need a way to secure these identities. To that end, we have built a
31−public-key infrastructure (PKI) called Azimuth on the Ethereum blockchain.
32−Azimuth acts as a decentralized ledger for points: it determines which Ethereum
33−addresses own which points. It’s separate from and parallel to the Urbit
34−network.
35−
36−In theory, our ecosystem doesn’t need a blockchain, because Urbit identities are
37−more like real estate than currency: they change hands slowly. A low-friction,
38−zero-trust solution to the double-spend problem isn’t an economic necessity. So
39−we could have the Urbit network run its own key-signing system. But, since Urbit
40−identities are valuable, you don’t want to put them in an self-hosted PKI that
41−isn’t generally recognized as secure.
42−
43−Moving the Urbit land registry to Ethereum is an easy and obvious solution to
44−this problem. We chose Ethereum over Bitcoin because the former is built for
45−computation and the latter is not. We need a computational blockchain to enforce
46−the specific rules of the Urbit identity registry.
47−
48−# The Urbit HD Wallet
49−
50−The Urbit HD Wallet's derivation paths also have this hierarchical structure, so that keys with different powers can be physically separated. A "master ticket" can re-derive the entire wallet in case of loss. The encryption and authentication keys that Urbit points use to sign messages within the network are also derived from the wallet.
51−
52−The Urbit HD Wallet is not one key-pair, but a system of related key-pairs that each have distinct powers, from setting networking keys for communicating in the Urbit network to transferring ownership of your Azimuth address space (your point).
53−
54−Urbit HD wallets are composed of the following items, which are each assigned to their own individual Ethereum key-pairs.
55−
56−Master Ticket
57−
58−Think of your master ticket like a very high value password. The master ticket is the secret code from which all of your other keys are derived. Technically, your master ticket is seed entropy. You should never share it with anyone, and store it very securely. This ticket can derive all of your other keys: your ownership key and all of the related proxies.
59−
60−Ownership Address
61−
62−An ownership address has all rights over the assets deeded to it. These rights are on-chain actions described and implemented in the Constitution, Urbit’s Ethereum smart contracts.
63−
64−Proxies
65−
66−Proxy addresses allow you to execute non-ownership related actions like spawning child points, voting, and setting networking keys without jeopardizing the keys you've designated with ownership rights. Setting proxy rights is optional, but it is recommended for on-chain actions you will execute more frequently.
67−
68−Management Proxy
69−
70−Can configure or set Urbit networking keys and conduct sponsorship related operations.
71−
72−Voting Proxy
73−
74−Galaxies only. Galaxies are the part of the galactic senate, and this means they can cast votes on new proposals including changes to the Constitution.
75−
76−Spawn Proxy
77−
78−For stars and galaxies only. Can create new child points.
79−
80−Most Ethereum tokens use the ERC-20 standard for smart contracts. Azimuth points are, however, essentially different from most Ethereum tokens, due to points not being fungible. Since any two stars will handle social-networking realities in a different way, they will carry a different reputation. Points are to houses as tokens are to gold.
81−
82−The ERC-721 standard, having been made specifically to provide a smart-contract interface for non-fungible assets, serves our needs well. This is the standard that we use for deeding Azimuth points.
83−
84−Points, and all of their blockchain operations, are governed by the Urbit Constitution. The Constitution is an Ethereum smart-contract that governs point state and the ownership, spawn, management, and voting rights affiliated with your points.
85−
86−For the technical implementation details of both the ERC-721 protocol and Urbit-specific contract details, take a look at the Constitution section of our documentation. [hyperlink]
87−
88−If you don’t understand the contents of this page, that’s ok. We know that the Urbit PKI isn’t the easiest thing to understand, so we made a page. Our [get started with Azimuth] section will walk you through the entire process of assigning your points to Ethereum addresses.
learn/azimuth/introduction/blockchain.udon → learn/azimuth/blockchain.udonrenamed+1−1
@@ -22,7 +22,7 @@ who to treat as a trusted peer.
2222At the user level, having one identity for your digital life means that all the
2323services that you trust recognize you. You no longer need to worry about
2424managing dozens of different logins. When you're using Arvo, everything you do
25−is \"verified" in the sense that it links back to your point.
25+is "verified" in the sense that it links back to your point.
2626
2727But wait! We need some way to secure these identities. To that end, we have
2828built a public-key infrastructure (PKI) called _Azimuth_ on the Ethereum
learn/azimuth/introduction.udondeleted−7
@@ -1,7 +0,0 @@
1−:- :~ title/'Introduction'
2− ==
3−;>
4−
5−# Introduction
6−
7−[PLACEHOLDER]
learn/azimuth/introduction/wallet.udon → learn/azimuth/wallet.udonrenamed−1
@@ -55,7 +55,6 @@ it is recommended for on-chain actions you will execute more frequently.
5555
5656 For stars and galaxies only. Can create new child points.
5757
58−
5958;img@"https://media.urbit.org/fora/proposals/UP-8.jpg";
6059
6160