@@ -8,35 +8,29 @@ aliases = ["/docs/getting-started/"]
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.
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.
11−In 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## Overview
11## Overview
15There are two major components of the Urbit ecosystem: **Urbit OS** and **Urbit ID**.
13There are two major components of the Urbit ecosystem: **Urbit OS** and **Urbit ID**.
17−The the Urbit peer-to-peer (p2p) network is composed of instances of Urbit OS -- callled **ships** -- that are virtual machines that run on any Unix platform.
15+The the Urbit peer-to-peer (p2p) network is composed of instances of Urbit OS -- called **ships** -- that are virtual machines that run on any Unix platform.
19−Urbit works as a p2p network where others fail because ships are associated with persistent and scarce identities that we refer to as Urbit IDs. The Urbit ID registry is deployed on the Ethereum blockchain, and individual IDs exist as non-fungible ([ERC-721](https://eips.ethereum.org/EIPS/eip-721)) tokens in that cryptographic ecosystem that chain. While Urbit ID is the essential crytopgraphic foundation to the functioning of the Urbit network, it has uses far beyond that. It can be used as general-purpose identity infrastructure for any other project.
17+Urbit works as a p2p network where others fail because ships are associated with persistent and scarce identities that we refer to as Urbit IDs. The Urbit ID registry is deployed on the Ethereum blockchain, and individual IDs exist as non-fungible ([ERC-721](https://eips.ethereum.org/EIPS/eip-721)) tokens.
21On the network, Urbit IDs function as network addresses, represented by pronounceable names like `~padmyn-pasnux`. There are a few kinds of Urbit ID, but ones meant for typical users are called **planets**. Anyone who has a planet can be thought of as a full "citizen" of the Urbit network. But to run your ship on the network, you need to start it with a piece of cryptographic information from its Urbit ID. This guide walk you through getting onto Urbit with an ID.
19On the network, Urbit IDs function as network addresses, represented by pronounceable names like `~padmyn-pasnux`. There are a few kinds of Urbit ID, but ones meant for typical users are called **planets**. Anyone who has a planet can be thought of as a full "citizen" of the Urbit network. But to run your ship on the network, you need to start it with a piece of cryptographic information from its Urbit ID. This guide walk you through getting onto Urbit with an ID.
23−But sometimes a user might not want a persistent identity for whatever reason. In that case, they can use Urbit without an Urbit ID by using something called a **comet**. Comets can be spun up at will and for free. They are good for bots and for people who are new to Urbit and want to check out the network, but they aren't good for building a reputation as a friendly and responsible peer. If you want to jump right in with a comet, check out [this](#comet) section.
21+There are also free IDs called **comets**. They are good for bots and people who are new to Urbit and want to check out the network, but they aren't good for building a reputation as a friendly and responsible peer. Their long names make them difficult to remember and some communities ban comets to prevent spam, but they're still a good way to see what Urbit is about before buying your own planet.
25### Stars and Galaxies
23### Stars and Galaxies
27−In addition to comets and planets, two other types of ships are **stars** and **galaxies**. Together these can be referred to as "supernodes," because they perform essential infrastructural roles for Urbit OS network and for Urbit ID.
25+In addition to comets and planets, two other types of ships are **stars** and **galaxies**. Together these perform essential infrastructural roles for Urbit OS network and for Urbit ID.
29−On the Urbit ID side galaxies, galaxies are at the top of the ID hierarchy, with 256 in existence. Each galaxy can distribute 256 stars, and each star can distribute 65,536 planets. So any given planet ultimately came from a specific star, which itself came from a specific galaxy.
27+On the Urbit ID side, galaxies are at the top of the ID hierarchy with 256 in existence. Each galaxy can distribute 256 stars, and each star can distribute 65,536 planets. So any given planet ultimately came from a specific star, which itself came from a specific galaxy.
31On the Urbit OS side, stars help route packets, kind of like an ISP. And galaxies are like DNS root servers or ICANN members. The difference is that Urbit IDs are owned cryptographically by many different people and accrue reputation independently.
29On the Urbit OS side, stars help route packets, kind of like an ISP. And galaxies are like DNS root servers or ICANN members. The difference is that Urbit IDs are owned cryptographically by many different people and accrue reputation independently.
33If you're trying to get your star or galaxy set up, skip to [this section](#supernode).
31If you're trying to get your star or galaxy set up, skip to [this section](#supernode).
35−## Comet: Install and Setup {#comet}
37−Eager to try out the Urbit network? A comet is the fastest way to get started.
39−### Installing Urbit
33+## Installing Urbit
41The Urbit binary runs on a Unix-like operating system – Ubuntu, Fedora, or macOS, for example.
35The Urbit binary runs on a Unix-like operating system – Ubuntu, Fedora, or macOS, for example.
@@ -82,9 +76,25 @@ Urbit cannot run on Windows itself, but there is a convenient way to run a Linux
83Once WSL 2 is installed, open a Linux terminal in Windows and then follow the Linux installation instructions above. For 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, by typing `cd ~`.
77Once WSL 2 is installed, open a Linux terminal in Windows and then follow the Linux installation instructions above. For 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, by typing `cd ~`.
81+Now that you have Urbit installed you can start it up with an ID.
83+If this is your first time using Urbit, it'll be easiest to start with a comet in order to get on the network.
85+### Comet: Install and Setup {#comet}
87+If you don't have your own Planet ID, but still want to try out the Urbit network you can launch a comet.
89+**Comets** are 128-bit or 16 syllable Urbit IDs, that look like:
91+`~dasres-ragnep-lislyt-ribpyl--mosnyx-bisdem-nidful-marzod`
93+Comets are disposable, free identities that can be used to quickly join the network and try things out.
85−### Booting Your Comet
95+### Booting a comet
87−To boot a new comet, go into the command line and run the following command from the directory that was created during Urbit installation:
97+To boot a comet, go into the command line and run the following command from the directory that was created during Urbit installation:
90$ ./urbit -c mycomet
100$ ./urbit -c mycomet
@@ -102,13 +112,13 @@ http: live (insecure, loopback) on 12321
102~sampel_commet:dojo>
112~sampel_commet:dojo>
105−When your ship is finished booting, you will see either the `~sampel_commet:dojo>` or `~sampel_commet:chat-cli/` prompt. If you're seeing `:chat-cli` press `Ctrl-x` to switch into Dojo. At that point, you should permanently erase your keyfile from your machine.
115+When your ship is finished booting, you will see either the `~sampel_commet:dojo>` or `~sampel_commet:chat-cli/` prompt. If you're seeing `:chat-cli` press `Ctrl-x` to switch into Dojo.
107−To exit Urbit, use `Ctrl-d`. To start your ship up again, run `./urbit mycomet` from the directory that you first booted from. Now let's do some basic commands from inside your ship.
117+To exit Urbit, use `Ctrl-d`. To start your ship up again, run `./urbit mycomet` from the directory that you first booted from.
109### The Dojo
119### The Dojo
111−Welcome to your comet! Let's try our first command in the Dojo, the Urbit OS command line and Hoon REPL, to get oriented.
121+Let's try our first command in the Dojo, the Urbit OS command line and Hoon REPL, to get oriented.
113Type `(add 2 2)` into the Dojo. You should see the following:
123Type `(add 2 2)` into the Dojo. You should see the following:
@@ -134,7 +144,7 @@ The `>=` output means that a command was successful. Now you can see your ship's
135### Using Landscape
145### Using Landscape
137−Landscape is the Urbit web interface, and it's the best way to interact with your ship. Chrome and Brave are the recommended browsers for using Landscape. To get onto Landscape:
147+Landscape is the Urbit web interface, and it's the best way to interact with your ship. Chrome, Firefox, and Brave are the recommended browsers for using Landscape. To get onto Landscape:
1391. Start your ship. In the boot messages, 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.
1491. Start your ship. In the boot messages, 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.
1402. 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.
1502. 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.
@@ -149,26 +159,20 @@ Click that `Chat` type on your Landscape home page, and then click the `Join Cha
150You can send and receive messages here, just like any other chatroom.
160You can send and receive messages here, just like any other chatroom.
152−### Make a Note
162+## Getting an Urbit ID (Planet or Star)
154−Navigate back to your Landscape homepage. Typing `localhost` (or the correct equivalent) into your search bar does the trick.
156−Then click the `Publish` tile. Fill the fields as appropriate to make a new Notebook and invite anyone you want to be able to read it as a subscriber. A Notebook can be treated like a blogs, or a public list of notes. One you have made a Notebook, you can start posting entries to it. Navigate back to it at any time by clicking the tile.
158−## Planet Setup {#planet}
160−If you have a planet, you have a full and persistent peer on the Urbit network.
164Tlon doesn't currently sell or distribute Urbit IDs, but there are a few ways to get your own:
164Tlon doesn't currently sell or distribute Urbit IDs, but there are a few ways to get your own:
166- Getting an invitation from a friend
166- Getting an invitation from a friend
167- Purchasing an Urbit ID from a third party, such as [urbit.live](https://urbit.live), [OpenSea](https://opensea.io), [planet.market](https://planet.market/), or [Urbit Marketplace](https://urbitmarketplace.com/).
167- Purchasing an Urbit ID from a third party, such as [urbit.live](https://urbit.live), [OpenSea](https://opensea.io), [planet.market](https://planet.market/), or [Urbit Marketplace](https://urbitmarketplace.com/).
169+Note that when you buy a planet you may have to escape its star if the star your planet is linked to isn't operating. Ask around in the `urbit-community` chat as a comet first for help before purchasing.
171+If you already have a planet and need to escape its star, see [Escaping A Sponsor](@/using/operations/using-your-ship.md#escape).
169Tlon occasionally selects candidates to distribute invitations, and users operating galaxies and stars can spawn and distribute a finite number of stars and planets, respectively.
173Tlon occasionally selects candidates to distribute invitations, and users operating galaxies and stars can spawn and distribute a finite number of stars and planets, respectively.
171−### Using your Urbit ID {#id}
175+### Using your Urbit ID (Planet or Star) {#id}
173If you have an Urbit ID, you'll use the [Bridge](https://bridge.urbit.org) client to get your ship's *keyfile* before you can [boot your ship](#booting-your-ship). Your keyfile is a cryptographic secret that allows your Urbit instance to authenticate itself on the network, so you can't boot your planet without it. Your keyfile is deterministically derived from your other cryptographic secrets.
177If you have an Urbit ID, you'll use the [Bridge](https://bridge.urbit.org) client to get your ship's *keyfile* before you can [boot your ship](#booting-your-ship). Your keyfile is a cryptographic secret that allows your Urbit instance to authenticate itself on the network, so you can't boot your planet without it. Your keyfile is deterministically derived from your other cryptographic secrets.
@@ -176,13 +180,13 @@ If you have an Urbit ID, you'll use the [Bridge](https://bridge.urbit.org) clien
177Your Urbit ID is actually yours. As long as you control its cryptographic secrets, nobody can take it away from you. That's why it's important to know a little bit about the cryptographic architecture of Urbit secrets.
181Your Urbit ID is actually yours. As long as you control its cryptographic secrets, nobody can take it away from you. That's why it's important to know a little bit about the cryptographic architecture of Urbit secrets.
179−Urbit ID secrets operate as a system of separate but hierarchically realted Ethereum key-pairs. For any given ID, this system of key-pairs is referred to as a **Hierarchical Deterministic (HD) Wallet**. the Urbit HD wallet. Each of these Ethereum addresses have different powers over the same identity, from setting networking keys for communicating in the Urbit network to transferring ownership of identities. Important elements of the HD wallet:
183+Urbit ID secrets operate as a system of separate but hierarchically related Ethereum key-pairs. For any given ID, this system of key-pairs is referred to as a **Hierarchical Deterministic (HD) Wallet**. the Urbit HD wallet. Each of these Ethereum addresses have different powers over the same identity, from setting networking keys for communicating in the Urbit network to transferring ownership of identities. Important elements of the HD wallet:
181−- **Master Ticket**: The "password" at the top of the hierarchy that determines the ownership. All other secrets are derived from this. If the rest of the wallet is lost or compromised, the master ticket can rederive everything. You'll log into Bridge with this. Always keep your master ticket extremely safe.
185+- **Master Ticket**: The "password" at the top of the hierarchy that determines the ownership. All other secrets are derived from this. If the rest of the wallet is lost or compromised, the master ticket can derive everything. You'll log into Bridge with this. Always keep your master ticket extremely safe.
183- **Management Proxy**: Derived from the master ticket. Can perform non-ownership related operations such as configuring Urbit OS networking keys.
187- **Management Proxy**: Derived from the master ticket. Can perform non-ownership related operations such as configuring Urbit OS networking keys.
185−- **Keyfile**: Derived from the management proxy. Used as crytographic proof that your Urbit ship it is who it says it is. You use it to start up your ship for the first time.
189+- **Keyfile**: Derived from the management proxy. Used as cryptographic proof that your Urbit ship is who it says it is. You use it to start up your ship for the first time.
187### Getting Your Keyfile {#keyfile}
191### Getting Your Keyfile {#keyfile}
@@ -193,151 +197,15 @@ As mentioned previously, there are a few ways to acquire a planet. All methods,
1933. Once you're logged in, click the `OS` option.
1973. Once you're logged in, click the `OS` option.
1944. In resulting page, click the `Download Arvo Keyfile` button. You should receive a `.key` file that contains the secret needed to boot your ship. Hold on to this file.
1984. In resulting page, click the `Download Arvo Keyfile` button. You should receive a `.key` file that contains the secret needed to boot your ship. Hold on to this file.
196−## Installation
200+## Hosting
198−There are two supported ways of running an Urbit ship: using a [cloud service](#cloud), or running it [locally on your own machine](#local). We recommend using a cloud service for Urbit because it will likely be more reliable than running it locally and allows your ship to be easily accesed from anywhere, without worrying about forwarding ports to and from your home router or your Internet service provider blocking traffic on the default HTTP port. Using a cloud service costs money and has a more involved setup process, but it's more convenient to use than a local install.
200−A cloud service that we like is DigitalOcean, so we give instructions for running Urbit on that service in the section below.
202−If you use Amazon Web Services instead, take note: putting a swap file on Amazon's Elastic Block Store does not work well, and will likely result in your Urbit becoming unresponsive when it tries to access swapped memory. With Amazon instances, swap should only be used on [Instance Stores](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html).
204−### Option A: DigitalOcean {#cloud}
206−DigitalOcean, a cloud hosting platform, is a good option for hosting an Urbit ship.
210−Navigate to https://www.digitalocean.com/ and sign up with your email address. You'll need to add a credit cart or a PayPal to start an account. The final part of the registration process involves choosing what we're trying to get online. Simply choose "Ubuntu server." You'll be asked to create a special password for your "Droplet"; remember it. It's different from your DO account password, and it's used to access your Droplet remotely.
212−The default resources you'll be given with your Droplet is 1 GB of memory, 1 CPU, and 25 GB of storage for 5 USD per month. It must be noted that Urbit ships require at least 2GB of memory to be present, so you'll either need to upgrade your DO Droplet or set up swap space.
214−#### Resizing Your Droplet
216−If you're willing to spend a little bit of extra money, this is the easiest method for getting your Urbit online and running smoothly.
218−An Urbit instance needs 2GB of memory available -- it doesn't need to use all of it, it just needs know that it's there. This memory is in addition to anything that the operating system and other processes require.
220−1. On the sidebar, click `Droplets`.
221−2. There should one option with a name that looks like `ubuntu-s-1vcpu-1gb-nyc1-01`. Click on the the `More`, and on the resulting dropdown menu click `Resize Droplet`.
222−3. On the resize page there is an `On` button for your Droplet. Click it off.
223−4. Make sure the `CPU and RAM only` category is selected. Then scroll down and select the option that provides 3 GB of memory. This will bump your fee to 15 a months
224−5. Turn your Droplet back on.
226−Now you can continue onto installing the Urbit software on your Droplet.
228−#### Setting Up Swap Space
230−If you've set up a Droplet to have more than 2 GB of memory, skip this section.
232−Alternatively, if you don't want to pay the extra money, you can configure swap space to run on a smaller DO instance. Digital Ocean has a post on adding swap [here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-16-04) that will walk you through the process. Once you've completed, you can continue to installing Urbit on your Droplet.
234−#### Installing Urbit On Your Droplet
236−Let's access your Droplet by using SSH, which is a secure protocol for using a remote computer.
238−1. Find your Droplet's IP address on your DigitalOcean account. It will be under the `Droplets` option on the `Manage` sidebar. Copy the IP address and keep it handy.
239−2. Open you local computer's terminal. Then run the SSH command, which has the syntax `ssh root@1.2.3.4`, where `1.2.3.4` is the IP address that you copied. Your Droplet's default name is `root`, but this can be changed.
240−3. You'll be prompted with a password. Enter the one that you set earlier. If you see a block of messages beginning with something like `Welcome to Ubuntu 18.04.3 LTS (GNU/Linux 4.15.0-66-generic x86_64)` and ending with something like `root@ubuntu-s-1pvcu-1gb-nyc1-01:`, you're in!
242−Now that you're inside your Droplet, you'll want to install the Urbit binary. Run the following commands:
245−curl -O https://bootstrap.urbit.org/urbit-v0.10.8-linux64.tgz
246−tar xzf urbit-v0.10.8-linux64.tgz
247−cd urbit-v0.10.8-linux64
251−If you see a block of messages beginning with `Urbit: a personal server operating function`, then you've successfully installed the Urbit software, and it's time to copy your keyfile that from your local machine, the one that ends in `.key` that you got from the [Getting Your Keyfile](#keyfile) instructions. Open it with a text editor and keep it handy so you can copy it. Then return to the terminal window that's running your Droplet.
253−Now, on your Droplet, you'll want to use a Linux functionality called Scree. Screen is used to create virtual terminals (windows) to run persistent processes in the same remote session, so we don't have to close those processes whenever we want to do other things on our Droplet. This makes Screen perfect for running a remote Urbit ship.
255−To start Screen, enter
261−You'll be met with some copyright information. Hit enter or return to move past this info. Once you're inside Screen, you use `Ctrl-a` to tell it that you're about to enter a command. Screen is controlled through keyboard shortcuts. Here are some useful ones to be run inside a Screen:
263−- To create a new Screen window, enter `Ctrl-a` and then `c`.
264−- To exit a Screen window and go back to your regular Droplet terminal ("Detach" it), enter `Ctrl-a` and then `d`.
265−- To see all Screen shortcuts, enter `Ctrl-a` and then `?`.
267−There are a few useful Screen commands that can be run from your regular Droplet terminal.
269−- To see all running Screen windows, enter `screen -ls`. This is useful if you're not sure if you're inside a Screen window; if you are, it will show a window as "Attached". (Note that you'll only ever need one screen for the purposes of hosting an Urbit remotely)
270−- To return to the Screen window that you made ("Attach" it), enter `screen -r`.
271−- To delete *all* Screen windows, enter `killall screen`.
273−Now, let's put this information to use to boot your Urbit ship in a Screen window.
275−1. Enter `cd urbit-v0.10.8-linux64` to change your directory to the folder containing the Urbit binary.
276−2. Enter `screen -ls`. If you get anything but a message like `No Sockets found in /run/screen/S-root.`, run `killall screen` to wipe the slate clean.
277−3. Enter `screen` and skip past the information. You're in an attached Screen window now; enter `screen -ls` to verify this.
278−4. Open your keyfile on your local machine and copy the contents. On the Screen in your Droplet, enter `./urbit -w sampel-palnet -G rAnDoMkEy`, where `rAnDoMkEy` is the copied contents of the keyfile.
280−Your ship should be booting, and displaying a series of boot messages starting with `urbit 0.10.8`. A directory called `sampel-palnet/` and begin building your ship. It may take a few minutes.
282−When your ship is finished booting, you will see either the `~sampel-palnet:dojo>` or `~sampel-palnet:chat-cli/` prompt. If you're seeing `:chat-cli` press `Ctrl-x` to switch into Dojo. At that point, you should permanently erase your keyfile from your machine.
284−To shut down your ship, use `Ctrl-d`. Since you're running, you won't have much reason to do this often, since you should always have it running in your Droplet. More frequently you'll want to use `Ctrl-a` and then `d` to go back to your Droplet's command line while keeping your planet running on a detached Screen. Then, to return to your ship, run `screen -r`.
286−If you need to shut down your ship, start it up again by running `./urbit sampel-palnet/` from the directory where your Urbit binary is saved. Note that in this usage, `sampel-palnet/` is the path of a folder, which by default is located in the same folder as the Urbit binary. This folder is called your ship's **pier**.
288−Never boot multiple instances of your ship at the same time. You can prevent this from happening accidently by only ever keeping a single copy of your pier.
290−Now you're ready to explore the network and make your ship easily accessible from a remote browser. Jump to the [System Administration](#admin) section to do so.
292−### Option B: Local Installation {#local}
294−You can run an Urbit on your laptop, your desktop, or an old tower in your closet. There are fewer steps than installing it on a cloud service, but it won't be as slick of an experience in the long run.
202+There are two supported ways of running an Urbit ship: using a cloud service, or running it locally on your own machine. Most users run things locally at first, but we recommend eventually using a cloud service for Urbit because it allows your ship to be accessed from anywhere on multiple devices. Hosting your ship in the cloud also allows it to always be online and ready for OTA updates. It's technically possible to run your Urbit ship on a home server, but ISPs often restrict this to business plans and opening up your home network to the internet can be unsafe if done improperly.
296−The Urbit binary runs on a Unix-like operating system. We have different installation instructions for different platforms. To install and run Urbit OS, the Urbit OS and its binary, run the commands that are listed for your operating system.
204+We have a guide for [hosting your ship on DigitalOcean](@/using/operations/hosting.md) which we've found works well, but any cloud hosting service should work.
298−Once you've followed the appropriate install instructions, you can check if everything went right by running the `./urbit` command. Installation was successful if you get a block of output that begins with the line below:
206+### Booting Your Planet
301−Urbit: a personal server operating function
307−curl -O https://bootstrap.urbit.org/urbit-v0.10.8-darwin.tgz
308−tar xzf urbit-v0.10.8-darwin.tgz
309−cd urbit-v0.10.8-darwin
316−curl -O https://bootstrap.urbit.org/urbit-v0.10.8-linux64.tgz
317−tar xzf urbit-v0.10.8-linux64.tgz
318−cd urbit-v0.10.8-linux64
322−To access your Urbit via HTTP on port 80 on Ubuntu, you may need to run the following:
325−sudo apt-get install libcap2-bin
326−sudo setcap 'cap_net_bind_service=+ep' /path/to/urbit
328−(Where `urbit` is the urbit executable downloaded with `curl` prior)
332−Please note that this method of installing Urbit is more experimental, and we may not be able to assist you if you encounter issues related to WSL 2, but these instructions have been tested and verified for WSL 2 + Ubuntu 18.04 LTS.
334−Urbit cannot run on Windows itself, but there is a convenient way to run a Linux distro using the [Windows Subsystem for Linux 2](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux), an initiative by Microsoft to bring Linux to Windows 10. For Urbit to work, it is necessary to [install WSL 2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install) and not just WSL, since version 2 uses virtualization and the real Linux kernel under the hood.
336−Once WSL 2 is installed, open a Linux terminal in Windows and then follow the Linux installation instructions above. For 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, by typing `cd ~`.
338−### Booting Your Ship Locally
340−Now the rubber meets the road. You'll be booting your ship with the keyfile that you downloaded from Bridge [earlier in this document](#id).
208+You'll be booting your ship with the keyfile that you downloaded from Bridge [earlier in this document](#id).
342Note that this section is only for booting a ship that uses the live Urbit network.
210Note that this section is only for booting a ship that uses the live Urbit network.
@@ -368,59 +236,13 @@ Or, if you'd prefer to copy your key in, you can run:
369Either command will create a directory called `sampel-palnet/` and begin building your ship. It may take a few minutes.
237Either command will create a directory called `sampel-palnet/` and begin building your ship. It may take a few minutes.
371−When your ship is finished booting, you will see either the `~sampel-palnet:dojo>` or `~sampel-palnet:chat-cli/` prompt. If you're seeing `:chat-cli` press `Ctrl-x` to switch into Dojo.
239+When your ship is finished booting, you will see either the `~sampel-palnet:dojo>` or `~sampel-palnet:chat-cli/` prompt. If you're seeing `:chat-cli` press `Ctrl-x` to switch into Dojo. At that point, you should permanently erase your keyfile from your machine.
373−**Important:** once a key has been used to boot a ship onto the network, it cannot be used to boot that ship again later - doing so will cause communication problems with other ships. For this reason you should **delete the keyfile from your machine once your ship has booted successfully**. (If you do use the same key twice, you'll need to conduct a [personal breach](#breaches) to restore your ship to full functionality).
375To shut down your ship, use `Ctrl-d`. To start your ship up again, run `./urbit sampel-palnet/` from the directory where your Urbit binary is saved. Note that in this usage, `sampel-palnet/` is the path of a folder, which by default is located in the same folder as the Urbit binary. This folder is called your ship's **pier**, and you can put it wherever you like.
241To shut down your ship, use `Ctrl-d`. To start your ship up again, run `./urbit sampel-palnet/` from the directory where your Urbit binary is saved. Note that in this usage, `sampel-palnet/` is the path of a folder, which by default is located in the same folder as the Urbit binary. This folder is called your ship's **pier**, and you can put it wherever you like.
377Never boot multiple instances of your ship at the same time. You can prevent this from happening on accident by only ever keeping a single copy of your pier.
243Never boot multiple instances of your ship at the same time. You can prevent this from happening on accident by only ever keeping a single copy of your pier.
379−## System Administration {#admin}
245+**Important:** once a key has been used to boot a ship onto the network, it cannot be used to boot that ship again later - doing so will cause communication problems with other ships. For this reason you should **delete the keyfile from your machine once your ship has booted successfully**. (If you do use the same key twice, you'll need to conduct a [personal breach](#breaches) to restore your ship to full functionality).
381−Welcome to your ship. Let's start exploring.
386−Let's try our first command in the Dojo, the Urbit OS command line and Hoon REPL, to get oriented.
388−Type `(add 2 2)` into the Dojo. You should see the following:
391−~sampel-palnet:dojo> (add 2 2)
394−When you press Enter, you should see this:
401−Good, your Dojo is working correctly. Now let's run our first useful command in the Dojo. The first thing you generally want to do with a new ship is to **mount** it. A ship being mounted means that it has a presence on your Unix filesystem, allowing files to be shared between Unix and your ship. To mount your ship, type `|mount %` at the Dojo prompt.
408−The `>=` output means that a command was successful. Now you can see your ship's files in its Unix directory.
410−### Setting Up DNS {#dns}
412−Landscape is the Urbit web interface, and it's the best way to interact with your ship. Chrome and Brave are the recommended browsers for using Landscape. The best way to access Landscape is to set DNS proxying, so that you can access your ship easily from a web browser on any computer.
414−1. Start your ship. In the boot messages, 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.
415−2. 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`. Alternatively, you access landscape by navigating to `sampel-palnet.arvo.network` into your URL bar, where `sampel-palnet` is the name of your ship, without the `~`. You will need to [set up DNS proxying](@/using/operations/using-your-ship.md#dns-proxying) to use this option. To do so, simply run this command in your ship's Dojo: `> -dns-address &dns-address [%if .1.2.3.4]`, where `.1.2.3.4` is the IP address.
416−3. Type `+code` into your ship's Dojo. Copy-paste the returned code into the field asking for it in the browser page.
417−4. You're in! Now you can explore apps such as Chat for messages, Publish for blogging, and Weather.
419−### Joining the community
421−Once you are in Landscape we recommend joining the Urbit Community group. You will need to obtain an invite, which can be had by first joining the `~/~dopzod/urbit-help` chat channel and asking for an invitation from there. This is most likely to succeed quickly during standard US West Coast working hours. Once you have the invite you can accept it by navigating to your Groups by clicking on All Groups in the upper left hand corner of Landscape, then Manage All Groups, and in there you should see an invitation. From this interface you can join the various Chat, Publish, and Link instances contained in the group.
423−You can join `~/~dopzod/urbit-help` from either Landscape or chat-cli. To join from Landscape first click on the Messaging tile on the home screen. Then press Join Chat in the upper left corner and enter `~/~dopzod/urbit-help` into the prompt and press Join Chat. To join from chat-cli, first make sure your console has been switched from Dojo to the `:chat-cli` application by pressing `Ctrl-x`. The prompt will display `~sampel-palnet:chat-cli` if in the correct mode. Then type `;join ~/~dopzod/urbit-help` and press Enter.
425### Updating to the latest binary
247### Updating to the latest binary
@@ -440,7 +262,7 @@ For details on breaching, please read the [Guide to Breaches](@/docs/tutorials/g
441If you find a bug, please report it as an Issue at https://github.com/urbit/urbit/issues/new/choose. Give as much detail as possible with your bug report so the engineer team can fix it.
263If you find a bug, please report it as an Issue at https://github.com/urbit/urbit/issues/new/choose. Give as much detail as possible with your bug report so the engineer team can fix it.
443−## Running a Supernode
265+## Running a Star or Galaxy {#supernode}
445Setting up and running a star or galaxy is a little bit different from setting up and running a planet.
267Setting up and running a star or galaxy is a little bit different from setting up and running a planet.
@@ -457,12 +279,10 @@ Galaxies are rare and extremely valuable, meaning that there is no liquid market
458As mentioned before, stars are valuable. You are solely responsible for safeguarding your seeds and secret keys, and arming yourself with the computer-security knowledge that is attendant upon that safeguarding. You act at your own risk in reliance upon the contents of the manual. In no way is the Tlon Corporation responsible for the actions, decisions, or other behavior taken or not taken by you in reliance upon this manual.
280As mentioned before, stars are valuable. You are solely responsible for safeguarding your seeds and secret keys, and arming yourself with the computer-security knowledge that is attendant upon that safeguarding. You act at your own risk in reliance upon the contents of the manual. In no way is the Tlon Corporation responsible for the actions, decisions, or other behavior taken or not taken by you in reliance upon this manual.
460−It’s a good idea to store your keys redundantly; for example, on both a USB stick and a piece of paper in the safe, in case one of those methods fails. If you deem a key to be valuable enough, you can shard it into thirds and store each third in secure, geographically distributed locations. Consider these storage media options:
282+It’s a good idea to store your keys redundantly in case one method fails. If you deem a key to be valuable enough, you can shard it into thirds and store each third in secure, geographically distributed locations. Consider these storage media options:
462−- Printing the secret on a piece of paper. However, paper wallets are vulnerable to various forms of physical damage, such as rot, water damage, smoke, or fire. Laminating the paper can mitigates some of these risks, but the lamination can potentially trap moisture. Make sure that you trust the printer: some have memory and network connections.
463−- Storing the secret on a brand-new USB stick or hardware wallet (such as a Ledger) that is never connected to a networked machine.
464−- Engraving the secret on a strip of stainless steel. This medium is resistant to both water damage and fire damage.
284+- Storing the secret on a hardware wallet that is never connected to a networked machine.
285+- There are products that let you store the key on steel. This medium is resistant to both water damage and fire damage.
467### Getting a Star's Keyfile
287### Getting a Star's Keyfile
@@ -473,79 +293,9 @@ It’s a good idea to store your keys redundantly; for example, on both a USB st
474### Star: Setup And Install
294### Star: Setup And Install
476−Because of their need for near-perfect uptime Stars should use cloud services. We like to use DigitalOcean (DO), and our instructions here support that service.
296+Because of their need for near-perfect uptime Stars should be hosted on cloud services.
478−Navigate to https://www.digitalocean.com/ and sign up. You'll need to add a credit cart or a PayPal to start an account. The final part of the registration process involves choosing what we're trying to get online. Simply choose "Ubuntu server." You'll be asked to create a special password for your "Droplet"; remember it. It's different from your DO account password, and it's used to access your Droplet remotely.
480−The default resources you'll be given with your Droplet is 1 GB of memory, 1 CPU, and 25 GB of storage for 5 USD per month. It must be noted that Urbit ships require at least 2GB of memory to be present, so you'll either need to upgrade your DO Droplet.
482−#### Resizing Your Droplet
484−An Urbit instance needs 2GB of memory available -- it doesn't need to use all of it, it just needs know that it's there. This memory is in addition to anything that the operating system and other processes require.
486−1. On the sidebar, click `Droplets`.
487−2. There should one option with a name that looks like `ubuntu-s-1vcpu-1gb-nyc1-01`. Click on the the `More`, and on the resulting dropdown menu click `Resize Droplet`.
488−3. On the resize page there is an `On` button for your Droplet. Click it off.
489−4. Make sure the `CPU and RAM only` category is selected. Then scroll down and select the option that provides 3 GB of memory. This will bump your fee to 15 a months
490−5. Turn your Droplet back on.
492−Now you can continue onto installing the Urbit software on your Droplet.
494−#### Installing Urbit On Your Droplet
496−Let's access your Droplet by using SSH, which is a secure protocol for using a remote computer.
498−1. Find your Droplet's IP address on your DigitalOcean account. It will be under the `Droplets` option on the `Manage` sidebar. Copy the IP address and keep it handy.
499−2. Open you local computer's terminal. Then run the SSH command, which has the syntax `ssh root@1.2.3.4`, where `1.2.3.4` is the IP address that you copied. Your Droplet's default name is `root`, but this can be changed.
500−3. You'll be prompted with a password. Enter the one that you set earlier. If you see a block of messages beginning with something like `Welcome to Ubuntu 18.04.3 LTS (GNU/Linux 4.15.0-66-generic x86_64)` and ending with something like `root@ubuntu-s-1pvcu-1gb-nyc1-01:`, you're in!
502−Now that you're inside your Droplet, you'll want to install the Urbit binary. Run the following commands:
505−curl -O https://bootstrap.urbit.org/urbit-v0.10.8-linux64.tgz
506−tar xzf urbit-v0.10.8-linux64.tgz
507−cd urbit-v0.10.8-linux64
511−If you see a block of messages beginning with `Urbit: a personal server operating function`, then you've successfully installed the Urbit software, and it's time to copy your keyfile that from your local machine, the one that ends in `.key` that you got from the [Getting Your Keyfile](#keyfile) instructions. Open it with a text editor and keep it handy so you can copy it. Then return to the terminal window that's running your Droplet.
513−Now, on your Droplet, you'll want to use a Linux functionality called Scree. Screen is used to create virtual terminals (windows) to run persistent processes in the same remote session, so we don't have to close those processes whenever we want to do other things on our Droplet. This makes Screen perfect for running a remote Urbit ship.
515−To start Screen, enter
521−You'll be met with some copyright information. Hit enter or return to move past this info. Once you're inside Screen, you use `Ctrl-a` to tell it that you're about to enter a command. Screen is controlled through keyboard shortcuts. Here are some useful ones to be run inside a Screen:
523−- To create a new Screen window, enter `Ctrl-a` and then `c`.
524−- To exit a Screen window and go back to your regular Droplet terminal ("Detach" it), enter `Ctrl-a` and then `d`.
525−- To see all Screen shortcuts, enter `Ctrl-a` and then `?`.
527−There are a few useful Screen commands that can be run from your regular Droplet terminal.
529−- To see all running Screen windows, enter `screen -ls`. This is useful if you're not sure if you're inside a Screen window; if you are, it will show a window as "Attached". (Note that you'll only ever need one screen for the purposes of hosting an Urbit remotely)
530−- To return to the Screen window that you made ("Attach" it), enter `screen -r`.
531−- To delete *all* Screen windows, enter `killall screen`.
533−Now, let's put this information to use to boot your Urbit ship in a Screen window.
535−1. Enter `cd urbit-v0.10.8-linux64` to change your directory to the folder containing the Urbit binary.
536−2. Enter `screen -ls`. If you get anything but a message like `No Sockets found in /run/screen/S-root.`, run `killall screen` to wipe the slate clean.
537−3. Enter `screen` and skip past the information. You're in an attached Screen window now; enter `screen -ls` to verify this.
538−4. Open your keyfile on your local machine and copy the contents. On the Screen in your Droplet, enter `./urbit -w sampel -G rAnDoMkEy`, where `rAnDoMkEy` is the copied contents of the keyfile.
540−Your ship should be booting, and displaying a series of boot messages starting with `urbit 0.10.8`. A directory called `sampel/` and begin building your ship. It may take a few minutes.
542−When your ship is finished booting, you will see either the `~sampel:dojo>` or `~sampel:chat-cli/` prompt. If you're seeing `:chat-cli` press `Ctrl-x` to switch into Dojo. At that point, you should permanently erase your keyfile from your machine.
544−To shut down your ship, use `Ctrl-d`. Since you're running, you won't have much reason to do this often, since you should always have it running in your Droplet. More frequently you'll want to use `Ctrl-a` and then `d` to go back to your Droplet's command line while keeping your planet running on a detached Screen. Then, to return to your ship, run `screen -r`.
546−If you need to shut down your ship, start it up again by running `./urbit sampel` from the directory where your Urbit binary is saved. Note that in this usage, `sampel/` is the path of a folder, which by default is located in the same folder as the Urbit binary. This folder is called your ship's **pier**.
548−Never boot multiple instances of your ship at the same time. You can prevent this from happening accidently by only ever keeping a single copy of your pier.
298+We have a guide for [hosting on DigitalOcean](@/using/operations/hosting.md), but any cloud provider should work.
550#### Maintaining a Star
300#### Maintaining a Star