11Installing Urbit is easy. It just takes a few minutes to get an
12instance up and running on the network.
14Urbit is designed to run on any Unix box with an internet connection.
15Debian (jessie), Mac OS X, FreeBSD and Fedora all work well.
17If you run into trouble installing Urbit, please let us know via
18email, [questions@urbit.org](mailto:questions@urbit.org), or on the
19forum: [urbit.org/fora](https://urbit.org/fora). You can also chat
20with us at [urbit.org/stream](https://urbit.org/stream).
22> Urbit is alpha software. It’s not yet completely stable, its crypto
23> hasn’t been audited, and there are plenty of rough edges. Urbit is
24> lots of fun to play with, but not quite ready for your important or
27### Update: `~2017.12.7`
29Urbit `0.5.1` is now live! We expect there to be a delay in getting our
30updated `urbit-0.5.1` binary packages propagated to Homebrew, APT and
31the other various package managers. So for now, **please
32build and install Urbit from source**. The instructions below will walk
33you through how to do that. You'll then be free to continue the boot
34and setup process as normal, per the rest of this Using docs section.
42 C compiler (gcc or clang)
55Which can usually be installed with the following one-liners:
58 $ brew install gmp libsigsegv openssl libtool autoconf automake cmake
61 $ sudo port install gmp libsigsegv openssl autoconf automake cmake
64 $ 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
67 $ sudo dnf install gcc gcc-c++ gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
70 $ pkg install gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
73 $ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
76 $ sudo yum --enablerepo epel install gcc gcc-c++ gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
80Once your dependencies are installed the rest is easy:
82 $ git clone https://github.com/urbit/urbit
84 $ make # gmake on FreeBSD
86After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
88 # sudo install -m 0755 bin/urbit /usr/local/bin
94 urbit -c <mycomet> to create a comet (anonymous urbit)
95 urbit -w <myplanet> -t <myticket> if you have a ticket
96 urbit <myplanet or mycomet> to restart an existing urbit
100And you're done! If you're running Urbit on a normal modern PC or Mac, or
101on a large cloud instance, move onto the next [setup](../setup/) section to
104If you're running Urbit in the cloud on a small instance, however, read
105the below section, as you may need to additionally configure swap space.
109Urbit wants to map 2GB of memory when it boots up. We won’t necessarily
110use all this memory, we just want to see it. On a normal modern PC or Mac,
111or on a large cloud virtual machine, this is not an issue. On some small
112cloud virtual machines (Amazon or Digital Ocean), the default memory
113configuration is smaller than this, and you need to manually configure a
116Digital Ocean has a post on adding swap
117[here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04).
118For Amazon there’s a StackOverflow thread
119[here](http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).
121Don’t spend a lot of time tweaking these settings; the simplest
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list