on master help sign in
Merge pull request #1916 from urbit/add-swap-note
2c32894tinnus-napbus
content/getting-started/cli.md+23−3
@@ -12,7 +12,27 @@ Note there is a much more comprehensive [cloud hosting
12guide](https://operators.urbit.org/manual/running/hosting) which walks through
12guide](https://operators.urbit.org/manual/running/hosting) which walks through
13setting up Urbit on a [Digital Ocean](https://www.digitalocean.com/) VPS.
13setting up Urbit on a [Digital Ocean](https://www.digitalocean.com/) VPS.
14
14
15+### 1. System Requirements {% #about-swap-space %}
16+
17+- **Processor**: 1 core
18+- **Memory**: 2GB
19+- **Storage**: At least a few GB, 40-50GB preferable
20+- **Network**: Any
21+
22+**A note on memory**: By default, the Urbit runtime needs 2GB of free memory,
23+and will fail to boot without it. Urbit usually only uses a portion of this, so
24+it's possible to use a swap file to makeup for a shortfall without degrading
25+performance. For instructions on how to configure a swap file on Linux, see
26+[this linuxize.com guide](https://linuxize.com/post/create-a-linux-swap-file/).
27+
28+**A note on storage**: Urbit saves every event it processes to its [Event
29+Log](https://developers.urbit.org/reference/glossary/eventlog). This means its
30+disk usage slowly grows over time. Until event log truncation is implemented,
31+it's advisable to have 40 or 50GB of disk space available, so you don't have to
32+worry about running out for a long time. If you don't have that much, your ship
33+will still run fine, but you may run out of space some months down the line.
34+
15−### 1. Install Urbit
35+### 2. Install Urbit
16
36
17Choose your operating system and run the given command in your terminal to
37Choose your operating system and run the given command in your terminal to
18download the Urbit runtime:
38download the Urbit runtime:
@@ -91,7 +111,7 @@ If successful, you will see a block of output beginning with the line:
91Urbit: a personal server operating function
111Urbit: a personal server operating function
92```
112```
93
113
94−### 2. Boot Urbit
114+### 3. Boot Urbit
95
115
96An Urbit instance is intrinsically tied to a unique identity called an **Urbit
116An Urbit instance is intrinsically tied to a unique identity called an **Urbit
97ID**. There are five classes of Urbit ID, but we will consider two here: comets
117ID**. There are five classes of Urbit ID, but we will consider two here: comets
@@ -225,7 +245,7 @@ delete that keyfile.
225
245
226{% /tabs %}
246{% /tabs %}
227
247
228−### 3. Login
248+### 4. Login
229
249
230While your urbit is running, the web interface called *Landscape* can be
250While your urbit is running, the web interface called *Landscape* can be
231accessed in the browser. Its URL will usually be either `localhost` or
251accessed in the browser. Its URL will usually be either `localhost` or
vercel.json+5
@@ -82,6 +82,11 @@
82 "destination": "/getting-started",
82 "destination": "/getting-started",
83 "permanent": true
83 "permanent": true
84 },
84 },
85+ {
86+ "source": "/using/install",
87+ "destination": "/getting-started/cli",
88+ "permanent": true
89+ },
85 {
90 {
86 "source": "/using/:path*",
91 "source": "/using/:path*",
87 "destination": "https://operators.urbit.org/manual/:path",
92 "destination": "https://operators.urbit.org/manual/:path",