a8b1ef7 · urbit.org · git.iko.soy

git.iko.soy/urbit.org

on master help sign in

using: update getting-started, using sidebars

a8b1ef7Matilde Park5 years ago

content/getting-started/cli.md+9−8

compare with master

unifiedsplit

@@ -1,5 +1,5 @@

1+++

2−title = "Installing Urbit using the command line"

2+title = "Command line install"

3weight = 2

4description = "Installation instructions for power users."

5+++

@@ -18,6 +18,7 @@ curl -JLO https://urbit.org/install/mac/latest

18tar zxvf ./darwin.tgz --strip=1

19~/urbit/urbit

20```

21+

21 </div>

22 </div>

23 <input type="radio" id="linux" name="os">

24 <input type="radio" id="linux" name="os">

@@ -38,6 +39,7 @@ Linux users may need to run this command in another terminal window to access yo

38sudo apt-get install libcap2-bin

39sudo apt-get install libcap2-bin

39sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit

40sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit

40```

41```

42+

41</div>

43</div>

43 <input type="radio" id="windows" name="os">

45 <input type="radio" id="windows" name="os">

@@ -49,6 +51,7 @@ sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit

49Urbit 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/).

51Urbit 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/).

51For 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 ~`.

53For 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 ~`.

54+

52</div>

55</div>

53</div>

56</div>

@@ -68,7 +71,7 @@ The **ID** is similar to a username and password on another site. The difference

69There are five kinds of Urbit IDs but to get started you only need to know about two: we call them **planets** and **comets**.

72There are five kinds of Urbit IDs but to get started you only need to know about two: we call them **planets** and **comets**.

71−***

74+---

73**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.

76**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.

@@ -78,7 +81,7 @@ A planet name looks like `~sampel-palnet`.

79[Find a planet to purchase](/getting-started/planet#purchase)

82[Find a planet to purchase](/getting-started/planet#purchase)

81−***

84+---

83**Comets** are practically unlimited and free to acquire. At present, these are a great way to try out the network for free.

86**Comets** are practically unlimited and free to acquire. At present, these are a great way to try out the network for free.

@@ -86,8 +89,7 @@ A comet name looks like `~dasres-ragnep-lislyt-ribpyl--mosnyx-bisdem-nidful-marz

87[Read more about Urbit ID here](/understanding-urbit/urbit-id)

90[Read more about Urbit ID here](/understanding-urbit/urbit-id)

89−

92+---

90−***

