on master help sign in
Point people to sync Docs and Examples, visit direct IP web interface, in /docs/using/setup/
5002056Keaton Dunsford
docs/using/setup.md+101−23
@@ -89,36 +89,46 @@ Talk is stateful, so your urbit will download a backlog.
89`/urbit-meta` is the place to ask questions, get help, talk about
89`/urbit-meta` is the place to ask questions, get help, talk about
90anything Urbit-related, and meet everyone on here.
90anything Urbit-related, and meet everyone on here.
91
91
92−### Discussion — Fora
92+### Web — Tree
93−
94−Fora is the place for long-form Urbit discussion. It's hosted on an
95−Urbit and served over HTTP via Eyre, Urbit's web server.
96
93
97−Head on over to:
94+Your Urbit is also accessible through its own web interface. If you're
95+running Urbit locally on your own machine, try opening:
98
96
99− https://urbit.org/~~/fora
97+```
98+http://localhost:8080/~~/
99+```
100
100
101−The `/~~/` in the URL will redirect you to a login page, which will
101+in your favorite browser.
102−provide you steps to run the `+code` generator (shell script) in your
103−Dojo to get your password. Copy and paste that into your password box
104−input and hit Enter. After loading, you'll find yourself redirected to
105−the Fora home page, authenticated, where you can post and comment under
106−the name of your ship.
107
102
108−### Web — Tree
103+Or if you're running your urbit on a cloud instance with a static IP
104+address (which we recommend!), something like `212.131.240.20`, assuming
105+you've opened up the HTTP/HTTPS ports that Urbit uses (`8080` and `8443`
106+by default), try opening:
109
107
110−Your Urbit is also accessible through its own web interface. Try
111−opening:
112
108
109+```
113− http://localhost:8080/~~/
110+http://212.131.240.20:8080/~~/
111+```
114
112
115−in your favorite browser. Like on `urbit.org`, you'll be prompted to use
113+This way, if you keep your urbit running securely in the cloud (usually
116−`+code` in your Dojo to retrive your password and log in. This page was
114+in a [`screen`](https://www.gnu.org/software/screen/) or
115+[`tmux`](https://github.com/tmux/tmux/wiki) session), you can always
116+access your urbit's web interface in any browser on any device, so long
117+as you have your password on hand.
118+
119+The `/~~/` in the URL will redirect you to a login page, which was
117−generated by Tree, the basic Urbit web interface. You can also access
120+generated by Tree, the basic Urbit web interface. The page will tell
121+you to run the `+code` generator (an Urbit functional shell script) in
122+your Dojo to get your password. Copy and paste that into your password
123+input box and hit Enter. After loading, you'll find yourself redirected
124+to your home page, authenticated, where you can then use the navigation
125+bar at the top of the page to visit your Talk web interface and static
126+files.
127+
128+You can also access your urbit through
118−your urbit through `https://your-urbit.urbit.org/~~/`. Note that this
129+`https://your-urbit.urbit.org/~~/`. Note that this latter approach is
119−latter approach is slower for the time being because we proxy over the
130+slower for the time being because we proxy over the Urbit network, Ames,
120−Urbit network, Ames, but a better, faster solution for this is in the
131+but a better, faster solution for this is in the works.
121−works.
122
132
123### Filesystem — Clay
133### Filesystem — Clay
124
134
@@ -141,6 +151,74 @@ which indicates the command was processed.
141`|mount %` will cause a `home/` directory to appear inside your pier
151`|mount %` will cause a `home/` directory to appear inside your pier
142folder. Changes to these files are automatically synced into your urbit.
152folder. Changes to these files are automatically synced into your urbit.
143
153
154+<br />
155+
156+Here are a few other things you can do to get up and running:
157+
158+### Discussion — Fora
159+
160+Fora is the place for long-form Urbit discussion. It's hosted on an
161+Urbit and served over HTTP via Eyre, Urbit's web server.
162+
163+Head on over to:
164+
165+```
166+https://urbit.org/~~/fora
167+```
168+
169+Like on your own web interface, you'll be redirected to a login page and
170+prompted to run `+code` in your Dojo to retrive your password and log
171+in.
172+
173+After loading, you'll get redirected to the Fora home page where you
174+can post and comment authenticated as your ship name. Like Talk, Fora
175+is a great place to ask questions, get help, chat about anything Urbit, and
176+see what's going on.
177+
178+### Docs
179+
180+We host our docs on `urbit.org`, but it's faster to view them locally
181+through your own ship's web interface. So we also host the docs on a
182+Clay desk on one of our `urbit.org` planets, which you can merge and
183+sync onto your live ship over the network.
184+
185+Run in your Dojo:
186+
187+```
188+~your-urbit:dojo> |sync %home ~ladnub-lorwyn %docs
189+```
190+
191+Depending on network traffic, this initial merge and sync could take
192+anywhere between thirty seconds to a few minutes.
193+
194+Upon a successful sync you'll see the output:
195+
196+```
197+sync succeeded from %docs on ~ladnub-lorwyn to %home
198+```
199+
200+If for some reason that doesn't work, head to the
201+[urbit/docs](https://github.com/urbit/docs) repo and follow the local
202+install steps.
203+
204+Otherwise, your docs are now live, and you can view them at:
205+
206+```
207+http://localhost:8443/~~/docs
208+```
209+
210+We'll update our planet's desk with new doc changes as they happen. You
211+should get sync updates automatically through Clay over Ames.
212+
213+### Examples
214+
215+Similarly, we host some Urbit examples on our same `urbit.org` planet as
216+above. Head to our [examples repo](https://github.com/urbit/examples) for
217+full instructions if you're interested, though you may want to start
218+with the [Urbyte](../../urbyte/), [Nock](../../nock/),
219+[Hoon](../../hoon/) or [Arvo](../../arvo/) sections so you can really
220+understand the example code.
221+
144## Learn more
222## Learn more
145
223
146If you're eager to get started programming you're ready to head over to
224If you're eager to get started programming you're ready to head over to