git.iko.soy/urbit.org
on master help sign in
reorg the top
8873b31Galen Wolfe-Pauly
docs/introduction.mdnew file+9
compare with master
unifiedsplit
@@ -0,0 +1,9 @@
1+---
2+sort: 1
3+---
4+
5+# Introduction
6+
7+Install and boot an Urbit
8+
9+<list dataPath="docs/introduction"></list>
docs/introduction/getting-started.mdnew file+92
@@ -0,0 +1,92 @@
1+---
2+next: true
3+sort: 3
4+title: Getting started
5+---
6+
7+# Getting started
8+
9+<div class="row"><div class="col-md-8">
10+
11+On disk your Urbit is an append-only log and a checkpoint. Or, in simpler terms, a directory where we keep all of your Urbit’s state. We call this a ‘pier’.
12+
13+</div></div>
14+
15+## Initialize
16+
17+When you first start an Urbit we create this pier directory and write to it.
18+
19+To start with a planet (`~fintud-macrep`) and ticket (`~fortyv-tombyt-tabsen-sonres`):
20+
21+ bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
22+
23+This will create a directory `fintud-macrep/` and begin the initialization process for that planet. Be patient, it can take a few minutes.
24+
25+Without a planet anyone can create a comet:
26+
27+ bin/urbit -c comet
28+
29+This will create a directory `any-name/` and start up a random 64-bit comet.
30+
31+## Orientation
32+
33+When your Urbit is finished booting you should see a `dojo>` prompt. Welcome!
34+
35+By default your Urbit is quite bare bones. Let's take a very short stroll through what's running by default:
36+
37+### `:dojo`
38+
39+The command prompt in front of you is a simple shell and Hoon REPL. Let's make sure it works:
40+
41+ ~fitund-macrep:dojo> (add 2 2)
42+
43+Should produce:
44+
45+ > (add 2 2)
46+ 4
47+
48+Good.
49+
50+### `:talk`
51+
52+Use `^X` to change your prompt. Let's join the main Urbit chat channel:
53+
54+ ~fitund-macrep:talk() ;join ~doznec/urbit-meta
55+
56+This may take a bit as `:talk` is stateful so your Urbit will download some backlog. `/urbit-meta` is the place to ask questions, get help and talk about anything Urbit related.
57+
58+### `:tree`
59+
60+Urbit is also accessible through the web. Try opening:
61+
62+ http://localhost:8080/
63+
64+in your favorite browser. You'll be prompted to use `+code`. This page was generated by `:tree`, the basic Urbit web interface. You can also access your Urbit through `http://fintud-macrep.urbit.org` (where `fintud-macrep` is your planet name).
65+
66+### `%clay`
67+
68+`%clay`, the Urbit filesystem, isn't mounted to unix by default. Switch to the `:dojo` prompt and run:
69+
70+ ~fitund-macrep:dojo> |mount %
71+
72+This should produce:
73+
74+ > |mount %
75+ >=
76+
77+which indicates the command was processed.
78+
79+`|mount %` will cause a `home/` directory to appear inside your pier folder. Changes to these files are automatically synced into your Urbit.
80+
81+## Learn more
82+
83+We go into much greater detail about each of these components in our walkthroughs:
84+
85+#### [`:dojo`]()
86+#### [`:talk`]()
87+#### [`:tree`]()
88+#### [`%clay`]()
89+#### [`Administration`]()
90+#### [`Source guide`]()
91+
92+If you're eager to simply start programming, skip to [the Hoon tutorial]()
docs/setup/install.md → docs/introduction/install.mdrenamed+7−3
@@ -1,14 +1,18 @@
1---
1---
2next: true
2next: true
3−sort: 1
3+sort: 2
4title: Install
4title: Install
5---
5---
6
6
7# Install
7# Install
8
8
9+<div class="row"><div class="col-md-8">
10+
9Urbit is designed to run on any Unix box with an internet connection. Debian, OS X, FreeBSD and Fedora all work well.
11Urbit is designed to run on any Unix box with an internet connection. Debian, OS X, FreeBSD and Fedora all work well.
10
12
11−Urbit is alpha software. It’s not yet completely stable, its crypto hasn’t been audited and there are plenty of rough edges. Just so you know what you're getting into.
13+Urbit is alpha software. It’s not yet completely stable, its crypto hasn’t been audited and there are plenty of rough edges. Urbit is lots of fun to play with, but not quite ready for your important or sensitive data. Just so you know what you're getting into.
14+
15+</div></div>
12
16
13## Build from source
17## Build from source
14
18
@@ -72,4 +76,4 @@ Once your dependencies are installed the rest is easy:
72 make
76 make
73 curl -o urbit.pill https://bootstrap.urbit.org/latest.pill
77 curl -o urbit.pill https://bootstrap.urbit.org/latest.pill
74
78
75−After running `make` your Urbit executable lives at `bin/urbit`. The `.pill` file is a compiled binary of Arvo that Urbit uses to bootstrap itself.
79+After running `make` your Urbit executable lives at `bin/urbit`. The `.pill` file is a compiled binary of Arvo that Urbit uses to bootstrap itself.
docs/orientation/system-overview.md → docs/introduction/system-overview.mdrenamed+4
@@ -6,12 +6,16 @@ title: System overview
6
6
7# System Overview
7# System Overview
8
8
9+<div class="row"><div class="col-md-8">
10+
9Urbit is a clean-slate system software stack defined as a
11Urbit is a clean-slate system software stack defined as a
10deterministic computer. An encrypted P2P network, `%ames`, runs
12deterministic computer. An encrypted P2P network, `%ames`, runs
11on a functional operating system, Arvo, written in a strict,
13on a functional operating system, Arvo, written in a strict,
12typed functional language, Hoon, which compiles itself to a
14typed functional language, Hoon, which compiles itself to a
13combinator interpreter, Nock, whose spec gzips to 340 bytes.
15combinator interpreter, Nock, whose spec gzips to 340 bytes.
14
16
17+</div></div>
18+
15## Architectural overview
19## Architectural overview
16
20
17A deterministic computer? Urbit's state is a pure function of
21A deterministic computer? Urbit's state is a pure function of
docs/orientation.mddeleted−9
@@ -1,9 +0,0 @@
1−---
2−sort: 1
3−---
4−
5−# Orientation
6−
7−Want to know how the system fits together? Start here.
8−
9−<list dataPath="docs/orientation"></list>
docs/setup.mddeleted−9
@@ -1,9 +0,0 @@
1−---
2−sort: 2
3−---
4−
5−# Setup
6−
7−Get an Urbit installed and running.
8−
9−<list dataPath="docs/setup"></list>
docs/setup/getting-started.mddeleted−43
@@ -1,43 +0,0 @@
1−---
2−next: true
3−sort: 2
4−title: Getting started
5−---
6−
7−# Getting started
8−
9−On disk your Urbit is an append-only log and a checkpoint. Or, in simpler terms, a directory where we keep all of your Urbit’s state. We call this a ‘pier’.
10−
11−## Initialize
12−
13−When you first start an Urbit we create this pier directory and write to it.
14−
15−To start with a planet (`~fintud-macrep`) and ticket (`~fortyv-tombyt-tabsen-sonres`):
16−
17− bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
18−
19−This will create a directory `fintud-macrep/` and begin the initialization process for that planet. Be patient, it can take a few minutes.
20−
21−Without a planet anyone can create a comet:
22−
23− bin/urbit -c comet
24−
25−This will create a directory `any-name/` and start up a random 64-bit comet.
26−
27−## Orientation
28−
29−When your Urbit is finished booting you should see a `dojo>` prompt.
30−
31−## Shutdown
32−
33−You can turn your Urbit off with `^D` from the `dojo>` prompt.
34−
35−## Restart
36−
37−To restart your Urbit simply pass the name of your pier:
38−
39− bin/urbit some-planet
40−
41−or
42−
43− bin/urbit comet
docs/walkthroughs/admin.mdnew file+37
@@ -0,0 +1,37 @@
1+---
2+next: true
3+sort: 2
4+title: Administration
5+---
6+
7+# Administration
8+
9+## Shutdown
10+
11+You can turn your Urbit off with `^D` from the `dojo>` prompt.
12+
13+## Restart
14+
15+To restart your Urbit simply pass the name of your pier:
16+
17+ bin/urbit some-planet
18+
19+or
20+
21+ bin/urbit comet
22+
23+## Moving your pier
24+
25+Piers are designed to be portable, but it must be done while the Urbit is turned off. Urbit networking is stateful, so you can't run two copies of the same Urbit in two places.
26+
27+To move a pier, simply move the contents of the directory it lives in. To keep these files as small as possible we usually use the `--sparse` option in `tar`. With a pier `fintud-macrep/` something like this (from inside `urbit/`) should work:
28+
29+ tar -Scvzf fintud-macrep.tar.gz ./fintud-macrep/
30+
31+## Continuity breaches
32+
33+While the Urbit network is in this alpha state we sometimes have to reboot the whole network. This happens either when major changes need to be shipped or we hit a bug that can't be fixed over the air.
34+
35+Because Urbit networking is stateful we call this a 'continuity breach'. Everything has to be restarted from scratch. Your pier will continue to function, but it wont connect to the rest of the Urbit network.
36+
37+When this happens, back up any files you'd like to save, shut down your Urbit and recreate your it (as if you were starting for the first time).
docs/orientation/repo-guide.md → docs/walkthroughs/repo-guide.mdrenamed

The content is the same.