git.iko.soy/urbit.org
on master help sign in
Install urbit-0.5.1
26f8729Keaton Dunsford
docs/using/install.md+31−33
compare with master
unifiedsplit
@@ -1,5 +1,6 @@
1---
1---
2navhome: /docs/
2navhome: /docs/
3+navuptwo: true
3next: true
4next: true
4sort: 1
5sort: 1
5title: Install
6title: Install
@@ -23,31 +24,16 @@ with us at [urbit.org/stream](https://urbit.org/stream).
23> lots of fun to play with, but not quite ready for your important or
24> lots of fun to play with, but not quite ready for your important or
24> sensitive data.
25> sensitive data.
25
26
26−## Packages
27+### Update: `~2017.12.7`
27
28
28−Urbit may be in your system's package repository — check there first. If not,
29+Urbit `0.5.1` is now live! We expect there to be a delay in getting our
29−we host packages for some platforms. If you'd prefer to install from source, see
30+updated `urbit-0.5.1` binary packages propagated to Homebrew, APT and
30−below.
31+the other various package managers. So for now, **please
32+build and install Urbit from source**. The instructions below will walk
33+you through how to do that. You'll then be free to continue the boot
34+and setup process as normal, per the rest of this Using docs section.
31
35
32−**Mac OS X (Homebrew)**
36+## Build from source
33−
34−- `brew update`
35−- `brew install urbit`
36−
37−**FreeBSD**
38−
39−- Download `urbit-0.4.3.txz` [here](https://media.urbit.org/dist/freebsd/urbit-0.4.3.txz).
40−- Install with `pkg install urbit-0.4.3.txz`
41−
42−**Debian**
43−
44−- Download `urbit_0.4.5-1_amd64.deb` [here](https://media.urbit.org/dist/debian/urbit_0.4.5-1_amd64.deb).
45−- Install with `dpkg -i urbit_0.4.5-1_amd64.deb`
46−- Then `apt-get install -f` to install any missing dependencies
47−
48−## Source
49−
50−First, fetch the source tarball: **[urbit-0.4.5.tar.gz](https://media.urbit.org/dist/src/urbit-0.4.5.tar.gz)**.
51
37
52### Dependencies
38### Dependencies
53
39
@@ -93,8 +79,8 @@ Which can usually be installed with the following one-liners:
93
79
94Once your dependencies are installed the rest is easy:
80Once your dependencies are installed the rest is easy:
95
81
96− $ tar xfvz urbit-0.4.5.tar.gz
82+ $ git clone https://github.com/urbit/urbit
97− $ cd urbit-0.4.5
83+ $ cd urbit
98 $ make # gmake on FreeBSD
84 $ make # gmake on FreeBSD
99
85
100After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
86After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
@@ -109,16 +95,28 @@ Test that it works:
109 urbit -w <myplanet> -t <myticket> if you have a ticket
95 urbit -w <myplanet> -t <myticket> if you have a ticket
110 urbit <myplanet or mycomet> to restart an existing urbit
96 urbit <myplanet or mycomet> to restart an existing urbit
111
97
98+### Boot your urbit
99+
100+And you're done! If you're running Urbit on a normal modern PC or Mac, or
101+on a large cloud instance, move onto the next [setup](../setup/) section to
102+boot your urbit.
103+
104+If you're running Urbit in the cloud on a small instance, however, read
105+the below section, as you may need to additionally configure swap space.
106+
112−## Setting up swap
107+### (Set up swap)
113
108
114−Urbit wants to map 2GB of memory when it boots up. We won’t
109+Urbit wants to map 2GB of memory when it boots up. We won’t necessarily
115−necessarily use all this memory, we just want to see it. On a
110+use all this memory, we just want to see it. On a normal modern PC or Mac,
116−normal modern PC or Mac, this is not an issue. On some small
111+or on a large cloud virtual machine, this is not an issue. On some small
117−cloud virtual machines (Amazon or Digital Ocean), the default
112+cloud virtual machines (Amazon or Digital Ocean), the default memory
118−memory configuration is smaller than this, and you need to
113+configuration is smaller than this, and you need to manually configure a
119−manually configure a swapfile.
114+swapfile.
120
115
116+Digital Ocean has a post on adding swap
117+[here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04).
118+For Amazon there’s a StackOverflow thread
121−Digital Ocean has a post on adding swap [here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04). For Amazon there’s a StackOverflow thread [here](http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).
119+[here](http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).
122
120
123Don’t spend a lot of time tweaking these settings; the simplest
121Don’t spend a lot of time tweaking these settings; the simplest
124thing is fine.
122thing is fine.