f540d59 · urbit.org · git.iko.soy

content/docs+1−1

compare with master

unifiedsplit

Submodule changed.

content/faq.md+1−1

@@ -249,7 +249,7 @@ Check out our guides [here](@/using/planet.md).

249

250### How do I use Urbit OS? {#use-urbit-os}

251

252−The [Using](@/using/os/using-your-ship.md) section of the documentation will help you out.

252+The [Using](@/using/os/getting-started.md) section of the documentation will help you out.

253

254### How do over-the-air updates work? {#over-the-air-updates}

255

content/using/develop.md+1−1

@@ -2,7 +2,7 @@

2title = "Developer's Guide"

3description = "How to get started developing on Urbit."

4weight = 3

5−template = "page_indiced.html"

5+template = "doc.html"

6aliases = ["/docs/using/creating-a-development-ship/", "/docs/getting-started/contributing"]

7+++

8

content/using/id/_index.mdnew file+6

@@ -0,0 +1,6 @@

1++++

2+title = "ID"

3+template = "sections/docs/chapters.html"

4+sort_by = "weight"

5+description = "How to interact with Urbit ID."

6++++

content/using/id/bridge-troubleshooting.md+1−1

@@ -1,6 +1,6 @@

1+++

2title = "Bridge Troubleshooting"

3−template = "page_indiced.html"

3+template = "doc.html"

4description = "Troubleshooting Bridge if you are running into errors"

5weight = 5

6+++

content/using/id/using-bridge.md+1−1

@@ -1,6 +1,6 @@

1+++

2title = "Using Bridge"

3−template = "page_indiced.html"

3+template = "doc.html"

4description = "How to use Bridge to interact with Azimuth and manage your Urbit ID."

5weight = 1

6aliases = ["/docs/getting-started/using-bridge/"]

content/using/install.md+1−1

@@ -2,7 +2,7 @@

2title = "Getting Started"

3weight = 1

4description = "How to install Urbit."

5−template = "page_indiced.html"

5+template = "doc.html"

6aliases = ["/docs/getting-started/"]

7+++

8

content/using/integrating-api.md+1−1

@@ -2,7 +2,7 @@

2title = "Integrating with Urbit for Developers"

3description = "How to use Urbit's API."

4weight = 4

5−template = "page_indiced.html"

5+template = "doc.html"

6+++

7

8This guide is aimed at developers who have a working knowledge of HTTP grammar (`PUT`, `GET`), and should not require any special knowledge of Urbit's internals. To learn more about a specific application within Urbit, please search for that with the docs once you have finished this guide.

content/using/os/_index.mdnew file+6

@@ -0,0 +1,6 @@

1++++

2+title = "OS"

3+sort_by = "weight"

4+description = "How to use Urbit OS"

5+template = "sections/docs/chapters.html"

6++++

content/using/os/filesystem.md+2−2

@@ -1,7 +1,7 @@

1+++

2title = "Filesystem"

3−template = "page_indiced.html"

3+template = "doc.html"

4−weight = 2

4+weight = 3

5+++

6

7## Filesystem {#filesystem}

content/using/os/using-your-ship.md → content/using/os/getting-started.mdrenamed+19−8

@@ -1,8 +1,8 @@

1+++

2−title = "Using Your Ship"

2+title = "Getting Started"

3description = "How to operate your ship, including using your ship's filesystem and messaging applications, starting a moon, or requesting a DNS proxy."

4−template = "page_indiced.html"

4+template = "doc.html"

5−weight = 2

5+weight = 1

6aliases = ["docs/using/messaging/", "docs/using/admin/"]

7[extra]

8hidetitle = "true"

@@ -243,6 +243,20 @@ The request will be picked up shortly, and the `ship.arvo.network` DNS record wi

243

244Great! You're set up now. Try accessing your `ship.arvo.network` in your browser to use Landscape; we recommend Chrome or Brave.

245

246+### Configuring SSL

247+

248+To enable SSL on your ship, use the `acme` agent, which will request a certificate through Let's Encrypt. First, make sure the agent is started:

249+

250+```

251+> |start %acme

252+```

253+

