content/using/install.md · urbit.org

git.iko.soy/urbit.org

on cdecc71 help sign in

urbit.org/content/using/install.md

76 lines 3.7 kB history raw

1+++

2title = "Install + Setup"

3weight = 1

4description = "How to install Urbit."

5template = "page_indiced.html"

6aliases = ["/docs/getting-started/"]

7+++

9Urbit is not yet ready for everyday users -- but if you're technically inclined or generally intrepid, feel free to try it out. It's a good place to explore.

11In order to get going on the network, you'll need an [Urbit ID](#id). To try the live network out with a disposable identity, you can always [create a comet](@/using/operations/creating-a-comet.md).

13## Getting an Urbit ID {#id}

15For an introduction to Urbit IDs and the address space more generally, see [Urbit ID](@/understanding-urbit/urbit-id.md) in [Understanding Urbit](@/understanding-urbit/_index.md).

17While Tlon does not currently sell or distribute Urbit IDs, there are still a few ways to get your own Urbit ID:

19- Getting an invitation from a friend

20- Purchasing an Urbit ID from a third party, such as [urbit.live](https://urbit.live) or [OpenSea](https://opensea.io).

22Tlon occasionally selects candidates to distribute invitations, and users operating galaxies and stars can spawn and distribute a finite number of stars and planets, respectively.

24## Install Urbit {#urbit}

26The Urbit binary runs nicely on a Unix-like operating system – Ubuntu, Fedora, or macOS, for example. If you're using Windows, you'll need to get one of the aforementioned systems. But first, some terminology:

28- `vere` or `urbit`: the interpreter that runs when you run a command like `./urbit` in your command line

29- `arvo`: the deterministic OS that lives in a directory whose name matches your Urbit ID, i.e. `~famreb-todmec` lives in `/famreb-todmec`

31We have different installation instructions for different platforms. To install and run Arvo, the Urbit operating system, and its binary, run the commands that are listed for your operating system.

33You can check your Arvo installation on any platform by running the `./urbit` command. Installation was successful if you get a block of output that begins with the line below:

35```

36Urbit: a personal server operating function

37```

39### macOS

41We provide static binaries for macOS. You can grab the latest stable release as follows:

43```sh

44curl -O https://bootstrap.urbit.org/urbit-darwin-v0.8.2.tgz

45tar xzf urbit-darwin-v0.8.2.tgz

46./urbit

47```

49### Linux (64-bit)

51We also provide static binaries for 64-bit Linux distributions (Ubuntu, Debian, Fedora, Arch, etc.). You can get the latest stable release similarly:

53```sh

54curl -O https://bootstrap.urbit.org/urbit-linux64-v0.8.2.tgz

55tar xzf urbit-linux64-v0.8.2.tgz

56./urbit

57```

59To access your Urbit via HTTP on port 80 on Ubuntu, you may need to run the following:

61```sh

62sudo apt-get install libcap2-bin

63sudo setcap 'cap_net_bind_service=+ep' /path/to/urbit

64```

66### Compile from source

68If you want to compile from source, see the [instructions on GitHub](https://github.com/urbit/urbit#development).

70### About swap space

72If you're running Urbit in the cloud on a small instance, you may need to additionally configure swap space. If you're not, you can safely ignore this section.

74Urbit wants to map 2GB of memory when it boots up. It won’t necessarily use all this memory, it just wants to see it. On a normal modern PC or Mac, or on a large cloud virtual machine, this is not an issue. On some small cloud virtual machines (Amazon or Digital Ocean) the default memory configuration is smaller than this, and you need to manually configure a swapfile.

76Digital Ocean has a post on adding swap [here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-16-04). For Amazon there’s a StackOverflow thread [here](https://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).