shrub/pub/docs/user/install.mdy
ault011 0f0d913ac8 removed bin/urbit from this page
since we don't give instructions on what arguments to pass to this executable, let's just take this out.
2015-11-03 11:36:35 -08:00

92 lines
2.0 KiB
Plaintext

---
title: Install
sort: 2
next: true
---
# Installation guide
Urbit can be installed on most Unix systems. There is no Windows
port. Windows is a wonderful OS, we just haven't gotten to it yet.
Use a VM.
## Install as a package
### OS X - Homebrew
brew install --HEAD homebrew/head-only/urbit
### Ubuntu or Debian
Third-party packages are available, at:
https://github.com/yebyen/urbit-deb
Urbit is only supported on Jessie onward (but outbound HTTPS
requests only work on Stretch; I wish we knew why; help us!)
## Hand-build from source
First, install all external dependencies. Then, make.
### Dependencies
urbit depends on:
gcc (or clang)
gmp
libsigsegv
openssl
automake
autoconf
ragel
cmake
re2c
libtool
libssl-dev (Linux only)
ncurses (Linux only)
#### Ubuntu or Debian
sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev git make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c
#### Fedora
sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c
#### AWS
sudo yum --enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c
#### OS X - Homebrew
brew install git gmp libsigsegv openssl libtool autoconf automake cmake
#### OS X - Macports
sudo port install git gmp libsigsegv openssl autoconf automake cmake
Although `automake`/`autoconf`/`libtool` are generally installed by
default, some have reported needing to uninstall and reinstall those
three packages, at least with Homebrew. Your mileage may vary.
#### FreeBSD
pkg install git gmake gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool
### Download and make
Clone the repo:
git clone git://github.com/urbit/urbit.git
`cd` to the directory you just created:
cd urbit
Run `make`:
make
(On FreeBSD, use `gmake` instead.)