Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ snapshotting system.

## Getting Started

For basic Urbit usage instructions, head over to [urbit.org][getting-started].
If you've never used Urbit before, head over [here](get-on-urbit) to get on
Urbit.

For a high-level overview of the salient aspects of Urbit's architecture, visit
[developers.urbit.org][technical-reference]. You might also be interested in
joining the [urbit-dev][mailing-list] mailing list.
[docs.urbit.org][docs].

## Packages

Expand All @@ -35,12 +36,10 @@ Contributions of any form are more than welcome. Please take a look at our
[contributing guidelines][contributing] for details on our git practices, coding
styles, how we manage issues, and so on.

[bazel]: https://bazel.build
[docs]: https://docs.urbit.org
[contributing]: https://github.com/urbit/urbit/blob/master/CONTRIBUTING.md
[cue]: https://developers.urbit.org/reference/hoon/stdlib/2p#cue
[getting-started]: https://urbit.org/getting-started
[jam]: https://developers.urbit.org/reference/hoon/stdlib/2p#jam
[mailing-list]: https://groups.google.com/a/urbit.org/forum/#!forum/dev
[cue]: https://docs.urbit.org/hoon/stdlib/2p#cue
[get-on-urbit]: https://docs.urbit.org/get-on-urbit
[jam]: https://docs.urbit.org/hoon/stdlib/2p#jam
[urbit]: https://urbit.org
[vere]: https://developers.urbit.org/reference/glossary/vere
[technical-reference]: https://developers.urbit.org/reference
[vere]: https://docs.urbit.org/build-on-urbit/runtime
16 changes: 7 additions & 9 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,14 @@ contain one of:
[obtaining a keyfile](https://urbit.org/getting-started/get-id).
- e.g. `sampel-palnet.key` for the planet `~sampel-palnet`.
- An empty file with the extension `.comet`. This will cause Urbit to boot a
[comet](https://urbit.org/docs/glossary/comet/) in a pier named for the
`.comet` file (less the extension).
comet in a pier named for the `.comet` file (less the extension).
- e.g. starting with an empty file `my-urbit-bot.comet` will result in Urbit
booting a comet into the pier `my-urbit-bot` under your volume.
- An existing pier as a directory `<shipname>`. You can migrate an existing ship
to a new docker container in this way by placing its pier under the volume.
- e.g. if your ship is `sampel-palnet` then you likely have a directory
`sampel-palnet` whose path you pass to `./urbit` when starting.
[Move your pier](https://operators.urbit.org/manual/os/basics#moving-your-pier)
[Move your pier](https://docs.urbit.org/user-manual/os/basics#moving-your-pier)
directory to the volume and then start the container.

The first two options result in Urbit attempting to boot either the ship named
Expand All @@ -41,16 +40,15 @@ move the pier out of the Docker volume (e.g. to run it using an Urbit binary
directly). If you do this, make sure to delete the Docker volume after you move
your pier; if you launch a container using this same pier after moving it and
launching it elsewhere, you will likely need to perform a
[breach](https://developers.urbit.org/reference/glossary/reset).
[breach](https://docs.urbit.org/user-manual/id/guide-to-resets).

### Ports

The image includes `EXPOSE` directives for TCP port `80` and UDP port `34343`.
Port `80` is used for Urbit's HTTP interface for both
[Landscape](https://urbit.org/docs/glossary/landscape/) and for
[API calls](https://developers.urbit.org/guides/additional/http-api-guide) to
the ship. Port `34343` is set by default to be used by
[Ames](https://urbit.org/docs/glossary/ames/) for ship-to-ship communication.
Port `80` is used for Urbit's HTTP interface for both Landscape and for
Comment thread
bonbud-macryg marked this conversation as resolved.
[API calls](https://docs.urbit.org/build-on-urbit/tools/js-libs/http-api-guide)
to the ship. Port `34343` is set by default to be used by
[Ames](https://docs.urbit.org/urbit-os/kernel/ames) for ship-to-ship communication.

You can either pass the `-P` flag to docker to map ports directly to the
corresponding ports on the host, or map them individually with `-p` flags. For
Expand Down
2 changes: 1 addition & 1 deletion pkg/noun/manage.c
Original file line number Diff line number Diff line change
Expand Up @@ -2244,7 +2244,7 @@ u3m_init(size_t len_i)
-1, 0);

u3l_log("boot: mapping %zuMB failed", len_i >> 20);
u3l_log("see https://docs.urbit.org/manual/getting-started/self-hosted/cloud-hosting"
u3l_log("see https://docs.urbit.org/user-manual/running/cloud-hosting"
" for adding swap space");
if ( -1 != (c3_ps)map_v ) {
u3l_log("if porting to a new platform, try U3_OS_LoomBase %p",
Expand Down
2 changes: 1 addition & 1 deletion pkg/vere/disk.c
Original file line number Diff line number Diff line change
Expand Up @@ -1720,7 +1720,7 @@ u3_disk_chop(u3_disk* log_u, c3_d eve_d)
if ( len_z <= 2 ) {
fprintf(stderr, "chop: nothing to do, try running roll first\r\n"
"chop: for more info see "
"https://docs.urbit.org/manual/running/vere#chop\r\n");
"https://docs.urbit.org/user-manual/running/vere#chop\r\n");
exit(0); // enjoy
}

Expand Down
8 changes: 4 additions & 4 deletions pkg/vere/pier.c
Original file line number Diff line number Diff line change
Expand Up @@ -644,8 +644,8 @@ _boot_scry_cb(void* vod_p, u3_noun nun)
_pier_work(wok_u);
} else {
u3l_log("boot: failed: double-boot detected, refusing to boot %s\r\n"
"this ship is an old copy, resume the latest version of the ship or breach\r\n"
"read more: https://docs.urbit.org/glossary/double-boot",
"this is an old version of the ship, resume the latest version or breach\r\n"
"see https://docs.urbit.org/user-manual/id/guide-to-resets",
who_c);
u3_king_bail();
}
Expand All @@ -654,7 +654,7 @@ _boot_scry_cb(void* vod_p, u3_noun nun)
u3l_log("boot: failed: double-boot detected, refusing to boot %s\r\n"
"you are trying to boot an existing ship from a keyfile,"
"resume the latest version of the ship or breach\r\n"
"read more: https://docs.urbit.org/glossary/double-boot",
"see https://docs.urbit.org/user-manual/id/guide-to-resets",
who_c);
u3_king_bail();
}
Expand Down Expand Up @@ -693,7 +693,7 @@ _boot_scry_cb(void* vod_p, u3_noun nun)
u3l_log("boot: failed: double-boot detected, refusing to boot %s\r\n"
"this ship has already been booted elsewhere, "
"boot the existing pier or breach\r\n"
"read more: https://docs.urbit.org/glossary/double-boot",
"see https://docs.urbit.org/user-manual/id/guide-to-resets",
who_c);
u3_king_bail();
}
Expand Down