git.iko.soy/urbit.org
on 5002056 help sign in
urbit.org/docs/using/admin.md
124 lines 3.7 kB history raw
1---
2navhome: /docs/
3navuptwo: true
4next: true
5sort: 3
6title: Administration and operation
7---
9# Administration and operation
11Your Urbit is a persistent Unix process that you mainly control from the
12console. For some things, a browser will also work.
14## Shutdown
16You can turn your Urbit off with `Ctrl-d` from the Talk or Dojo prompts.
18## Restart
20To restart your Urbit simply pass the name of your pier:
22```
23$ urbit some-planet
24```
26or
28```
29$ urbit comet
30```
32## Logging
34To log Urbit's command line output to a file, use `script`:
36```
37$ script urbit.log urbit your-urbit
38```
40## Moving your pier
42Piers are designed to be portable, but it _must_ be done while the Urbit
43is turned off. Urbit networking is stateful, so you can't run two copies
44of the same Urbit in two places.
46To move a pier, simply move the contents of the directory it lives in.
47To keep these files as small as possible we usually use the `--sparse`
48option in `tar`. With a pier `your-urbit/` something like this (from
49inside `urbit/`) should work:
51```
52tar -Scvzf your-urbit.tar.gz ./your-urbit/
53```
55## Console
57Your Urbit terminal is separated into two parts: the prompt (the bottom
58line) and the record (everything above that). The record is shared; all
59the output from all the apps in your command set appears in it. The
60prompt is multiplexed.
62In the CLI Urbit apps can process your input before you hit return. To
63see this in action try entering `)` as the first character at the Dojo
64prompt. Since there is no Dojo command or Hoon expression that starts
65with ')', the Dojo rejects it.
67`Ctrl-x` - Switches the prompt between running console apps
69`Ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack trace.
71`Ctrl-d` - From Talk or Dojo stops your Urbit process.
73`↑` / `↓` - History navigation
75The following emacs-style key bindings are available:
77```
78Ctrl-a Cursor to beginning of the line (Home)
79Ctrl-b Cursor one character backward (left-arrow)
80Ctrl-e Cursor to the end of the line (End)
81Ctrl-f Cursor one character forward (right-arrow)
82Ctrl-g Beep; cancel reverse-search
83Ctrl-k Kill to end of line
84Ctrl-l Clear the screen
85Ctrl-n Next line in history (down-arrow)
86Ctrl-p Previous line in history (up-arrow)
87Ctrl-r Reverse-search
88Ctrl-t Transpose characters
89Ctrl-u Kill to beginning of line
90Ctrl-y Yank from kill buffer
91```
93Full coverage of the Urbit shell, the Dojo is covered in the
94[Shell walkthrough](../shell/).
96## Web
98On startup Urbit tries to bind to `localhost:8080`. If you're already
99running something on `8080` you'll find your Urbit on `8081`, and so on.
100For planets only, we also proxy web domains through Urbit's own servers.
101Any planet `~your-urbit` is also at `your-urbit.urbit.org`.
103Your Urbit serves a simple homepage from `http://localhost:8080` or
104`https://your-urbit.urbit.org` that should be self-explanatory. Since
105our HTTPS isn't audited / battle tested we just call it "secure" HTTPS.
106You can find that on `8443`. Or `8444` (and so on) if you're already
107running something on `8443`.
109A complete walkthrough of the Urbit web interface is
110[here](../web/).
112## Continuity breaches
114While the Urbit network is in this alpha state we sometimes have to
115reboot the whole network. This happens either when major changes need
116to be shipped or we hit a bug that can't be fixed over the air.
118Because Urbit networking is stateful we call this a _continuity breach_.
119Everything has to be restarted from scratch. Your pier will continue to
120function after we have breached, but it wont connect to the rest of the
121Urbit network.
123When this happens, back up any files you'd like to save, shut down your
124Urbit and recreate it (as if you were starting for the first time).