Operator's Manual

NextLink

This section will help you obtain an Urbit ID, find a hosting provider, learn how to self-host, and other things to get you up and running.

Getting Started

IconCard

Grid

This section describes how to interact with your running Urbit ship. This includes working with the filesystem, command line (Dojo), resolving common issues, and more.

Urbit OS

Urbit ID is our public-key infrastructure, which is what allows you to truly own your identity. Here you'll find guides for interacting with your Urbit ID via our Bridge application.

Urbit ID

This section contains information about running Urbit and related services in the cloud, as well as reference information for the runtime.

Running Urbit

article

Getting Around

Installing apps

Joining groups

Interfaces

Desktop app

Additional Information

Companies that provide Urbit hosting as a service

Hosting Providers

Hosted Urbit

Installation instructions for technical users

Command-line install

How to host your ship in the cloud so you can access it from any device

Cloud hosting

Home servers

Self-hosting

Get an Urbit ID

How to use Bridge to interact with Azimuth and manage your Urbit ID.

Using Bridge

Proxies

HD Wallet (Master Ticket)

Troubleshooting Bridge if you are running into errors

Bridge Troubleshooting

Creating an Invite Pool

Guide to Factory Resets

Getting started with a permanent Urbit identity.

Layer 2 for planets

Layer 2 for stars

How to operate your ship, including using your ship's filesystem and messaging applications, starting a moon, or requesting a DNS entry.

true

Basics

Updates

Configuring S3 Storage

Shell

Filesystem

Additional information and suggested ettiquette for Star and Galaxy owners.

Star and Galaxy Operations

Ship Troubleshooting

Add a commit message to a desk's story

Add a label to a desk revision

Add a source for PKI updates for a list of ships

Add a tombstone policy rule

Adjust the state of a desk

Adjust vane error verbosity

Allow a ship to |link your dojo

Apply tombstoning policies; collect garbage

Approve a CORS origin

Bind a generator to a URL path

Breach (factory reset) a moon

Build a Hoon file

Build a brass pill

Build a dynamic mark conversion gate

Build a dynamic mark core

Build a solid pill

Build a static mark conversion gate

Build a static mark core

Cancel automatic commits for all mounted desks

Cancel periodic memory reports (enabled by |automass)

Change node URL and network for Azimuth

Change the keys of a moon

Change working directory

Change your web login code

Clean up Ames timers

Clear pending Gall move queue from a ship

Clear the dojo's subject

Commit changes to a mounted desk

Connect a local or remote CLI app

Continuously merge int local desk from another local or remote desk

Copy a file

Create a new story file (commit message log) for a desk

Deduplicate memory

Defragment memory

Delete a file

Disconnect a local or remote CLI app

Display all files in the given directory and its sub-directories

Enable automatic commits for a mounted desk

Enable verbose Ames debug printing

Filter Ames debug printing by ship

Hello, world

Install a desk, starting its agents and listening for updates

Kill all running threads

List all Azimuth sources

List all currently running threads

List currently active desk syncs

List files and directories at the specified location

Make a desk, directory or file private (prevent remote ships from reading it)

Make a desk, directory or file publicly readable (allow remote ships to read it)

Make a jamfile and write to disk

Merge one desk into another

Mount a desk or directory to the host filesystem

Move a file from one location to another

Pass a task to a vane

Pause updates on a desk

Perform an octopus merge

Ping another ship with an optional message

Poke a running thread

Print Ames message-pump timers by ship

Print a memory report

Print approved, rejected and requested CORS origins

Print details of Ames flows by ship

Print kelvin version and manifest

Print memory reports periodically

Print out a desk's story (commit messages) in order

Print out a desk's story (commit messages), unordered

Print out currently running Behn timers

Print out the sponsor of this ship

Print out the status of Gall agents on a desk

Print out the status of a single installed desk

Print out the status of each installed desk

Print out your web login code

Print the life and rift for a ship

Print the most recent Ethereum block that has been processed

Print tombstone policyies for all desk

Print tracked fuse sources for a desk

Query the state or bowl of a running agent

Read a file at the given location and print its contents in the dojo

Read a file, local or remote

Refetch and load Azimuth snapshot

Reject a CORS origin

Remove commit message(s) for a given commit from a desk's story

Requests a <ship>.arvo.network subdomain and configure SSL

Reset Ames congestion control; re-send packets immediately

Restart %eth-watcher, resubscribe, re-process snapshot and updates

Resume updates on a desk

Revive all agents on a desk, migrating archived states

Revoke permission for a remote ship to |link your dojo

Rotate private keys

Run tests for a library

Set Gall verbosity by agent

Set the source for kernel updates (%base desk)

Show which ships you've allowed remote access to your dojo

Shut down all agents on a desk, archiving their states

Shut down an agent and permanently delete its state

Shut down this ship

Spawn a new moon

Start a thread

Start an agent

Stop a running thread

Stop syncing a desk with another

Toggle Gall debug printing

Toggle kernel event tracing verbose mode

Tombstone a file at a particular revision

Trim kernel state

Try to apply a kernel update

Uninstall a desk, suspending its agents and ignoring updates

Unmount a previously mounted desk or directory

Whitelist/blacklist ships in Ames

Write atom to disk in binary

Dojo Tools

How to run Urbit in various environments.

Runtime Reference

How to host your ship in the cloud so you can access it from any device.

Cloud Hosting

How to set up and self-host MinIO S3 storage

Self-hosting S3 Storage with MinIO

Instructions for running a coturn server on your star.

Coturn Operator Guide

Operator's Manual

Getting Started

Other Sections

Urbit OS

Urbit ID

Running Urbit