git.iko.soy/urbit.org
on fd1eeed help sign in
urbit.org/docs/setup/install.md
105 lines 2.7 kB history raw
1---
2next: true
3sort: 1
4title: Install
5---
7# Installation guide
9Urbit can be installed on most Unix systems. There is no Windows
10port. Windows is a wonderful OS, we just haven't gotten to it yet.
11Use a VM.
13## Configure the OS
15Urbit wants to map 2GB of memory when it boots up. We won't
16necessarily use all this memory, we just want to see it. On a
17normal modern PC or Mac, this is not an issue. On some small
18cloud virtual machines (Amazon or Digital Ocean), the default
19memory configuration is smaller than this, and you need to
20manually configure a swapfile.
22Digital 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).
24Don't spend a lot of time tweaking these settings; the simplest
25thing is fine.
27## Install as a package
29### OS X - Homebrew
31 brew install --HEAD homebrew/head-only/urbit
33### Ubuntu or Debian
35Third-party packages are available, at:
37 https://github.com/yebyen/urbit-deb
39Urbit is only supported on Jessie onward (but outbound HTTPS
40requests only work on Stretch; I wish we knew why; help us!)
42## Hand-build from source
44First, install all external dependencies. Then, make.
46### Dependencies
48urbit depends on:
50 gcc (or clang)
51 gmp
52 libsigsegv
53 openssl
54 automake
55 autoconf
56 ragel
57 cmake
58 re2c
59 libtool
60 libssl-dev (Linux only)
61 ncurses (Linux only)
63#### Ubuntu or Debian
65 sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev git make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c
67#### Fedora
69 sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c
71#### AWS
73 sudo yum --enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c
75#### OS X - Homebrew
77 brew install git gmp libsigsegv openssl libtool autoconf automake cmake
79#### OS X - Macports
81 sudo port install git gmp libsigsegv openssl autoconf automake cmake
83Although `automake`/`autoconf`/`libtool` are generally installed by
84default, some have reported needing to uninstall and reinstall those
85three packages, at least with Homebrew. Your mileage may vary.
87#### FreeBSD
89 pkg install git gmake gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool
91### Download and make
93Clone the repo:
95 git clone git://github.com/urbit/urbit.git
97`cd` to the directory you just created:
99 cd urbit
101Run `make`:
103 make
105(On FreeBSD, use `gmake` instead.)