git.iko.soy/urbit.org
on eca0e2a help sign in
urbit.org/docs/using/install.md
92 lines 3.2 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### Setting up swap
19Urbit wants to map 2GB of memory when it boots up. We won’t
20necessarily use all this memory, we just want to see it. On a
21normal modern PC or Mac, this is not an issue. On some small
22cloud virtual machines (Amazon or Digital Ocean), the default
23memory configuration is smaller than this, and you need to
24manually configure a swapfile.
26Digital 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).
28Don’t spend a lot of time tweaking these settings; the simplest
29thing is fine.
31## Install a package
33Urbit may be in your system's package repository - check there first. If not, we host packages for some platforms:
35[FreeBSD](https://media.urbit.org/dist/freebsd/urbit-0.4.txz): install with `pkg install urbit-0.4.txz`.
36[Debian](https://media.urbit.org/dist/debian/urbit_0.4-1_amd64.deb): install with `dpkg -i urbit_0.4-1_amd64.deb`, followed by `apt-get install -f` to install any missing dependencies.
38## Build from source
40First, fetch the source tarball from [here](https://media.urbit.org/dist/src/urbit-0.4.tar.gz).
42### Dependencies
44Urbit depends on:
46 C compiler (gcc or clang)
47 automake
48 autoconf
49 libtool
50 cmake
51 ragel
52 re2c
53 libcurl
54 curses
55 gmp
56 libsigsegv
57 openssl
59Which can usually be installed with the following one-liners:
61 # Mac OS X [Homebrew]
62 $ brew install git gmp libsigsegv openssl libtool autoconf automake cmake
64 # Mac OS X [Macports]
65 $ sudo port install git gmp libsigsegv openssl autoconf automake cmake
67 # Ubuntu or Debian
68 $ sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev git make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c libcurl4-gnutls-dev
70 # Fedora
71 $ sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
73 # FreeBSD
74 $ pkg install git gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
76 # Arch
77 $ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
79 # AWS
80 $ sudo yum —enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
82### Clone and make
84Once your dependencies are installed the rest is easy:
86 $ tar xfvz urbit-0.4.tar.gz
87 $ cd urbit-0.4
88 $ make # gmake on FreeBSD
90After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
92 # sudo install -m 0755 bin/urbit /usr/local/bin