git.iko.soy/urbit.org
on 3d1934c help sign in
urbit.org/docs/using/install.md
113 lines 3.8 kB history raw
1---
2navhome: /docs
3next: true
4sort: 1
5title: Install
6---
8# Install
10Installing Urbit is easy. It just takes a few minutes to get an
11instance up and running on the network.
13Urbit is designed to run on any Unix box with an internet connection.
14Debian (jessie), Mac OS X, FreeBSD and Fedora all work well.
16If you run into trouble installing Urbit, please let us know via
17email, [questions@urbit.org](mailto:questions@urbit.org), or on the
18forum: [urbit.org/fora](https://urbit.org/fora). You can also chat
19with us at [urbit.org/stream](https://urbit.org/fora).
21> Urbit is alpha software. It’s not yet completely stable, its crypto
22> hasn’t been audited, and there are plenty of rough edges. Urbit is
23> lots of fun to play with, but not quite ready for your important or
24> sensitive data.
26## Packages
28Urbit may be in your system's package repository — check there first. If not,
29we host packages for some platforms. If you'd prefer to install from source, see
30below.
32#### Mac OS X (Homebrew)
33- `brew update`
34- `brew install urbit`
36#### FreeBSD
37- Download `urbit-0.4.txz` [here](https://media.urbit.org/dist/freebsd/urbit-0.4.txz).
38- Install with `pkg install urbit-0.4.txz`
40#### Debian
41- Download `urbit_0.4-1_amd64.deb` [here](https://media.urbit.org/dist/debian/urbit_0.4-1_amd64.deb).
42- Install with `dpkg -i urbit_0.4-1_amd64.deb`
43- Then `apt-get install -f` to install any missing dependencies
45## Source
47First, fetch the source tarball from [media.urbit.org/dist/src/urbit-0.4.tar.gz](https://media.urbit.org/dist/src/urbit-0.4.tar.gz).
49### Dependencies
51Urbit depends on:
53 C compiler (gcc or clang)
54 automake
55 autoconf
56 libtool
57 cmake
58 ragel
59 re2c
60 libcurl
61 curses
62 gmp
63 libsigsegv
64 openssl
66Which can usually be installed with the following one-liners:
68 # Mac OS X [Homebrew]
69 $ brew install git gmp libsigsegv openssl libtool autoconf automake cmake
71 # Mac OS X [Macports]
72 $ sudo port install git gmp libsigsegv openssl autoconf automake cmake
74 # Ubuntu or Debian
75 $ 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
77 # Fedora
78 $ 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
80 # FreeBSD
81 $ pkg install git gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
83 # Arch
84 $ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
86 # AWS
87 $ 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
89### Clone and make
91Once your dependencies are installed the rest is easy:
93 $ tar xfvz urbit-0.4.tar.gz
94 $ cd urbit-0.4
95 $ make # gmake on FreeBSD
97After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
99 # sudo install -m 0755 bin/urbit /usr/local/bin
101## Setting up swap
103Urbit wants to map 2GB of memory when it boots up. We won’t
104necessarily use all this memory, we just want to see it. On a
105normal modern PC or Mac, this is not an issue. On some small
106cloud virtual machines (Amazon or Digital Ocean), the default
107memory configuration is smaller than this, and you need to
108manually configure a swapfile.
110Digital 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).
112Don’t spend a lot of time tweaking these settings; the simplest
113thing is fine.