on master help sign in
Merge pull request #468 from zalberico/master

docs: add binary upgrade instructions

commit789989468552a3b6310fa82b1e5ae85bada48d94 authormatildepark <matilde@tlon.io> dateFri 4 Sep 2020, 18:53 (6 years ago) parent35177de8cc7e96
2 files changed+46−13
content/using/install.md+45−10 content/using/operations/hosting.md+1−3
content/using/install.md+45−10
@@ -45,19 +45,21 @@ Urbit: a personal server operating function
4545### macOS
4646
4747```sh
48+mkdir urbit
49+cd urbit
4850curl -O https://bootstrap.urbit.org/urbit-v0.10.8-darwin.tgz
4951tar xzf urbit-v0.10.8-darwin.tgz
50−cd urbit-v0.10.8-darwin
51−./urbit
52+./urbit-v0.10.8-darwin/urbit
5253```
5354
5455### Linux (64-bit)
5556
5657```sh
58+mkdir urbit
59+cd urbit
5760curl -O https://bootstrap.urbit.org/urbit-v0.10.8-linux64.tgz
5861tar xzf urbit-v0.10.8-linux64.tgz
59−cd urbit-v0.10.8-linux64
60−./urbit
62+./urbit-v0.10.8-linux64/urbit
6163```
6264
6365To access your Urbit via HTTP on port 80 on Ubuntu, you may need to run the following:
@@ -80,6 +82,8 @@ Once WSL 2 is installed, open a Linux terminal in Windows and then follow the Li
8082
8183Now that you have Urbit installed you can start it up with an ID.
8284
85+You should have an `urbit` directory with two files in it: the `urbit-v0.XX.X-<OS>` directory, and the .tgz of that directory. The .tgz file can now be safely deleted.
86+
8387If this is your first time using Urbit, it'll be easiest to start with a comet in order to get on the network.
8488
8589### Comet: Install and Setup {#comet}
@@ -94,13 +98,13 @@ Comets are disposable, free identities that can be used to quickly join the netw
9498
9599### Booting a comet
96100
97−To boot a comet, go into the command line and run the following command from the directory that was created during Urbit installation:
101+To boot a comet, go into the command line and run the following command from the urbit directory you created during Urbit installation:
98102
99103```sh
100−$ ./urbit -c mycomet
104+$ ./urbit-v0.10.8-darwin/urbit -c mycomet
101105```
102106
103−This will take a few minutes to an hour, and will spin out a bunch of boot messages. It will also create a directory called `mycomet` in the Unix directory that you ran the command from.
107+This will take up to an hour, and will spin out a bunch of boot messages. It will also create a directory called `mycomet` in the Unix directory that you ran the command from (which should be your urbit directory).
104108
105109Toward the end of the boot process, you'll see something like:
106110
@@ -114,7 +118,9 @@ http: live (insecure, loopback) on 12321
114118
115119When 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.
116120
117−To exit Urbit, use `Ctrl-d`. To start your ship up again, run `./urbit mycomet` from the directory that you first booted from.
121+To exit Urbit, use `Ctrl-d`.
122+
123+To start your ship up again, run `./urbit-v0.10.8-darwin/urbit mycomet` from your `urbit` directory.
118124
119125### The Dojo
120126
@@ -123,7 +129,7 @@ Let's try our first command in the Dojo, the Urbit OS command line and Hoon REPL
123129Type `(add 2 2)` into the Dojo. You should see the following:
124130
125131```
126−~sampel-palnet:dojo> (add 2 2)
132+~sampel_commet:dojo> (add 2 2)
127133```
128134
129135When you press Enter, you should see this:
@@ -246,7 +252,36 @@ Never boot multiple instances of your ship at the same time. You can prevent thi
246252
247253### Updating to the latest binary
248254
249−Most updates to Urbit are downloaded and applied automatically as OTA (Over the Air) updates. Occasionally it would be infeasible to distribute an update this way, and a new `urbit` binary is released. This is announced in the [urbit-dev](https://groups.google.com/a/urbit.org/forum/#!forum/dev) Google Group when it occurs (as are all OTA updates). To update to the latest binary, follow the same process outlined above to download and extract it into a new folder. (the binary linked on this page will always be the latest). Then run it as before with `./urbit path/to/sampel-palnet/`.
255+Most updates to Urbit are downloaded and applied automatically as OTA (Over the Air) updates. Occasionally it would be infeasible to distribute an update this way, and a new `urbit` binary is released. This is announced in the [urbit-dev](https://groups.google.com/a/urbit.org/forum/#!forum/dev) Google Group when it occurs (as are all OTA updates).
256+
257+To update to the latest binary, download and extract it to replace your existing one. Then run it as before.
258+
259+For example, if in your current `urbit` directory you have an `urbit-v0.10.7-darwin` directory along with a ship directory called `mycomet`, and a new `urbit-v0.10.8-darwin` binary was just released, then you'd run the following commands from your `urbit` directory (the example commands below use the darwin installer, but you should use the one for your OS):
260+
261+First shut down your ship, by running the following in dojo (or control-d).
262+```
263+|exit
264+```
265+
266+Next download and extract the most recent binary from inside your `urbit` directory:
267+```
268+curl -O https://bootstrap.urbit.org/urbit-v0.10.8-darwin.tgz
269+tar xzf urbit-v0.10.8-darwin.tgz
270+```
271+
272+Delete the old binary directory from your `urbit` directory:
273+
274+**NOTE**: Your ship itself can be reused, only the binary needs to be changed. This is why we have the directory structure configured as an urbit directory that contains your ship and your binary. This structure makes it easy to swap in new binaries. If you have your ship *inside* the `urbit-vX.XX.X` directory, move it out before deleting that directory.
275+```
276+rm -rf urbit-v0.10.7-darwin
277+```
278+
279+Start up your ship with the new binary from your `urbit` directory:
280+```
281+./urbit-v0.10.8-darwin/urbit mycomet
282+```
283+
284+Then you're good to go, in the future you'll just modify the version numbers in the example above to the most recent version.
250285
251286### Breaches
252287
content/using/operations/hosting.md+1−3
@@ -101,7 +101,7 @@ Continuing to follow the DO docs we're going to configure the ufw firewall.
101101
102102## Installing Urbit
103103Finally we're ready to install Urbit on your very own server. This part is actually pretty easy, if you haven't installed Urbit locally then the instructions are the exact same as the ones in the Urbit [install doc](@/using/install.md). If you have a local ship already, we're going to install Urbit on the server and then send your local ship up.
104− - **WARN**: Since Urbit is p2p you don't want to ever run two copies of your ship simultaneously. This is because other nodes that interact with each of your copies will be confused by which one is the most up to date. If you end up accidentally doing this you'll have to do a 'personal breach' described in the Urbit docs to fix things.
104+ - **WARN**: Since Urbit is p2p you don't want to ever run two copies of your ship simultaneously. This is because other nodes that interact with each of your copies will be confused by which one is the most up to date. If you end up accidentally doing this you'll have to do a 'personal breach' described in the [guide to breaches](@/docs/tutorials/guide-to-breaches.md) to fix things.
105105 - The first thing you're going to want to do is shut down your local ship, either with control-d or `|exit` in dojo.
106106 - Next we're going to install Urbit on the server and permit it to bind to the web port:
107107 ```
@@ -151,8 +151,6 @@ Finally, to leave your Urbit running after you disconnect we can leave it in a S
151151## Links and Misc.
152152A lot of the above documentation comes from combining existing resources.
153153
154−Nginx is also pretty powerful and configurable. You can do things like have your Urbit on an existing server under a subdomain.
155−
156154On iOS you can save a website to your homescreen as an icon. If you do this for your Urbit domain it's a little like having it as an app.
157155
158156 - For the docs that made up this guide see the following links.