fiftysix/ord repository overview

⁠Fiftysix Ord Docker Image

Maintainer: [email protected]⁠

⁠Overview

This Docker image provides a fully functional Ord client built using the Fiftysix base image. Ord is designed to interact with a Bitcoin Core node to create and manage inscriptions on the Bitcoin blockchain. It is a tool for developers and blockchain enthusiasts interested in creating digital artifacts (Ordinals) directly on the Bitcoin network. The code can be viewed on the Fiftysix Github⁠.

⁠Tags

• latest: Points to the latest version of Ord.
• <version>: Points to a specific version of Ord. For example, 0.19.0, 0.19.1.

⁠What is Ord?

Ord is a software tool that enables the creation of inscriptions on the Bitcoin blockchain, leveraging the Bitcoin protocol's capabilities to embed arbitrary data within transactions. These inscriptions can be used to create unique digital artifacts known as Ordinals, akin to NFTs on the Bitcoin network.

⁠Usage

⁠Prerequisites

Ord requires a connection to a fully synced Bitcoin Core node to function properly. Ensure you have a Bitcoin Core node running and accessible, such as the one provided by Fiftysix's Bitcoin Core Docker Image⁠.

⁠Basic Usage

To run Ord:

docker pull fiftysix/ord
docker run --name ord -d fiftysix/ord

This command will start the Ord container, serving its HTTP interface on port 80 by default. However, Ord needs to connect to a Bitcoin Core node to function, which can be done by using Docker networking or linking containers (see example here⁠).

⁠Connecting to Bitcoin Core

To use Ord with a Bitcoin Core node, ensure that the Bitcoin Core container is running and then connect Ord to it using the following Docker command:

docker run --name ord -d \
  --link bitcoin-core:bitcoin-core \
  -p 80:80 \
  fiftysix/ord \
  ord --bitcoin-rpc-url http://bitcoin-core:8332 server

⁠Directory Structure

In this Docker image, the following directories are used:

• Data Directory (/node/ord/data): This is where Ord stores its data, such as inscriptions and other relevant files. This directory is specified in the Dockerfile and should be mounted if you want to persist data across container restarts.
• Config Directory (/node/ord/configs): This directory is used for storing configuration files for Ord. The Dockerfile copies a default ord.yaml configuration file here, which can be customized.
• Scripts Directory (/node/ord/scripts): This directory contains the entrypoint script (ord-entrypoint.sh) and any other scripts that may be needed for starting or managing Ord.

⁠Mounting Directories

You can mount host directories to the container’s data, config, and scripts directories to customize the behavior of the Ord software.

Mounting the Data Directory: To persist Ord data across container restarts, you can mount a host directory to the container's data directory:

docker run --name ord -v /path/to/local/data:/node/ord/data -d fiftysix/ord

This command mounts the /path/to/local/data directory on your host to /node/ord/data in the container, ensuring that Ord data is preserved between container instances.

Mounting a Config File: To use a custom Ord configuration file, mount your configuration file to the container’s config directory:

docker run --name ord -v /path/to/local/ord.yaml:/node/ord/configs/ord.yaml -d fiftysix/ord

This command mounts your custom ord.yaml file to the container’s config directory and instructs Ord to use it.

Mounting the Scripts Directory: If you have custom scripts you want to include, you can mount them to the scripts directory. For example, to replace the entrypoint script:

docker run --name ord -v /path/to/local/scripts:/node/ord/scripts -d fiftysix/ord

This command mounts your local scripts directory to /node/ord/scripts in the container, allowing you to customize the startup behavior.

⁠Logging Ord

docker logs ord --tail 100

⁠Using Ord with Bitcoin Core

⁠Starting Ord with Bitcoin Core

To start Ord and connect it to a Bitcoin Core node (assuming you have a bitcoin-core container running), use:

docker run --name ord -d \
  --link bitcoin-core:bitcoin-core \
  -p 80:80 \
  fiftysix/ord \
  ord --bitcoin-rpc-url http://bitcoin-core:8332 server

This command starts the Ord server and connects it to your Bitcoin Core node, serving the HTTP interface on port 80.

⁠Creating Inscriptions

Once Ord is running and connected to a Bitcoin Core node (with a wallet attached and funded), you can create inscriptions on the Bitcoin blockchain:

docker exec ord ord create-inscription --text "Hello, Bitcoin!" --fee-rate 1.0

This command creates an inscription on the Bitcoin blockchain with the text "Hello, Bitcoin!".

⁠Docker Compose

Ord can also be run using Docker Compose alongside Bitcoin Core. An example compose file that uses both Bitcoin Core and Ord can be found on the Fiftysix Github⁠.

⁠Support

For support, please contact [email protected]⁠.

⁠About Fiftysix

Fiftysix is committed to making blockchain technology accessible, efficient, and reliable through robust decentralization. Learn more at fiftysix.xyz⁠.