on 91d5800 help sign in
urbit.org/docs/using/install.md
124 lines 4.0 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)**
34- `brew update`
35- `brew install urbit`
37**FreeBSD**
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`
42**Debian**
44- Download `urbit_0.4.3-1_amd64.deb` [here](https://media.urbit.org/dist/debian/urbit_0.4.3-1_amd64.deb).
45- Install with `dpkg -i urbit_0.4.3-1_amd64.deb`
46- Then `apt-get install -f` to install any missing dependencies
48## Source
50First, fetch the source tarball: **[urbit-0.4.3.tar.gz](https://media.urbit.org/dist/src/urbit-0.4.3.tar.gz)**.
52### Dependencies
54Urbit depends on:
56 C compiler (gcc or clang)
57 automake
58 autoconf
59 libtool
60 cmake
61 ragel
62 re2c
63 libcurl
64 curses
65 gmp
66 libsigsegv
67 openssl
69Which can usually be installed with the following one-liners:
71 # Mac OS X [Homebrew]
72 $ brew install gmp libsigsegv openssl libtool autoconf automake cmake
74 # Mac OS X [Macports]
75 $ sudo port install gmp libsigsegv openssl autoconf automake cmake
77 # Ubuntu or Debian
78 $ 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
80 # Fedora
81 $ sudo dnf install gcc gcc-c++ gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
83 # FreeBSD
84 $ pkg install gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
86 # Arch
87 $ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
89 # AWS
90 $ sudo yum —enablerepo epel install gcc gcc-c++ gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
92### Clone and make
94Once your dependencies are installed the rest is easy:
96 $ tar xfvz urbit-0.4.tar.gz
97 $ cd urbit-0.4
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## Setting up swap
114Urbit wants to map 2GB of memory when it boots up. We won’t
115necessarily use all this memory, we just want to see it. On a
116normal modern PC or Mac, this is not an issue. On some small
117cloud virtual machines (Amazon or Digital Ocean), the default
118memory configuration is smaller than this, and you need to
119manually configure a swapfile.
121Digital 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).
123Don’t spend a lot of time tweaking these settings; the simplest
124thing is fine.