git.iko.soy/urbit.org
on 514b5fc help sign in
urbit.org/content/getting-started/_index.md
132 lines 6.2 kB history raw
1+++
2title = "Getting Started"
3weight = 0
4description = "How to install Urbit."
5page_template = "page_indiced.html"
6template = "getting-started/index.html"
7+++
9Don't know what Urbit is? Spend ten minutes or so reading our page on
10[Understanding Urbit](/understanding-urbit/).
12If you want to jump right in and try out Urbit with a free, disposible ID called a **Comet**, you can download the desktop app [**Port**](#port). Once installed, start it up and hit the `Start without an ID` button. It'll take a few minutes to spin up the new Comet, then click `Launch Ship into Urbit` and you'll be at the login screen. Click on `Copy Access Key` at the bottom-left, paste it into the `Access Key` field, and hit `Continue`. You'll now be at your ship's home screen and ready to explore Urbit. You can also have a look at the [Next Steps](#next-steps) section below to help you get going.
14If you want to get a permanent Urbit ID called a **Planet**, have a look at the [Get a planet](#get-a-planet) section below.
16If you have a **Planet** and want some help getting it up and running the first time, see the [Setting up your urbit](/getting-started/planet) guide.
18If you want to use a **Planet** without worrying about the gritty bits, you may want to consider a [hosting provider](#hosting-providers).
20If you're technically proficient and would like greater control over the Urbit virtual machine than is possible with [Port](#port), or are setting up Urbit on a cloud droplet, try [installation using the command line](/getting-started/cli).
22## Get Port {#port}
24**Port** is a desktop GUI application that allows you to spin up, access, and manage your Urbit ships without any knowledge of the command line or Urbit binary.
26<div id="port-os" class="os mv3">
27 <input type="radio" id="port-macos" name="port-os" checked>
28 <label for="port-macos">MacOS</label>
29 <div class="tab">
30 <p>To install <strong>Port</strong> on MacOS simply download and open the <code>.dmg</code> file.</p>
31 <a href="https://github.com/urbit/port/releases/latest/download/Port.dmg" class="badge-sm bg-green-400 text-white" style="width: 12rem;">
32 Download Port
33 </a>
34 </div>
36 <input type="radio" id="port-linux" name="port-os">
37 <label for="port-linux">Linux</label>
38 <div class="tab">
40We use `snap` so that **Port** can stay updated automatically. If you already have `snap` installed, simply run:
42```sh
43sudo snap install port
44```
46Or to install `snap` for your distribution, snapcraft provides [installation instructions](https://snapcraft.io/docs/installing-snapd).
48 </div>
50 <input type="radio" id="port-windows" name="port-os">
51 <label for="port-windows">Windows</label>
52 <div class="tab">
53 <p>To install <strong>Port</strong> on Windows simply download and open the <code>.exe</code> file.</p>
54 <a href="https://github.com/urbit/port/releases/latest/download/PortSetup.exe" class="badge-sm bg-green-400 text-white" style="width: 12rem;">
55 Download Port
56 </a>
57 <p><small>
58 Note: The Windows version is newly released and is not yet code signed so you will have to click through a prompt warning you about running it. If you simply click <code>more info</code> -> <code>run anyway</code> it will run.
59 </small></p>
60 </div>
61</div>
63<style>
64 .os {
65 display: flex;
66 flex-wrap: wrap;
67 }
68 .os label {
69 order: -1;
70 padding: .5rem;
71 min-width: 70px;
72 text-align: center;
73 cursor: pointer;
74 }
75 .os input[type="radio"] {
76 display: none;
77 }
78 .os .tab {
79 display: none;
80 margin-top: 1rem;
81 width: 100%;
82 max-width: 100%;
83 }
84 .os .tab p:first-child {
85 margin-top: 0;
86 }
87 .os .tab p:last-child {
88 margin-bottom: 0;
89 }
90 .os input[type='radio']:checked + label {
91 font-weight: bold;
92 background-color: rgba(244,243,241,1);
93 border-radius: 0.5em;
94 }
95 .os input[type='radio']:checked + label + .tab {
96 display: block;
98</style>
100## Get a planet
102There are a few ways to get your own planet:
104- Getting an invitation from a friend (or stranger).
105- Purchasing a planet, including hosting, from a [hosting provider](#hosting-providers).
106- Manually setting up and hosting a planet purchased from a third party such as [urbit.live](https://urbit.live), [OpenSea](https://opensea.io), [planet.market](https://planet.market/), [urbit.me](https://urbit.me), [urth systems](https://urth.systems/), [Urbitex](https://urbitex.io), or [Urbit Marketplace](https://urbitmarketplace.com/).
108## Hosting Providers {#hosting-providers}
110Hosting providers will often sell you a planet and run it for you. This option is very simple but will probably cost a regular fee.
112Urbit is designed to be portable. This means that if you sign up for hosting now but later want to leave your hosting provider and run your Urbit yourself, you should be able to work with them to obtain all of your data and boot your planet back up without losing anything.
114Using hosting does mean that you're trusting your provider with your data, but so long as you have your planet, you'll always own your identity.
116Current hosting providers are:
118- [escape pod store](https://www.escapepod.store/)
119- [Third Earth](https://third.earth/)
120- [Tlon Corporation](https://tlon.io)
121- [UrbitHost](https://urbithost.com)
123## Next steps
125Once you've got your ship up and running, you might like to join the official Urbit Community group and say hello. Just click on the `Groups` app and it will open Urbit's communications suite. In Groups, hit `Join Group` and enter `~bitbet-bolbel/urbit-community`. Once joined, a new tile for the group will appear on the Groups home screen. Open that, click on the `General` channel in the sidebar, and hit `Join Channel`. It'll take a couple of minutes to download the chat history, then you'll be able to post a message.
127If you haven't already done so, we recommend spending a few minutes reading
128[Understanding Urbit](/understanding-urbit) to get acquainted with the project.
129Then once you've been become acquainted with your ship and explored the network
130for awhile, consider checking out the [User's Manual](/using) which provides
131guidance and reference material for operating your ship, as well as explanations
132for Urbit concepts everyone should eventually learn.