git.iko.soy/urbit.org
on 64228d6 help sign in
urbit.org/docs/using/install.md
82 lines 2.7 kB history raw
1---
2navhome: /docs
3next: true
4sort: 1
5title: Install
6---
8# Install
10Urbit is designed to run on any Unix box with an internet connection. Debian
11(jessie), OS X, FreeBSD and Fedora all work well.
13Urbit is alpha software. It’s not yet completely stable, its crypto hasn’t
14been audited, and there are plenty of rough edges. Urbit is lots of fun to play
15with, but not quite ready for your important or sensitive data.
17## Build from source
19### Dependencies
21Urbit depends on:
23 gcc (or clang)
24 gmp
25 libsigsegv
26 openssl
27 automake
28 autoconf
29 ragel
30 cmake
31 re2c
32 libtool
33 libssl-dev (Linux only)
34 ncurses (Linux only)
36Which can usually be installed with the following one-liners:
38 # Mac OS X [Homebrew]
39 brew install git gmp libsigsegv openssl libtool autoconf automake cmake
41 # Mac OS X [Macports]
42 sudo port install git gmp libsigsegv openssl autoconf automake cmake
44 # Ubuntu or Debian
45 sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev git make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c
47 # Fedora
48 sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c
50 # FreeBSD
51 pkg install git gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool
53 # Arch
54 pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses
56 # AWS
57 sudo yum —enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c
59### Setting up swap
61Urbit wants to map 2GB of memory when it boots up. We won’t
62necessarily use all this memory, we just want to see it. On a
63normal modern PC or Mac, this is not an issue. On some small
64cloud virtual machines (Amazon or Digital Ocean), the default
65memory configuration is smaller than this, and you need to
66manually configure a swapfile.
68Digital 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).
70Don’t spend a lot of time tweaking these settings; the simplest
71thing is fine.
73### Clone and make
75Once your dependencies are installed the rest is easy:
77 git clone https://github.com/urbit/urbit
78 cd urbit
79 make
80 curl -o urbit.pill https://bootstrap.urbit.org/latest.pill
82After running `make`, your Urbit executable lives at `bin/urbit`. The `.pill` file is a compiled binary of Arvo that Urbit uses to bootstrap itself.