Skip to content

Commit cfa43c0

Browse files
committed
docs: update the docker guide
1 parent 9c20579 commit cfa43c0

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

docs/docker.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ The Docker setup provides a complete environment for running any Coinswap applic
1414
- **Alpine Linux 3.20** base image for minimal size
1515
- **Rust 1.90.0** for building the applications
1616
- **Custom Bitcoin Mutinynet image** for Signet testing
17-
- **External Tor image** (`leplusorg/tor`)
17+
- **External Tor image** (`osminogin/tor-simple`)
1818
- **Interactive configuration** with automatic service detection
19+
- **Docker Compose Profiles** for flexible deployment
1920
- **Coinswap binaries:** `makerd`, `maker-cli`, `taker`
2021

2122
## Architecture
@@ -24,9 +25,9 @@ This is an overview for the docker stack with default settings for all nodes:
2425

2526
```mermaid
2627
graph TD
27-
bitcoind["<b>Bitcoind</b><br/>Bitcoin Node<br/>RPC Port (Default: 18332)<br/>ZMQ Port (Default: 28332)"]
28+
bitcoind["<b>Bitcoind</b><br/>Bitcoin Node<br/>RPC Port (Default: 38332)<br/>ZMQ Port (Default: 28332)"]
2829
tor["<b>Tor</b><br/>Tor Proxy<br/>SOCKS Port (Default: 9050)<br/>Control Port (Default: 9051)"]
29-
makerd["<b>Makerd</b><br/>Network Port (Default: 6102) <br/>RPC Port (Default: 6103)"]
30+
makerd["<b>Makerd</b><br/>Network Port (Default: 6012) <br/>RPC Port (Default: 6013)"]
3031
3132
bitcoin_vol["bitcoin-data"]
3233
tor_vol["tor-data"]
@@ -59,7 +60,8 @@ The Docker setup uses:
5960

6061
- `docker/Dockerfile` - Unified image containing `makerd`, `maker-cli`, and `taker`
6162
- `docker/Dockerfile.bitcoin-mutinynet` - Custom Bitcoin Core image for Mutinynet
62-
- External images: `leplusorg/tor` for Tor
63+
- `docker-compose.yml` - Single parameterized compose file
64+
- External images: `osminogin/tor-simple` for Tor
6365

6466
## Quick Start
6567

@@ -106,8 +108,8 @@ The setup script will prompt for:
106108
- Custom SOCKS and control ports
107109

108110
3. **Service Ports**:
109-
- Makerd network port (default: 6102)
110-
- Makerd RPC port (default: 6103)
111+
- Makerd network port (default: 6012)
112+
- Makerd RPC port (default: 6013)
111113

112114
Configuration is saved to `.docker-config` and reused on subsequent runs.
113115

@@ -147,16 +149,16 @@ Run the maker daemon with persistent data storage:
147149
# Or manually with specific image
148150
docker run -d \
149151
--name coinswap-makerd \
150-
-p 6102:6102 \
151-
-p 6103:6103 \
152+
-p 6012:6012 \
153+
-p 6013:6013 \
152154
-v coinswap-maker-data:/home/coinswap/.coinswap \
153155
--network coinswap-network \
154156
coinswap:latest makerd
155157
```
156158

157159
**Port mappings:**
158-
- `6102`: Maker network port for coinswap protocol
159-
- `6103`: Maker RPC port for `maker-cli` commands
160+
- `6012`: Maker network port for coinswap protocol
161+
- `6013`: Maker RPC port for `maker-cli` commands
160162

161163
### Maker CLI
162164

@@ -191,14 +193,14 @@ docker run --rm -it \
191193

192194
## Docker Compose Setup
193195

194-
The setup script automatically generates `docker-compose.generated.yml` based on your configuration. For a complete setup with all services:
196+
The setup script uses a standard `docker-compose.yml` with environment variables and profiles. For a complete setup with all services:
195197

196198
```bash
197199
# Start all services (Bitcoin Core, Tor, Makerd)
198200
./docker-setup start
199201

200-
# Or use docker-compose directly
201-
docker compose -f docker-compose.generated.yml up -d
202+
# Note: Running docker compose directly requires setting environment variables.
203+
# It is recommended to use the setup script which handles this for you.
202204

203205
# Check status
204206
./docker-setup status
@@ -223,8 +225,8 @@ All application data is stored in Docker volumes:
223225
# using setup script
224226
./docker-setup logs makerd
225227

226-
# or directly with docker-compose
227-
docker compose -f docker-compose.generated.yml logs -f makerd
228+
# or directly with docker-compose (requires env vars)
229+
docker compose logs -f makerd
228230
```
229231

230232
### Interactive debugging

0 commit comments

Comments
 (0)