on master help sign in
Merge pull request #1964 from urbit/i/1962/cli-dock-docs
commit6b7747441918c9a94aeafafc57e1a37b2b7ca1f6 authorZach Alberico <git@zalberico.com> dateTue 17 Jan 2023, 12:39 (4 years ago) parent4ddf108c0218ec
1 file changed+56−20
content/getting-started/cli.md+56−20
content/getting-started/cli.md+56−20
@@ -4,9 +4,10 @@ weight = 2
44description = "Installation instructions for power users."
55+++
66
7−If you're a power user, you can run the Urbit virtual machine directly using the
8−command line. This can be run on your local machine or a server in the cloud, we
9−just cover the general case here.
7+If you're a power user, you can run the Urbit runtime (Vere) using the command
8+line. This can be run on your local machine or a server in the cloud, we
9+just cover the local case here. The runtime is what interprets the Urbit kernel
10+code (Arvo) into commands your specific machine (macOS or Linux) understands.
1011
1112Note there is a much more comprehensive [cloud hosting
1213guide](https://operators.urbit.org/manual/running/hosting) which walks through
@@ -35,7 +36,8 @@ will still run fine, but you may run out of space some months down the line.
3536### 2. Install Urbit
3637
3738Choose your operating system and run the given command in your terminal to
38−download the Urbit runtime:
39+download the Urbit runtime, this command downloads the latest build, unpacks
40+it, and runs the binary with no arguments to show you the help output:
3941
4042{% tabs %}
4143
@@ -45,8 +47,8 @@ download the Urbit runtime:
4547curl -L https://urbit.org/install/linux-x86_64/latest | tar xzk --transform='s/.*/urbit/g' && ./urbit
4648```
4749
48−> Linux users may need to run this command in another terminal window to access
49−> your urbit on port 80:
50+> Linux users need to run this command in another terminal window to access
51+> your urbit on port 80, otherwise it'll default to port 8080:
5052>
5153> ```shell
5254> sudo apt-get install libcap2-bin
@@ -61,8 +63,8 @@ curl -L https://urbit.org/install/linux-x86_64/latest | tar xzk --transform='s/.
6163curl -L https://urbit.org/install/linux-aarch64/latest | tar xzk --transform='s/.*/urbit/g' && ./urbit
6264```
6365
64−> Linux users may need to run this command in another terminal window to access
65−> your urbit on port 80:
66+> Linux users need to run this command in another terminal window to access
67+> your urbit on port 80, otherwise it'll default to port 8080:
6668>
6769> ```shell
6870> sudo apt-get install libcap2-bin
@@ -128,8 +130,8 @@ comet can be booted with the `-c` option:
128130./urbit -c mycomet
129131```
130132
131−> `mycomet` will be the name given to the data folder it will create. You can
132−> choose any name you like.
133+> `mycomet` will be the name given to the folder it will create.
134+> You can choose any name you like.
133135
134136It may take a while to initialize the comet (usually only a couple of minutes,
135137but it could take longer). When it's done, it'll take you to the dojo prompt
@@ -158,9 +160,9 @@ idea to enable updates with the following command in the dojo:
158160|ota (sein:title our now our)
159161```
160162
161−Lastly, while the dojo is quite powerful, most people use their urbit via
162−Landscape, the browser-based UI. In order to access Landscape, you need your web
163−login code. You can get this by running the following command in the dojo:
163+Lastly most people use their urbit via Landscape, the browser-based UI. In order
164+to access Landscape, you need your web login code. You can get this by running
165+the following command in the dojo:
164166
165167```
166168+code
@@ -189,7 +191,7 @@ keyfile):
189191./urbit -w sampel-palnet -k sampel-palnet-1.key
190192```
191193
192−This will create a data folder with the name of your planet and begin booting.
194+This will create a folder with the name of your planet and begin booting.
193195It may take a while to initialize the planet (usually only a couple of minutes,
194196but it could take longer). When it's done, it'll take you to the dojo prompt
195197(the dojo is Urbit's shell):
@@ -209,8 +211,8 @@ folder, so you can start it up again by doing:
209211./sampel-palnet/.run
210212```
211213
212−While the dojo is quite powerful, most people use their urbit via Landscape, the
213−browser-based UI. In order to access Landscape, you need your web login code.
214+Most people use their urbit via Landscape, the browser-based UI.
215+In order to access Landscape, you need your web login code.
214216You can get this by running the following command in the dojo:
215217
216218```
@@ -222,8 +224,8 @@ It'll spit out a code that'll look something like `lidlut-tabwed-pillex-ridrup`
222224to the clipboard.
223225
224226One last thing: The `sampel-palnet-1.key` keyfile is only needed once, when you
225−first boot your planet. Now that it's booted, it's good security practice to
226−delete that keyfile.
227+first boot your planet. **Now that it's booted, it's good security practice to
228+delete that keyfile.**
227229
228230{% /tab %}
229231
@@ -244,8 +246,42 @@ Whichever address and port it says there is the one to open in the browser.
244246
245247Once open, you'll be presented with the login screen. Paste in the web login
246248code you copied from the dojo in the previous step and hit "continue". You'll
247−now be taken to your homescreen, with tiles for the default apps such as Groups
248−and Terminal.
249+now be taken to your homescreen, with tiles for the default apps such as Groups,
250+Talk, and Terminal.
251+
252+### 5. Runtime Upgrades
253+
254+When new versions of the Urbit runtime (Vere) are available, you'll have to
255+shutdown your urbit and then run the `next` command in order to upgrade.
256+```
257+:dojo> |exit
258+<pier>/.run next
259+```
260+Note that `<pier>` in this case is the folder that was created when you first booted
261+your urbit. When you run this command your urbit will download the latest binary
262+and place it inside the `.bin` directory inside your pier folder. You can then
263+start your ship with the following and you'll be on the latest runtime version:
264+```
265+<pier>/.run
266+```
267+> Linux users need to run this command in another terminal window to access
268+> your urbit on port 80 every time you upgrade your runtime (otherwise it'll
269+> default to port 8080):
270+>
271+> ```shell
272+> sudo apt-get install libcap2-bin
273+> sudo setcap 'cap_net_bind_service=+ep' ./urbit
274+> ```
275+
276+If you've been running Urbit for a while (from before runtime version 1.9)
277+and these `.run` commands don't work for you, it probably means you need to
278+[dock](https://operators.urbit.org/manual/running/vere#dock) your pier.
279+You can do this with the following command:
280+```
281+./urbit dock <pier>
282+```
283+Then `.run` should work as expected and future runtime upgrades can be done via
284+`next`.
249285
250286### Next steps
251287