Skip to content

Commit

Permalink
Merge pull request #205 from CounterpartyXCP/dockercompose
Browse files Browse the repository at this point in the history
Upgrade Instructions for Docker Compose
  • Loading branch information
adamkrellenstein authored Jul 23, 2024
2 parents 6bbcfd2 + 650d6f8 commit b48f7b1
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/basics/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Getting Started
---

## Install Counterparty Core

The simplest way to get your Counterparty node up and running is to use **Docker Compose**, which may be installed as described [here](https://docs.docker.com/compose/install/).

*Note: It is required that you use Docker Compose V2, and it is suggested that you install the plugin as opposed to the standalone `docker-compose` executable*.
Expand Down Expand Up @@ -39,3 +41,22 @@ NOTES:
- By default, this Docker Compose script makes use of the `bootstrap` functionality, because Docker makes it hard to use `kickstart`. (See below.)
- When working with a low-memory system, you can tell AddrIndexRs to use JSON-RPC to communicate with Bitcoin Core using the environment variable `ADDRINDEXRS_JSONRPC_IMPORT`: `ADDRINDEXRS_JSONRPC_IMPORT=true docker compose up -d`

## Upgrade Counterparty Core

Download the latest version of `counterparty-core` and restart `counterparty-server`

```bash
cd counterparty-core
git pull
docker compose stop counterparty-core
docker compose --profile mainnet up -d
```

NOTE:
If you were using a custom version of `docker-compose.yml` that uses the `latest` or `develop` tag, it is recommended to delete the old image before restarting the server:

```bash
docker compose stop counterparty-core
docker rmi counterparty/counterparty:latest
docker compose --profile mainnet up -d
```

0 comments on commit b48f7b1

Please sign in to comment.