git.iko.soy/urbit.org
on d659381 help sign in
urbit.org/docs/using/admin.md
108 lines 4.7 kB history raw
1---
2navhome: /docs/
3next: true
4sort: 3
5title: Administration and Operation
6---
8# Administration
10<div class="row">
11<div class="col-md-8">
13Your Urbit is a persistent Unix process that you mainly control from the console. For some things, a browser will also work.
15</div>
16</div>
18## Shutdown
20You can turn your Urbit off with `ctrl-d` from the `:talk` or `:dojo` prompts.
22## Restart
24To restart your Urbit simply pass the name of your pier:
26 $ urbit some-planet
28or
30 $ urbit comet
33## Logging
35To log Urbit's command line output to a file, use `script`:
37 $ script urbit.log urbit your-urbit
39## Moving your pier
41Piers are designed to be portable, but it *must* be done while the Urbit is turned off. Urbit networking is stateful, so you can't run two copies of the same Urbit in two places.
43To move a pier, simply move the contents of the directory it lives in. To keep these files as small as possible we usually use the `--sparse` option in `tar`. With a pier `your-urbit/` something like this (from inside `urbit/`) should work:
45 tar -Scvzf your-urbit.tar.gz ./your-urbit/
47# Operation
49## Console
51Your Urbit terminal is separated into two parts: the prompt (the bottom line) and the record (everything above that). The record is shared; all the output from all the apps in your command set appears in it. The prompt is multiplexed.
53In the CLI Urbit apps can process your input before you hit return. To see this in action try entering `)` as the first character at the `:dojo` prompt. Since there is no dojo command or hoon expression that starts with ')', the dojo rejects it.
55`ctrl-x` - Switches the prompt between running console apps
57`ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack trace.
59`ctrl-d` - From `:talk` or `:dojo` stops your Urbit process.
61`↑` / `↓` - History navigation
63The following emacs-style key bindings are available:
65 ctrl-a cursor to beginning of the line (Home)
66 ctrl-b cursor one character backward (left-arrow)
67 ctrl-e cursor to the end of the line (End)
68 ctrl-f cursor one character forward (right-arrow)
69 ctrl-g beep; cancel reverse-search
70 ctrl-k kill to end of line
71 ctrl-l clear the screen
72 ctrl-n next line in history (down-arrow)
73 ctrl-p previous line in history (up-arrow)
74 ctrl-r reverse-search
75 ctrl-t transpose characters
76 ctrl-u kill to beginning of line
77 ctrl-y yank from kill buffer
79Full coverage of the Urbit shell, the `:dojo` is covered in the [Shell walkthrough](/docs/using/shell).
81## Web
83On startup Urbit tries to bind to `localhost:8080`. If you're already running something on `8080` you'll find your Urbit on `8081`, and so on. For planets only, we also proxy web domains through Urbit's own servers. Any planet `~your-urbit` is also at
84`your-urbit.urbit.org`.
86Your Urbit serves a simple homepage from `http://localhost:8080` or `https://your-urbit.urbit.org` that should be self-explanatory. Since our HTTPS isn't audited / battle tested we just call it "secure" HTTPS. You can find that on `8443`. Or `8444` (and so on) if you're already running something on `8443`.
88A complete walkthrough of the Urbit web interface is [here](/docs/using/web).
90## Moons
92Urbit namespace is distributed by having parent nodes sign the keys for child nodes. If you have a planet, your parent star issued your ticket. As a planet you, in turn, can sign the keys for moons. The basic idea is: your planet runs permanently in a data center somewhere and moons run on all your devices. Each planet can issue ~4 billion (`2^32`) moons.
94To generate a random moon from your planet run:
96 ~your-urbit:dojo> +moon
98You can use the resulting output in the same installation flow from [install](/docs/using/install).
100Moons are automatically synced to their parent `%kids` desk, and can control applications on their parent planet using `|link`. You can read more about those things in the [filesystem](/docs/using/filesystem) and [console](/docs/using/shell) walkthroughs.
102## Continuity breaches
104While the Urbit network is in this alpha state we sometimes have to reboot the whole network. This happens either when major changes need to be shipped or we hit a bug that can't be fixed over the air.
106Because Urbit networking is stateful we call this a 'continuity breach'. Everything has to be restarted from scratch. Your pier will continue to function after we have breached, but it wont connect to the rest of the Urbit network.
108When this happens, back up any files you'd like to save, shut down your Urbit and recreate it (as if you were starting for the first time).