git.iko.soy/urbit.org
on c19bc7a help sign in
urbit.org/readme.md
82 lines 3.0 kB history raw
1# Urbit docs
3These are the urbit docs as they appear on [urbit.org](https://urbit.org/docs/).
5We've found it helps to have a clone of the docs on hand in case urbit.org
6experiences high traffic. Follow these steps to get these into your ship:
8## Installation
10First, you'll need a running urbit. Follow our urbit.org [install
11instructions](https://urbit.org/docs/using/install/), then
12[setup](https://urbit.org/docs/using/setup/) an urbit.
14Follow the *Network install* below if your urbit is running on the live network
15(comets are usually best for development). Follow the *Local install* instead if
16you're on a [fake
17ship](https://fora.urbit.org/general/posts/~2017.1.5..21.31.04..20f3~/) or are otherwise
18experiencing problems with the network install.
20### Network install
22In your urbit's Dojo, run the command:
24 ~your-urbit:dojo> |sync %home ~nosnup-nomzod %docs
26Depending on network traffic, this initial merge and sync could take anywhere
27between thirty seconds to several minutes. Upon a successful sync you'll see the
28output:
30 sync succeeded from %docs on ~nosnup-nomzod to %home
32If your sync isn't succeeding after a few minutes for whatever reason, run
33`|cancel %home` in your Dojo and follow the local install below instead.
35### Local install
37In your urbit's Dojo:
39 ~your-urbit:dojo> |mount /=home=
41You can now find your home desk at the path `/path/to/your-urbit/home/`.
43In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
44mounted `%home` desk. You can run the following shell commands (*replacing your
45urbit's home desk path as necessary*):
47 $ git clone https://github.com/urbit/docs.git
48 $ cd ./docs/
49 $ cp -r ./docs* /path/to/your-urbit/home/web/
51Your Clay filesystem should acknowledge the newly added files.
53Lastly, if make sure you're serving your home desk's `web` directory to the web
54by running the following Dojo command:
56 ~your-urbit:dojo> |serve /=home=/web
58## Get started!
60And now your docs are live! View them at:
62 http://localhost:8080/~~/docs
64> If you're running multiple ships locally, your port number will be `8081`,
65 `8082`, and so on. Check your Dojo output for the correct local port of
66 your examples urbit, or view these at `https://your-urbit.urbit.org` over DNS
67 instead for live-network ships. You can also replace `localhost` with the IP
68 of your instance, if you're running your urbit in the cloud.
70## Learn a lot, and have fun!
72People are always around on
73[Talk](https://urbit.org/docs/using/setup#-messaging-talk) and
74[Fora](https://fora.urbit.org/) to answer your questions. Help each other
75out, and don't hesitate if you have an idea for a docs improvement. We'd love if
76the docs themselves became an Urbit community project.
78## Contributing / Feedback
80Give us feedback [on Fora](https://fora.urbit.org/) on how we can make the
81docs better. Let us know about your ideas, requests, and/or problems and we'll
82try and get back to you quickly. Pull requests are more than welcome.