on master help sign in
Merge pull request #1586 from urbit/better-install-commands

simplify install commands

commitf2cf3b16d527c1a60c4bd5254cb9c98d2398f40b authortinnus-napbus <77721746+tinnus-napbus@users.noreply.github.com> dateFri 19 Aug 2022, 05:41 (4 years ago) parent544ab20a484b09
2 files changed+47−44
content/getting-started/cli.md+23−23 content/getting-started/server.md+24−21
content/getting-started/cli.md+23−23
@@ -12,11 +12,14 @@ If you're a power user, you can run the Urbit virtual machine directly using the
1212{% tab label="MacOS" %}
1313
1414```bash
15−mkdir ~/urbit
16−cd ~/urbit
17−curl -JLO https://urbit.org/install/mac/latest
18−tar zxvf ./darwin.tgz --strip=1
19−~/urbit/urbit
15+curl -L https://urbit.org/install/mac/latest | tar xzk --strip=1 && ./urbit
16+```
17+
18+Note our Mac build is only compatible with Apple Silicon (M1/M2) via Rosetta.
19+If you have such a machine you must run the following command:
20+
21+```
22+/usr/sbin/softwareupdate --install-rosetta --agree-to-license
2023```
2124
2225{% /tab %}
@@ -24,18 +27,14 @@ tar zxvf ./darwin.tgz --strip=1
2427{% tab label="Linux" %}
2528
2629```shell
27−mkdir ~/urbit
28−cd ~/urbit
29−wget --content-disposition https://urbit.org/install/linux64/latest
30−tar zxvf ./linux64.tgz --strip=1
31−~/urbit/urbit
30+curl -L https://urbit.org/install/linux64/latest | tar xzk --strip=1 && ./urbit
3231```
3332
3433Linux users may need to run this command in another terminal window to access your Urbit on port 80:
3534
3635```shell
3736sudo apt-get install libcap2-bin
38−sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit
37+sudo setcap 'cap_net_bind_service=+ep' ./urbit
3938```
4039
4140{% /tab %}
@@ -43,14 +42,15 @@ sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit
4342{% tab label="Windows" %}
4443
4544```winbatch
46−mkdir %USERPROFILE%\urbit
47−cd %USERPROFILE%\urbit
48−curl -JLO https://urbit.org/install/windows/latest
49−tar zxvf .\windows.tgz --strip=1
50−%USERPROFILE%\urbit\urbit
45+curl -L https://urbit.org/install/windows/latest | tar -xzkf - --strip-components=1 && urbit
5146```
5247
53−> Windows 10 build 17063 and later includes the familiar `curl` and `tar` command-line tools.
48+Windows 10 build 17063 and later includes the familiar `curl` and `tar`
49+command-line tools. If you're running an older version of Windows, you may need
50+to visit
51+[https://github.com/urbit/urbit/releases/latest](https://github.com/urbit/urbit/releases/latest)
52+in the browser, download the `windows.zip` file, extract it and execute the
53+contained `urbit.exe` file in the command prompt.
5454
5555{% /tab %}
5656
@@ -92,10 +92,10 @@ A comet name looks like `~dasres-ragnep-lislyt-ribpyl--mosnyx-bisdem-nidful-marz
9292
9393---
9494
95−To boot a comet, go into the command line and run the following command from the `urbit` directory you created during [Urbit installation](#os).
95+To boot a comet, go into the command line and run the following command:
9696
9797```sh
98−~/urbit/urbit -c mycomet
98+./urbit -c mycomet
9999```
100100
101101It may take a while to load the comet (probably only take a few minutes, but it could take longer). This comes along with it being free. When it's done you'll some messages ending like this:
@@ -111,10 +111,10 @@ When your comet is finished booting, you will see `~sampel_marzod:dojo>` (Dojo:
111111
112112To exit Urbit, use `Ctrl-D` or enter `|exit` into Dojo.
113113
114−To start your comet up again, run the following from your `urbit` directory (note the lack of `-c` argument):
114+To start your comet up again, run the following command:
115115
116116```sh
117−~/urbit/urbit mycomet
117+./mycomet/.run
118118```
119119
120120### Using the web interface
@@ -134,10 +134,10 @@ At the moment, the most common way to use Urbit is by launching apps like Groups
134134
135135Urbit comes with a recent release of the Urbit OS, but automatic updates of the `%base` desk (which contains the kernel of the OS) are not enabled by default for Comets. Many comets are used only once and thrown away, so it would be wasteful to update every single comet as soon as it boots. If you plan to use your comet for more than a quick test, you'll probably want to ensure you're running the latest version of the OS.
136136
137−You can enable updates for your comet by typing `|install (sein:title our now our) %kids, =local %base` into Dojo and pressing Enter.
137+You can enable updates for your comet by typing `|ota (sein:title our now our)` into Dojo and pressing Enter.
138138
139139```
140−> |install (sein:title our now our) %kids, =local %base
140+> |ota (sein:title our now our)
141141>=
142142kiln: activated install into %base from [~samzod %kids]
143143kiln: downloading update for %base from [~samzod %kids]
content/getting-started/server.md+24−21
@@ -72,11 +72,14 @@ Download Urbit with the following commands:
7272{% tab label="MacOS" %}
7373
7474```bash
75−mkdir ~/urbit
76−cd ~/urbit
77−curl -JLO https://urbit.org/install/mac/latest
78−tar zxvf ./darwin.tgz --strip=1
79−~/urbit/urbit
75+curl -L https://urbit.org/install/mac/latest | tar xzk --strip=1 && ./urbit
76+```
77+
78+Note our Mac build is only compatible with Apple Silicon (M1/M2) via Rosetta.
79+If you have such a machine you must run the following command:
80+
81+```
82+/usr/sbin/softwareupdate --install-rosetta --agree-to-license
8083```
8184
8285{% /tab %}
@@ -84,18 +87,14 @@ tar zxvf ./darwin.tgz --strip=1
8487{% tab label="Linux" %}
8588
8689```shell
87−mkdir ~/urbit
88−cd ~/urbit
89−wget --content-disposition https://urbit.org/install/linux64/latest
90−tar zxvf ./linux64.tgz --strip=1
91−~/urbit/urbit
90+curl -L https://urbit.org/install/linux64/latest | tar xzk --strip=1 && ./urbit
9291```
9392
9493Linux users may need to run this command in another terminal window to access your Urbit on port 80:
9594
9695```shell
9796sudo apt-get install libcap2-bin
98−sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit
97+sudo setcap 'cap_net_bind_service=+ep' ./urbit
9998```
10099
101100{% /tab %}
@@ -103,25 +102,26 @@ sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit
103102{% tab label="Windows" %}
104103
105104```winbatch
106−mkdir %USERPROFILE%\urbit
107−cd %USERPROFILE%\urbit
108−curl -JLO https://urbit.org/install/windows/latest
109−tar zxvf .\windows.tgz --strip=1
110−%USERPROFILE%\urbit\urbit
105+curl -L https://urbit.org/install/windows/latest | tar -xzkf - --strip-components=1 && urbit
111106```
112107
113−> Windows 10 build 17063 and later includes the familiar `curl` and `tar` command-line tools.
108+Windows 10 build 17063 and later includes the familiar `curl` and `tar`
109+command-line tools. If you're running an older version of Windows, you may need
110+to visit
111+[https://github.com/urbit/urbit/releases/latest](https://github.com/urbit/urbit/releases/latest)
112+in the browser, download the `windows.zip` file, extract it and execute the
113+contained `urbit.exe` file in the command prompt.
114114
115115{% /tab %}
116116
117117{% /tabs %}
118118
119−Next, transfer `your-keyfile.key` to your server using scp or an FTP client, then move it to the `~/urbit` directory you created in the last step.
119+Next, transfer `your-keyfile.key` to your server using scp or an FTP client.
120120
121121Now you can run Urbit for the first time. Run the below command, replacing ames_port with a public port number between 49152 to 65535, sampel-palnet with the name of your planet, and sampel-palnet.key with the name of your keyfile.
122122
123123```sh
124−./urbit -p ames_port -w sampel-palnet -k ./sampel-palnet.key
124+./urbit -p ames_port -w sampel-palnet -k sampel-palnet.key
125125```
126126
127127Arvo, the Urbit OS, now creates a directory called `sampel-palnet/` and begins booting your planet and establishing connections with the P2P network. When that's finished, you'll see Dojo, the Urbit command line:
@@ -138,14 +138,17 @@ Check out the [cloud hosting guide](/using/running/hosting) for tips on improvin
138138
139139Shut down your planet by typing Ctrl+D into Dojo.
140140
141−To boot your planet up again, run the following command, once again replacing `ames_port` with the port you used previously, and now referencing your planet's folder.
141+The `urbit` binary will have automatically "docked" with your pier, copying
142+itself inside so a separate binary isn't necessary. To boot your planet up
143+again, run `./sampel-palnet/.run -p ames_port`, once again replacing
144+`ames_port` with the port you used previously.
142145
143146Your planet's folder, `sampel-palnet/`, is called your pier, and it holds all your data. If you want to migrate your data from one system to another, you must bring your pier.
144147
145148You should also delete your keyfile from your remote system to prevent yourself from using the same key twice, which will cause communication problems with other planets.
146149
147150```sh
148−rm ./your-keyfile.key
151+rm your-keyfile.key
149152```
150153
151154### 5. Log in