254+Next, provide the path for the SSL certificate by poking the `acme` agent. The path format is `/tld/your_domain/your_subdomain`, so if your domain is `sampel-palnet.arvo.network`, you'd use it like so:

255+

256+```

257+> :acme &path /network/arvo/sampel-palnet

258+```

259+

246### Galaxies

260### Galaxies

247

261

248Galaxies are already required to have separate DNS entry at galaxy.urbit.org. There's no automated process for getting that binding, so if you're a galaxy-holder, get in touch with us at support@urbit.org.

262Galaxies are already required to have separate DNS entry at galaxy.urbit.org. There's no automated process for getting that binding, so if you're a galaxy-holder, get in touch with us at support@urbit.org.

@@ -257,12 +271,9 @@ This will make HTTP-requests to self-check availability over `galaxy.$AMES-DOMAI

257

271

258Otherwise, `-dns-auto` works the same as `:dns|ip` does with stars and planets: if it's available or unavailable, Chat messages, and so on.

272Otherwise, `-dns-auto` works the same as `:dns|ip` does with stars and planets: if it's available or unavailable, Chat messages, and so on.

259

273

260−### More information

274+### Ports

261−

262−Configuring a ship's domain causes the `:acme` app to request an HTTPS certificate for that domain from LetsEncrypt. Note that LetsEncrypt also requires that the HTTP server be listening on port 80. If the certificate request fails, `:acme` will send a `:chat-cli` message with an explanation. Once the certificate is successfully retrieved, `:acme` will install it, causing the HTTP servers to restart. A secure server will be started on port 443 (the HTTPS default) if it's available. Otherwise, it will try 8443, and then increment to the next port until it can successfully bind one.

263−

264−The built-in logic for listening on port 80 is similar. Urbit tries to bind port 80; if it cannot, it tries 8080, then increments until it can bind a port. Port 80 is available to unprivileged process on recent version of macOS. Otherwise, the process needs to either be run as root, or be given special permission (CAP\_NET_BIND on Linux).

265

275

276+The built-in logic for listening on port 80 is to try to bind to port 80; if it cannot, it tries 8080, then increments until it can bind a port. Port 80 is available to unprivileged process on recent version of macOS. Otherwise, the process needs to either be run as root, or be given special permission (CAP\_NET_BIND on Linux).

266

277

267### Hoon

278### Hoon

268

279

content/using/running/hosting.md → content/using/os/hosting.mdrenamed

The content is the same.

content/using/os/messaging.md+1−1

@@ -1,6 +1,6 @@

1+++

2title = "Messaging"

3−template = "page_indiced.html"

3+template = "doc.html"

4weight = 2

5+++

6

content/using/os/s3.md+1−1

@@ -1,6 +1,6 @@

1+++

2title = "Configuring S3 Storage"

3−template = "page_indiced.html"

3+template = "doc.html"

4weight = 2

5+++

6

content/using/os/shell.md+1−1

@@ -1,6 +1,6 @@

1+++

2title = "Shell"

3−template = "page_indiced.html"

3+template = "doc.html"

4weight = 2

5+++

6

content/using/os/stars-and-galaxies.md+2−2

@@ -1,9 +1,9 @@

1+++

2title = "Star and Galaxy Operations"

3description = "Additional information and suggested ettiquette for Star and Galaxy owners."

4−weight = 3

4+weight = 4

5aliases = ["/docs/using/operating-a-star/"]

6−template = "page_indiced.html"

6+template = "doc.html"

7+++

8

9To boot your galaxy or star, follow our [installation instructions](@/using/install.md).

content/using/planet.md+2−2

@@ -2,7 +2,7 @@

2title = "Setting up Your Planet"

3weight = 1

4description = "Getting started with a permanent Urbit identity."

5−template = "page_indiced.html"

5+template = "doc.html"

6+++

7

8A planet is a permanent Urbit identity. Like all Urbit identities, they can never be taken away from you. Unlike comets which are free, planets are designed for use well into the future. If you're not yet familiar with the Urbit network, please follow the [Getting Started guide](@/using/install.md), which will explain the basics and walk you through using a free identity. This guide explains the next steps.

@@ -125,5 +125,5 @@ If for some reason your sponsor (in this case, `~dopzod`) is not responding, rea

125Now that you’re up and running, take some time to deepen your understanding by checking out some of our other guides:

126

127- [Host your Ship in the Cloud](@/using/running/hosting.md): Follow this guide to set your ship up to run as a cloud server, accessible from anywhere.

128−- [Read the Operations Manual](@/using/os/using-your-ship.md): Become an expert pilot by learning to use your ship.

128+- [Read the Operations Manual](@/using/os/getting-started.md): Become an expert pilot by learning to use your ship.

129- [Learn to Develop on Urbit](@/using/develop.md): Learn how to contribute to or develop on Urbit.

content/using/running/_index.mddeleted−7

@@ -1,7 +0,0 @@

1−+++

2−title = "Operations"

3−description = "Instructions on how to use Bridge, your Urbit ship, Stars and Galaxies, and more."

4−sort_by = "weight"

5−weight = 2

6−template = "list.html"

7−+++

templates/list.html+1

@@ -21,6 +21,7 @@

21 {{ section.title }}

22 </a>

23 {% include "partials/navigation-search.html" %}

24+ <a href="using/install/">Install / Get Started -></a>

24</nav>

25</nav>

25

26

26<article class="mt4 mb4 c1-13 c4-12-lg measure-wide">

27<article class="mt4 mb4 c1-13 c4-12-lg measure-wide">

templates/partials/navigation-docs.html+10−2

@@ -1,6 +1,7 @@

1

2

3{% set sectionTitle = "urbit.org" %}

4+{% set directory = "docs" %}

4{% if page %}

5{% if page %}

5 {% if "docs" in page.components %}

6 {% if "docs" in page.components %}

6 {% set sectionTitle = "Docs" %}

7 {% set sectionTitle = "Docs" %}

@@ -11,6 +12,9 @@

11 {% if "blog" in page.components %}

12 {% if "blog" in page.components %}

12 {% set sectionTitle = "Blog" %}

13 {% set sectionTitle = "Blog" %}

13 {% endif %}

14 {% endif %}

15+ {% if "using" in page.components %}

16+ {% set directory = "using" %}

17+ {% endif %}

14{% endif %}

18{% endif %}

15

19

16{% if section %}

20{% if section %}

@@ -23,6 +27,10 @@

23 {% if "blog" in section.components %}

27 {% if "blog" in section.components %}

24 {% set sectionTitle = "Blog" %}

28 {% set sectionTitle = "Blog" %}

25 {% endif %}

29 {% endif %}

30+ {% if "using" in section.components %}

31+ {% set directory = "using" %}

32+ {% endif %}

33+

26{% endif %}

34{% endif %}

27

35

28{% block content %}

36{% block content %}

@@ -39,7 +47,7 @@

39</button>

47</button>

40 <ul class="lh-copy">

48 <ul class="lh-copy">

41 <li class="ml2 mt1"><a href="/using/install">Install -> </a></li>

49 <li class="ml2 mt1"><a href="/using/install">Install -> </a></li>

42− <li class="ml2 mt1"><a href="/using/operations/">Operations Manual -></a></li>

50+ <li class="ml2 mt1"><a href="/using/os/">Operations Manual -></a></li>

43 <li class="ml2 mt1 mb4"><a href="/using/develop/">Developer's Guide -></a></li>

51 <li class="ml2 mt1 mb4"><a href="/using/develop/">Developer's Guide -></a></li>

44 {% block menu %}

52 {% block menu %}

45 {% if sectionTitle == "Docs" %}

53 {% if sectionTitle == "Docs" %}

@@ -53,7 +61,7 @@

53 </a>

61 </a>

54 </li>

62 </li>

55 {% endif %}

63 {% endif %}

56− {% set index = get_section(path="docs/_index.md") %}

64+ {% set index = get_section(path=directory ~ "/_index.md") %}

57 {% for s in index.subsections %}

65 {% for s in index.subsections %}

58 {% set subsection = get_section(path=s) %}

66 {% set subsection = get_section(path=s) %}

59 {% if subsection.extra.nav %}

67 {% if subsection.extra.nav %}