on 8564483 help sign in
urbit.org/docs/user/install.md
119 lines 2.9 kB history raw
1---
2next: true
3sort: 2
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.
22To add swap to a DO droplet:
24https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04
26To add swap on an Amazon instance:
28http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance
30To add swap on a BSD instance:
32 https://www.freebsd.org/doc/handbook/adding-swap-space.htm
34Don't spend a lot of time tweaking these settings; the simplest
35thing is fine.
37## Install as a package
39### OS X - Homebrew
41 brew install --HEAD homebrew/head-only/urbit
43### Ubuntu or Debian
45Third-party packages are available, at:
47 https://github.com/yebyen/urbit-deb
49Urbit is only supported on Jessie onward (but outbound HTTPS
50requests only work on Stretch; I wish we knew why; help us!)
52## Hand-build from source
54First, install all external dependencies. Then, make.
56### Dependencies
58urbit depends on:
60 gcc (or clang)
61 gmp
62 libsigsegv
63 openssl
64 automake
65 autoconf
66 ragel
67 cmake
68 re2c
69 libtool
70 libssl-dev (Linux only)
71 ncurses (Linux only)
73#### 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
77#### Fedora
79 sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c
81#### AWS
83 sudo yum --enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c
85#### OS X - Homebrew
87 brew install git gmp libsigsegv openssl libtool autoconf automake cmake
89#### OS X - Macports
91 sudo port install git gmp libsigsegv openssl autoconf automake cmake
93Although `automake`/`autoconf`/`libtool` are generally installed by
94default, some have reported needing to uninstall and reinstall those
95three packages, at least with Homebrew. Your mileage may vary.
97#### FreeBSD
99 pkg install git gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool
101#### Archlinux
103 pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses
105### Download and make
107Clone the repo:
109 git clone git://github.com/urbit/urbit.git
111`cd` to the directory you just created:
113 cd urbit
115Run `make`:
117 make
119(On FreeBSD, use `gmake` instead.)