git.iko.soy/urbit.org
on aa4e043 help sign in
urbit.org/content/using/install.md
214 lines 8.8 kB history raw
1+++
2title = "Getting Started"
3weight = 1
4description = "How to install Urbit."
5template = "page_indiced.html"
6aliases = ["/docs/getting-started/"]
7+++
9The price of using other platforms is your data and its security. There's a reason they're free to use.
11The price of using Urbit is your own responsibility — you must run it yourself (or pay someone to run it for you).
13It's easy and it keeps getting easier.
15There are currently two ways to run Urbit:
17If you use Mac or Linux and are not afraid of a few terminal commands, we recommend you run it yourself. That is the aim of this guide.
19If you run Windows or just want to give it a shot without worrying about the gritty bits, you may want to consider a [hosting provider](/using/planet#hosting-providers).
21## Installing Urbit {#macos-and-linux}
23Choose the code for your operating system and run the commands in your terminal.
25<div id="os">
26 <input type="radio" id="macos" name="os" checked>
27 <label for="macos">MacOS</label>
28 <div class="tab">
30```sh
31mkdir ~/urbit
32cd ~/urbit
33curl -JLO https://urbit.org/install/mac/latest
34tar zxvf ./darwin.tgz --strip=1
35~/urbit/urbit
36```
37 </div>
39 <input type="radio" id="linux" name="os">
40 <label for="linux">Linux</label>
41 <div class="tab">
43```sh
44mkdir ~/urbit
45cd ~/urbit
46wget --content-disposition https://urbit.org/install/linux64/latest
47tar zxvf ./linux64.tgz --strip=1
48~/urbit/urbit
49```
51Linux users may need to run this command in another terminal window to access your Urbit on port 80:
53```sh
54sudo apt-get install libcap2-bin
55sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit
56```
57</div>
59 <input type="radio" id="windows" name="os">
60 <label for="windows">Windows</label>
61 <div class="tab">
63> Please note that this method of installing Urbit is experimental, and we may not be able to assist you if you encounter issues related to WSL 2.
65Urbit cannot run on Windows itself, but there is a convenient way to run Linux using the [Windows Subsystem for Linux 2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install) on Windows 10. Install the Windows Subsystem for Linux 2 and open a Linux terminal in Windows, then follow the Linux installation instructions below. These instructions have been tested and verified for WSL 2 + Ubuntu 18.04 LTS, as demonstrated in `~sitful-hatred`'s step-by-step setup guide [here](https://subject.network/posts/urbit-wsl2/).
67For performance reasons, do not install Urbit in the mounted Windows volume, but install it in the Linux file system. For example, in your home directory, which can be navigated to by entering `cd ~`.
68</div>
69</div>
71<style>
72 #os {
73 display: flex;
74 flex-wrap: wrap;
75 }
76 #os label {
77 order: -1;
78 padding: .5rem;
79 border-width: 1px 0px 0px 1px;
80 border-style: solid;
81 cursor: pointer;
82 }
83 #os label[for=windows] {
84 border-right-width: 1px;
85 }
86 #os input[type="radio"] {
87 display: none;
88 }
89 #os .tab {
90 display: none;
91 border: 1px solid;
92 padding: 1rem;
93 max-width: 100%;
94 }
95 #os input[type='radio']:checked + label {
96 font-weight: bold;
97 }
98 #os input[type='radio']:checked + label + .tab {
99 display: block;
101</style>
103If successful, you will see a block of output beginning with the line:
105```
106Urbit: a personal server operating function
107```
109## Booting a Free Identity {#comet}
111There are two parts to Urbit: an **ID** and an **Operating System**.
113You have just installed the Operating System on your computer.
115The **ID** is similar to a username and password on another site. The difference is that the public part (the username) is verified by thousands of people around the world while only you hold the key (the password) to that ID.
117There are five kinds of Urbit IDs but to get started you only need to know about two: we call them **planets** and **comets**.
119***
121**Planets** are scarce (this prevents spamming, among other things) and usually require a price to acquire. This is the recommended way to run Urbit, but it's a bit more involved.
123A planet name looks like `~sampel-palnet`.
125[Follow this guide](/using/planet) if you have already acquired a planet.
127[Find a planet to purchase](/using/planet#purchase)
129***
131**Comets** are practically unlimited and free to acquire. At present, these are a great way to try out the network for free.
133A comet name looks like `~dasres-ragnep-lislyt-ribpyl--mosnyx-bisdem-nidful-marzod`.
135[Read more about Urbit ID here](/understanding-urbit/urbit-id)
138***
140To boot a comet, go into the command line and run the following command from the `urbit` directory you created during [Urbit installation](#installing-urbit):
142```sh
143~/urbit/urbit -c mycomet
144```
146It may take a while to load the comet (probably only take a few minutes, but it could take longer). This comes along with it being free. When it's done you'll some messages ending like this:
148```
149ames: on localhost, UDP 31337.
150http: live (insecure, public) on 8080
151http: live ("secure", public) on 8443
152http: live (insecure, loopback) on 12321
153~sampel_marzod:dojo>
154```
156When your comet is finished booting, you will see `~sampel_marzod:dojo>` (Dojo: the Urbit command line).
158To exit Urbit, use `Ctrl-D` or enter `|exit` into Dojo.
160To start your comet up again, run the following from your `urbit` directory (note the lack of `-c` argument):
162```sh
163~/urbit/urbit mycomet
164```
166## Using Landscape
168Urbit is an entirely new computer, so by default it drops you into the "dojo," which is its terminal. Like your current computer, it can be used to do just about anything if you know the right commands. You only need to know one command for now.
170At the moment, the most common way to use Urbit is through a web app named Landscape, which comes with Urbit. It runs in your browser and provides an interface to Urbit without using the terminal. You need to get the password, or `code`.
1721. With your Urbit running, look for a line that says something like `http: live (insecure, public) on 80`. The number given is the port that your ship is using. It will probably be 80, but we're just making sure. (Don't worry about the "insecure, public" part — that just means you can access it from your own web browser. It doesn't give anyone else access.)
1732. If the port given is `80`, simply type `localhost` into your browser's address bar. If the given port is a different number, such as `8080`, you would type `localhost:8080`. You'll be met with a login prompt.
1743. In the window where you found the port number, type `+code` and press return. Copy-paste the code that appears into the "Access Key" field in the browser, and press continue.
1754. Once in, take a look around and read the instructions on screen. If you ever get logged out, follow these instructions again.
177## Next Steps
179### Updating your comet {#updating}
181The Urbit application comes with a recent release of the Urbit OS, but automatic updates ("over the air") can be enabled so new binaries aren't necessary for each update. Planets have automatic updates enabled by default, but this is not the case for comets. Many comets are used only once and thrown away, so it would be wasteful to update every single comet as soon as it boots. If you plan to use your comet for more than a quick test, you'll probably want to ensure you're running the latest version of the OS.
183You can enable updates for your comet by typing `|ota (sein:title our now our) %kids` into Dojo and pressing Enter.
185```
186> |ota (sein:title our now our) %kids
187>=
188```
190If you want to make sure you'll get updates, you can check by typing `|ota` with no arguments:
192```
193~sampel_marzod:dojo> |ota
194OTAs enabled from %kids on ~marzod
195use |ota %disable or |ota ~sponsor %kids to reset it
196> |ota
197>=
198```
200### Read More about the Dojo {#the-dojo}
202The dojo is Urbit's command line. You can use it to control your ship, or to execute arbitrary code. Check out the links below for more information.
204- [Basic Operations](/using/operations/using-your-ship)
205- [Basic Hoon](/docs/tutorials/hoon/hoon-school/setup)
206- [Glossary Entry](/docs/glossary/dojo)
208### Purchase a Permanent Identity {#boot-your-planet}
210You can continue using this comet indefinitely. There are currently few differences between using a comet-level identity and a planet-level one. However, some groups will not allow comets entry in order to maintain a certain level of quality, and changes may be made in the future that further devalue comets. They will always, however, be able to access the basic functions of the network.
212A comet also comes with a long and fairly unmemorable name whereas a planet has a short name and a "sigil" (avatar) associated with it that makes it more identifiable on the network. You may notice all this within the first few minutes of using Urbit.
214[To read instructions on how to purchase and use a planet, visit this page](/using/planet).