git.iko.soy/urbit.org
on 237b499 help sign in
urbit.org/docs/using/install.md
136 lines 4.6 kB history raw
1---
2navhome: /docs/
3navuptwo: true
4next: true
5sort: 1
6title: Install
7---
9# Install
11Installing Urbit is easy. It just takes a few minutes to get an
12instance up and running on the network.
14Urbit is designed to run on any Unix box with an internet connection.
15Debian (jessie), Mac OS X, FreeBSD and Fedora all work well.
17If you run into trouble installing Urbit, please let us know via
18email, [questions@urbit.org](mailto:questions@urbit.org), or on the
19forum: [urbit.org/fora](https://urbit.org/fora). You can also chat
20with us at [urbit.org/stream](https://urbit.org/stream).
22> Urbit is alpha software. It’s not yet completely stable, its crypto
23> hasn’t been audited, and there are plenty of rough edges. Urbit is
24> lots of fun to play with, but not quite ready for your important or
25> sensitive data.
27### Update: `~2017.12.7`
29Urbit `0.5.1` is now live! We expect there to be a delay in getting our
30updated `urbit-0.5.1` binary packages propagated to Homebrew, APT and
31the other various package managers. So for now, **please
32build and install Urbit from source**. The instructions below will walk
33you through how to do that. You'll then be free to continue the boot
34and setup process as normal, per the rest of this Using docs section.
36## Build from source
38### Dependencies
40Urbit depends on:
42 C compiler (gcc or clang)
43 automake
44 autoconf
45 libtool
46 cmake
47 ragel
48 re2c
49 libcurl
50 curses
51 gmp
52 libsigsegv
53 openssl
55Which can usually be installed with the following one-liners:
57 # Mac OS X [Homebrew]
58 $ brew install gmp libsigsegv openssl libtool autoconf automake cmake
60 # Mac OS X [Macports]
61 $ sudo port install gmp libsigsegv openssl autoconf automake cmake
63 # Ubuntu or Debian
64 $ sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c libcurl4-gnutls-dev
66 # Fedora
67 $ sudo dnf install gcc gcc-c++ gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
69 # FreeBSD
70 $ pkg install gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
72 # Arch
73 $ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
75 # AWS
76 $ sudo yum --enablerepo epel install gcc gcc-c++ gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
78### Clone and make
80Once your dependencies are installed the rest is easy.
82If you're cloning the `urbit/urbit` Git repository for the first time, run:
84 $ git clone https://github.com/urbit/urbit
85 $ cd urbit
86 $ make # gmake on FreeBSD
88_**Updated for the `2017.12.7` continuity breach**_
90If you already have a clone of the `urbit/urbit` Git repository, assuming
91your `origin` upstream is the `urbit/urbit` repository on Github, run the
92following commands to make sure you're on the correct, clean Git branch:
94 $ cd urbit
95 $ git fetch --all
96 $ git checkout master
97 $ git reset --hard origin/master
98 $ make # gmake on FreeBSD
100After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
102 # sudo install -m 0755 bin/urbit /usr/local/bin
104Test that it works:
106 $ urbit
107 simple usage:
108 urbit -c <mycomet> to create a comet (anonymous urbit)
109 urbit -w <myplanet> -t <myticket> if you have a ticket
110 urbit <myplanet or mycomet> to restart an existing urbit
112### Boot your urbit
114And you're done! If you're running Urbit on a normal modern PC or Mac, or
115on a large cloud instance, move onto the next [setup](../setup/) section to
116boot your urbit.
118If you're running Urbit in the cloud on a small instance, however, read
119the below section, as you may need to additionally configure swap space.
121### (Set up swap)
123Urbit wants to map 2GB of memory when it boots up. We won’t necessarily
124use all this memory, we just want to see it. On a normal modern PC or Mac,
125or on a large cloud virtual machine, this is not an issue. On some small
126cloud virtual machines (Amazon or Digital Ocean), the default memory
127configuration is smaller than this, and you need to manually configure a
128swapfile.
130Digital Ocean has a post on adding swap
131[here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04).
132For Amazon there’s a StackOverflow thread
133[here](http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).
135Don’t spend a lot of time tweaking these settings; the simplest
136thing is fine.