Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add minimum system requirements to readme #829

Merged
merged 3 commits into from
Nov 22, 2022
Merged

Add minimum system requirements to readme #829

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02fdcdb
Add minimum system requirements to readme
casey Nov 22, 2022
94addfa
Merge branch 'master' into readme-update
casey Nov 22, 2022
d6c3c98
tweak
casey Nov 22, 2022
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
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ are mined, and preserved across transactions.
See [the BIP](bip.mediawiki) for a comprehensive description of the assignment
and transfer algorithm.

See [the project board](https://github.com/casey/ord/projects/1) for currently
prioritized issues.
See [the project board](https://github.com/users/casey/projects/3/) for
currently prioritized issues.

See [milestones](https://github.com/casey/ord/milestones) to get a sense of
where the project is and where it's going.

Join [the Discord server](https://discord.gg/87cjuz4FYg) to chat with fellow
ordinal degenerates.
Expand Down Expand Up @@ -116,6 +119,19 @@ If `bitcoind` is not on mainnet, is not run by the same user, has a non-default
datadir, or a non-default port, you'll need to pass additional flags to `ord`.
See `ord --help` for details.

### Minimum System Requirements

Building the `ord` index is memory-intensive. An `ord` instance running on a
reasonably powerful system with 64 GiB of RAM and a fully-synced,
locally-hosted Bitcoin Core node can build the index in under 24 hours.

An `ord` instance running on a system with less than 64 GiB of RAM will take
much longer to build the index, with some users reporting sync times of two
weeks or more.

A this point in development, the format of the `ord` index is changing rapidly,
so be prepared to delete and re-sync the index.

### Logging

`ord` uses [env_logger](https://docs.rs/env_logger/latest/env_logger/). Set the `RUST_LOG` environment variable in order to turn on logging. For example, run the server and show `info`-level log messages and above:
Expand Down