docs/user/install.md · urbit.org

git.iko.soy/urbit.org

on bdfaba4 help sign in

urbit.org/docs/user/install.md

111 lines 2.7 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

30Don't spend a lot of time tweaking these settings; the simplest

31thing is fine.

33## Install as a package

35### OS X - Homebrew

37 brew install --HEAD homebrew/head-only/urbit

39### Ubuntu or Debian

41Third-party packages are available, at:

43 https://github.com/yebyen/urbit-deb

45Urbit is only supported on Jessie onward (but outbound HTTPS

46requests only work on Stretch; I wish we knew why; help us!)

48## Hand-build from source

50First, install all external dependencies. Then, make.

52### Dependencies

54urbit depends on:

56 gcc (or clang)

57 gmp

58 libsigsegv

59 openssl

60 automake

61 autoconf

62 ragel

63 cmake

64 re2c

65 libtool

66 libssl-dev (Linux only)

67 ncurses (Linux only)

69#### Ubuntu or Debian

71 sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev git make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c

73#### Fedora

75 sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c

77#### AWS

79 sudo yum --enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c

81#### OS X - Homebrew

83 brew install git gmp libsigsegv openssl libtool autoconf automake cmake

85#### OS X - Macports

87 sudo port install git gmp libsigsegv openssl autoconf automake cmake

89Although `automake`/`autoconf`/`libtool` are generally installed by

90default, some have reported needing to uninstall and reinstall those

91three packages, at least with Homebrew. Your mileage may vary.

93#### FreeBSD

95 pkg install git gmake gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool

97### Download and make

99Clone the repo:

100