diff --git a/docs/basics/getting-started.md b/docs/basics/getting-started.md index 43a65fc4..91c85024 100644 --- a/docs/basics/getting-started.md +++ b/docs/basics/getting-started.md @@ -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*. @@ -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 +``` \ No newline at end of file