on 1118968 help sign in
urbit.org/docs/using/install.md
128 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 instance up and
11running on the network.
13Urbit is designed to run on any Unix box with an internet connection. Debian
14(jessie), Mac OS X, FreeBSD and Fedora all work well.
16If you run into trouble installing Urbit, please let us know via email,
17<questions@urbit.org>, or on the forum:
18[urbit.org/fora](https://urbit.org/fora). You can also chat with us at
19[urbit.org/stream](https://urbit.org/stream).
21> Urbit is alpha software. It’s not yet completely stable, its crypto hasn’t
22> been audited, and there are plenty of rough edges. Urbit is lots of fun to
23> play with, but not quite ready for your important or sensitive data.
25## Packages
27Urbit may be in your system's package repository — check there first. If not, we
28host packages for some platforms. If you'd prefer to install from source, see
29below.
31**Mac OS X (Homebrew)**
33- `brew update`
34- `brew install urbit`
36**FreeBSD**
38- Download `urbit-0.4.3.txz`
39 [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.5-1_amd64.deb`
45 [here](https://media.urbit.org/dist/debian/urbit_0.4.5-1_amd64.deb).
46- Install with `dpkg -i urbit_0.4.5-1_amd64.deb`
47- Then `apt-get install -f` to install any missing dependencies
49## Source
51First, fetch the source tarball:
52**[urbit-0.4.5.tar.gz](https://media.urbit.org/dist/src/urbit-0.4.5.tar.gz)**.
54### Dependencies
56Urbit depends on:
58 C compiler (gcc or clang)
59 automake
60 autoconf
61 libtool
62 cmake
63 ragel
64 re2c
65 libcurl
66 curses
67 gmp
68 libsigsegv
69 openssl
71Which can usually be installed with the following one-liners:
73 # Mac OS X [Homebrew]
74 $ brew install gmp libsigsegv openssl libtool autoconf automake cmake
76 # Mac OS X [Macports]
77 $ sudo port install gmp libsigsegv openssl autoconf automake cmake
79 # Ubuntu or Debian
80 $ 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
82 # Fedora
83 $ sudo dnf install gcc gcc-c++ gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
85 # FreeBSD
86 $ pkg install gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
88 # Arch
89 $ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
91 # AWS
92 $ sudo yum --enablerepo epel install gcc gcc-c++ gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
94### Clone and make
96Once your dependencies are installed the rest is easy:
98 $ tar xfvz urbit-0.4.5.tar.gz
99 $ cd urbit-0.4.5
100 $ make # gmake on FreeBSD
102After running `make`, your Urbit executable is in `bin/urbit`. Install it
103wherever you'd like.
105 # sudo install -m 0755 bin/urbit /usr/local/bin
107Test that it works:
109 $ urbit
110 simple usage:
111 urbit -c <mycomet> to create a comet (anonymous urbit)
112 urbit -w <myplanet> -t <myticket> if you have a ticket
113 urbit <myplanet or mycomet> to restart an existing urbit
115## Setting up swap
117Urbit wants to map 2GB of memory when it boots up. We won’t necessarily use all
118this memory, we just want to see it. On a normal modern PC or Mac, this is not
119an issue. On some small cloud virtual machines (Amazon or Digital Ocean), the
120default memory configuration is smaller than this, and you need to manually
121configure a swapfile.
123Digital Ocean has a post on adding swap
124[here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04).
125For Amazon there’s a StackOverflow thread
126[here](http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).
128Don’t spend a lot of time tweaking these settings; the simplest thing is fine.