92To boot a comet, go into the command line and run the following command from the `urbit` directory you created during [Urbit installation](#installing-urbit):

94To boot a comet, go into the command line and run the following command from the `urbit` directory you created during [Urbit installation](#installing-urbit):

@@ -122,7 +124,7 @@ Urbit is an entirely new computer, so by default it drops you into the "dojo," w

122At the moment, the most common way to use Urbit is through a web app named [Landscape](/docs/glossary/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`.

124At the moment, the most common way to use Urbit is through a web app named [Landscape](/docs/glossary/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`.

123

125

1241. 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.)

1261. 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.)

125−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`. You'll be met with a login prompt.

127+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`. You'll be met with a login prompt.

1263. 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.

1283. 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.

1274. Once in, take a look around and read the instructions on screen. If you ever get logged out, follow these instructions again.

1294. Once in, take a look around and read the instructions on screen. If you ever get logged out, follow these instructions again.

128

130

@@ -165,7 +167,6 @@ A comet also comes with a long and fairly unmemorable name whereas a planet has

165

167

166[To read instructions on how to purchase and use a planet, visit this page](/getting-started/planet).

168[To read instructions on how to purchase and use a planet, visit this page](/getting-started/planet).

167

169

168−

169<style>

170<style>

170 .os {

171 .os {

171 display: flex;

172 display: flex;

@@ -205,4 +206,4 @@ A comet also comes with a long and fairly unmemorable name whereas a planet has

205 .os input[type='radio']:checked + label + .tab {

206 .os input[type='radio']:checked + label + .tab {

206 display: block;

207 display: block;

207}

208}

208−</style>

209+</style>

content/getting-started/planet.md+3−5

@@ -1,5 +1,5 @@

1+++

2−title = "Setting up your planet"

2+title = "Setting up your urbit"

3weight = 1

4description = "Getting started with a permanent Urbit identity."

5+++

@@ -29,16 +29,15 @@ Current hosting providers are:

29- [Tlon Corporation](https://tlon.io): Tlon is the creator of Landscape and is primarily responsible for the creation and maintenance of the Urbit project itself.

30- [Get an Urbit ID](https://www.geturbitid.com/): Get an Urbit ID was the first hosting provider and is run by a member of the Urbit community.

32−

33### Choose to run your planet on your computer or on a cloud service

32### Choose to run your planet on your computer or on a cloud service

35−Urbit must run on an existing computer somewhere. Most users run their planet on their personal computer, but we recommend eventually using a cloud service (Digital Ocean, Linode, etc) because it allows your planet to be accessed from anywhere on multiple devices. Hosting your planet in the cloud also allows it to always be online and ready for automatic updates. You are welcome to run from your personal computer and switch to the cloud later...all without losing any data!

34+Urbit must run on an existing computer somewhere. Most users run their planet on their personal computer, but we recommend eventually using a cloud service (Digital Ocean, Linode, etc) because it allows your planet to be accessed from anywhere on multiple devices. Hosting your planet in the cloud also allows it to always be online and ready for automatic updates. You are welcome to run from your personal computer and switch to the cloud later...all without losing any data!

37There is a guide for [hosting your planet on DigitalOcean](/using/running/hosting) and [hosting your planet on Linode](https://jeremytunnell.com/2021/01/09/how-to-install-urbit-on-a-linode-vps), but any cloud hosting service should work.

36There is a guide for [hosting your planet on DigitalOcean](/using/running/hosting) and [hosting your planet on Linode](https://jeremytunnell.com/2021/01/09/how-to-install-urbit-on-a-linode-vps), but any cloud hosting service should work.

39### Get your keyfile {#keyfile}

38### Get your keyfile {#keyfile}

41−If you received an email invite to Urbit, the master ticket should be a .pdf file in the passport folder inside the archive that you downloaded. **If you bought your planet or someone sent you one you probably do not have a master ticket, and you probably don't need one. Do not issue a new master ticket unless you are sure you need to.**

40+If you received an email invite to Urbit, the master ticket should be a .pdf file in the passport folder inside the archive that you downloaded. **If you bought your planet or someone sent you one you probably do not have a master ticket, and you probably don't need one. Do not issue a new master ticket unless you are sure you need to.**

431. Connect to [Bridge](https://bridge.urbit.org). (Bridge is like an Urbit wallet)

421. Connect to [Bridge](https://bridge.urbit.org). (Bridge is like an Urbit wallet)

442. Enter the name of your planet and the associated master ticket if you have one. Click the "Metamask, Mnemonic, Hardware Wallet..." button if you don't have a master ticket.

432. Enter the name of your planet and the associated master ticket if you have one. Click the "Metamask, Mnemonic, Hardware Wallet..." button if you don't have a master ticket.

@@ -122,7 +121,6 @@ use |ota %disable or |ota ~sponsor %kids to reset it

122

121

123If for some reason your sponsor (in this case, `~dopzod`) is not responding, read instructions on [escaping your sponsor](/using/id/using-bridge#escaping-your-sponsor).

122If for some reason your sponsor (in this case, `~dopzod`) is not responding, read instructions on [escaping your sponsor](/using/id/using-bridge#escaping-your-sponsor).

124

123

125−

126## Next Steps

124## Next Steps

127

125

128Now that you’re up and running, take some time to deepen your understanding by checking out some of our other guides:

126Now that you’re up and running, take some time to deepen your understanding by checking out some of our other guides:

pages/getting-started/[[...slug]].js+20−2

@@ -30,7 +30,7 @@ const breadcrumbs = (posts, paths) => {

30};

32const childPages = (thisLink, children, level = 0) => (

33− <ul className="pl-1">

33+ <ul className="pl-0">

34 {children?.map((child) => (

35 <li>{pageTree(join(thisLink, child.slug), child, level)}</li>

36 ))}

@@ -43,7 +43,7 @@ const pageTree = (thisLink, tree, level = 0) => {

43 const isThisPage = router.asPath === thisLink;

45 const pageItemClasses = classnames({

46− "pl-4 text-black text-base hover:text-green": level === 0,

46+ "pl-0 font-semibold text-gray text-base hover:text-green": level === 0,

47 "pl-8 text-black text-base hover:text-green": level === 1,

48 "pl-12 text-black text-base hover:text-green": level === 2,

49 "dot relative": isThisPage,

@@ -60,6 +60,15 @@ const pageTree = (thisLink, tree, level = 0) => {

60};

62export default function UsingLayout({ posts, data, params, search, markdown }) {

63+ const router = useRouter();

64+ const isSelected = "/getting-started".includes(router.asPath);

65+ const selectedClasses = classnames({

66+ dot: isSelected,

67+ "text-green": isSelected,

68+ "text-gray": !isSelected,

69+ });

70+ const rootClasses = "pl-0 font-semibold text-base hover:text-green";

71+

63 return (

72 return (

64 <>

73 <>

65 <Head>

74 <Head>

@@ -67,6 +76,15 @@ export default function UsingLayout({ posts, data, params, search, markdown }) {

67 </Head>

76 </Head>

68 <div className="flex w-screen h-screen min-h-screen w-screen">

77 <div className="flex w-screen h-screen min-h-screen w-screen">

69 <Sidebar search={search}>

78 <Sidebar search={search}>

79+ <ul>

80+ <li>

81+ <Link href="/getting-started">

82+ <a className={`relative ${selectedClasses} ${rootClasses}`}>

83+ Getting Started

84+ </a>

85+ </Link>

86+ </li>

87+ </ul>

70 {childPages("/getting-started", posts.pages)}

88 {childPages("/getting-started", posts.pages)}

71 </Sidebar>

89 </Sidebar>

72 <ContentArea

90 <ContentArea

pages/using/[[...slug]].js+3−3

@@ -50,10 +50,10 @@ const pageTree = (thisLink, tree, level = 0) => {

50 });

52 const headingItemClasses = classnames({

53− "pl-0 text-black text-base font-semibold hover:text-green leading-relaxed":

53+ "pl-0 text-gray text-base font-semibold hover:text-green leading-relaxed":

54 level === 0,

55− "pl-4 text-black text-base font-semibold hover:text-green": level === 1,

55+ "pl-4 text-gray text-base font-semibold hover:text-green": level === 1,

56− "pl-8 text-black text-base hover:text-green": level === 2,

56+ "pl-8 text-gray text-base hover:text-green": level === 2,

57 });

59 const pageItemClasses = classnames({