BasicSwap Update Guide

BasicSwap DEX is under active open-source development, with frequent releases introducing new features, improvements, and critical bug fixes. Maintaining your installation with regular updates ensures optimal performance and security.

This guide provides step-by-step instructions for properly updating your BasicSwap instance to the latest version.

Updating to v0.17.5

This release updates the Bitcoin, Dash and Monero coin cores, so run the Update Coin Core Versions step below after updating BasicSwap. The database schema is unchanged, so no migration runs.

If you are updating from a version before v0.17.3 and reach the web UI over a network (a LAN IP, hostname, or reverse proxy), you must add the new allowed_hosts setting by hand. Updating does not add it to an existing basicswap.json, so the UI will return 403 Host not allowed until you do. Purely local and default Docker (published to localhost) installs are unaffected. See Reaching BasicSwap Over a Network.

Update a Docker Image

If you've built BasicSwap using the Docker method, follow these steps to update your instance to the most up-to-date version.

Update BasicSwap

1. Navigate to your BasicSwap's Docker folder (where BasicSwap is installed).

Terminal

cd basicswap/docker

2. Stop the BasicSwap Docker image.

Terminal

docker-compose stop

3. Make sure you're on the correct repository.

Terminal

git remote set-url origin https://github.com/basicswap/basicswap

4. Pull the latest BasicSwap updates from Github.

Terminal

git pull

5. Apply the updates to your Docker image.

Terminal

docker-compose build --no-cache

6. Launch BasicSwap

Terminal

docker-compose up

Update Coin Core Versions

To update the core versions of cryptocurrencies enabled in your BasicSwap installation, first ensure BasicSwap itself is running the latest version. This prerequisite is essential, as the coin core update process depends on components from the main BasicSwap codebase.

1. Update your BasicSwap instance to the latest version.

2. Navigate to your BasicSwap docker folder (where your BasicSwap docker image is located).

Terminal

cd basicswap/docker

3. Stop the BasicSwap Docker image.

Terminal

docker-compose stop

4. Apply coin core updates to your Docker image. --upgradecores updates every coin core already enabled in your configuration, so no --withcoins argument is needed.

Terminal

docker-compose run --rm swapclient \
basicswap-prepare --datadir=/coindata --upgradecores

Update Without Docker

If you installed BasicSwap directly from source rather than using Docker containers, follow the steps below to update your installation to the latest version.

tip

Linux users can simplify the update process with community-maintained automation scripts available in the basicswap-bash repository.

Update BasicSwap

1. Properly shutdown BasicSwap.

2. Initialize the update environment by executing the following commands sequentially (one by one).

Terminal

export SWAP_DATADIR=$HOME/coinswaps
. $SWAP_DATADIR/venv/bin/activate && python3 -V

3. Navigate to your BasicSwap folder and clear build cache.

Terminal

cd $SWAP_DATADIR/basicswap
rm -rf $SWAP_DATADIR/basicswap/build

4. Make sure you're on the correct repository.

Terminal

git remote set-url origin https://github.com/basicswap/basicswap

5. Pull the latest BasicSwap updates from Github.

Terminal

git pull

6. Apply the updates to your BasicSwap instance.

Terminal

pip3 install --require-hashes -r requirements.txt
pip3 install .

Update Coin Core Versions

To update the core versions of cryptocurrencies enabled in your BasicSwap installation, first ensure BasicSwap itself is running the latest version. This prerequisite is essential, as the coin core update process depends on components from the main BasicSwap codebase.

1. Properly shutdown BasicSwap.

2. Update your BasicSwap instance to the latest version.

3. Apply coin core updates to your BasicSwap instance. --upgradecores updates every coin core already enabled in your configuration, so no --withcoins argument is needed.

Terminal

basicswap-prepare --datadir=$SWAP_DATADIR --upgradecores