rename palladium-node-data to .palladium to follow Unix standards
Rename the data directory from palladium-node-data/ to .palladium/ to align with Unix convention for application data directories. This change makes the directory hidden by default and follows the standard naming pattern used by blockchain nodes
This commit is contained in:
@@ -16,7 +16,7 @@ docker-compose.yml
|
||||
|
||||
# Data and runtime files
|
||||
electrumx-data/
|
||||
palladium-node-data/
|
||||
.palladium/
|
||||
*.log
|
||||
*.pid
|
||||
|
||||
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -2,8 +2,8 @@
|
||||
/electrumx-data/
|
||||
|
||||
# Palladium node data (keep only the config file)
|
||||
/palladium-node-data/*
|
||||
!/palladium-node-data/palladium.conf
|
||||
/.palladium/*
|
||||
!/.palladium/palladium.conf
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
|
||||
39
README.md
39
README.md
@@ -6,7 +6,7 @@ Everything runs in Docker containers - no need to install dependencies on your h
|
||||
|
||||
---
|
||||
|
||||
## 📦 What You Get
|
||||
## What You Get
|
||||
|
||||
- **Palladium Full Node** (palladiumd) - Runs in Docker with full blockchain sync
|
||||
- **ElectrumX Server** - Pre-configured for Palladium network with automatic indexing
|
||||
@@ -17,7 +17,7 @@ Everything runs in Docker containers - no need to install dependencies on your h
|
||||
|
||||
---
|
||||
|
||||
## 🖥️ Tested Platforms
|
||||
## Tested Platforms
|
||||
|
||||
* Debian 12/13
|
||||
* Ubuntu 24.04/22.04 LTS
|
||||
@@ -32,7 +32,7 @@ Everything runs in Docker containers - no need to install dependencies on your h
|
||||
|
||||
---
|
||||
|
||||
## 📋 Project Structure
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
plm-electrumx/
|
||||
@@ -41,7 +41,7 @@ plm-electrumx/
|
||||
│ ├── palladium-cli # CLI tool (required)
|
||||
│ ├── palladium-tx # Transaction tool (optional)
|
||||
│ └── palladium-wallet # Wallet tool (optional)
|
||||
├── palladium-node-data/
|
||||
├── .palladium/
|
||||
│ ├── palladium.conf # Node configuration (edit this!)
|
||||
│ ├── blocks/ # Blockchain blocks (auto-generated)
|
||||
│ ├── chainstate/ # Blockchain state (auto-generated)
|
||||
@@ -61,7 +61,7 @@ plm-electrumx/
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture
|
||||
## Architecture
|
||||
|
||||
```
|
||||
Internet Router/Firewall Docker Network
|
||||
@@ -85,15 +85,15 @@ Internet Router/Firewall Docker Network
|
||||
│ │ │ │ │
|
||||
│ │ ┌────────▼──────────┐ │ │
|
||||
│ │ │ ElectrumX Server │ │ │
|
||||
Clients◄───────────────────────┤ TCP: 50001 │ │ │
|
||||
Clients◄────────────────────────┤ TCP: 50001 │ │ │
|
||||
(Electrum │ │ SSL: 50002 │ │ │
|
||||
Wallets) │ └────────┬──────────┘ │ │
|
||||
│ │ │ │ │
|
||||
│ │ ┌────────▼──────────┐ │ │
|
||||
│ │ ┌────────▼─────────┐ │ │
|
||||
▼ │ │ Web Dashboard │ │ │
|
||||
Browser◄───────────────────────┤ Port: 8080 │ │ │
|
||||
│ └───────────────────┘ │ │
|
||||
└─────────────────────────┘ │
|
||||
│ └──────────────────┘ │ │
|
||||
└────────────────────────┘ │
|
||||
```
|
||||
|
||||
**Component Communication:**
|
||||
@@ -105,7 +105,7 @@ Browser◄───────────────────────
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Requirements
|
||||
## Requirements
|
||||
|
||||
* [Docker](https://docs.docker.com/get-docker/) 20.10+
|
||||
* [Docker Compose](https://docs.docker.com/compose/install/) 2.0+
|
||||
@@ -113,7 +113,7 @@ Browser◄───────────────────────
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start Guide
|
||||
## Quick Start Guide
|
||||
|
||||
### Step 1: Clone the Repository
|
||||
|
||||
@@ -161,7 +161,7 @@ ls -lh daemon/
|
||||
Open the configuration file:
|
||||
|
||||
```bash
|
||||
nano palladium-node-data/palladium.conf
|
||||
nano .palladium/palladium.conf
|
||||
```
|
||||
|
||||
**Change these credentials:**
|
||||
@@ -252,9 +252,9 @@ For your ElectrumX server to be accessible from the internet, you **must** confi
|
||||
If you have a synced Palladium blockchain, copy it to speed up initial sync:
|
||||
|
||||
```bash
|
||||
cp -r ~/.palladium/blocks palladium-node-data/
|
||||
cp -r ~/.palladium/chainstate palladium-node-data/
|
||||
cp -r ~/.palladium/indexes palladium-node-data/
|
||||
cp -r ~/.palladium/blocks .palladium/
|
||||
cp -r ~/.palladium/chainstate .palladium/
|
||||
cp -r ~/.palladium/indexes .palladium/
|
||||
```
|
||||
|
||||
**Skip this** if syncing from scratch - the node will automatically start syncing.
|
||||
@@ -422,7 +422,7 @@ python test-server.py <your-public-ip>:50002
|
||||
|
||||
### Palladium Node Settings
|
||||
|
||||
Key settings in `palladium-node-data/palladium.conf`:
|
||||
Key settings in `.palladium/palladium.conf`:
|
||||
|
||||
| Setting | Value | Purpose |
|
||||
|---------|-------|---------|
|
||||
@@ -725,8 +725,8 @@ environment:
|
||||
|
||||
## Notes
|
||||
|
||||
* **Data Persistence:** All data stored in `./palladium-node-data/` and `./electrumx-data/`
|
||||
* **Backup:** Regularly backup `palladium-node-data/wallet.dat` if you store funds
|
||||
* **Data Persistence:** All data stored in `./.palladium/` and `./electrumx-data/`
|
||||
* **Backup:** Regularly backup `.palladium/wallet.dat` if you store funds
|
||||
* **Network Switch:** Always clear ElectrumX database when switching networks
|
||||
* **Updates:** Check for Palladium Core updates regularly
|
||||
|
||||
@@ -738,7 +738,7 @@ Distributed under the **MIT** license. See `LICENSE` file for details.
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Support
|
||||
## Support
|
||||
|
||||
- **Issues:** [GitHub Issues](https://github.com/palladium-coin/plm-electrumx/issues)
|
||||
- **Palladium Community:** [Palladium Coin](https://github.com/palladium-coin)
|
||||
@@ -749,4 +749,3 @@ Distributed under the **MIT** license. See `LICENSE` file for details.
|
||||
## Credits
|
||||
|
||||
- **ElectrumX:** [kyuupichan/electrumx](https://github.com/kyuupichan/electrumx)
|
||||
- **Palladium Core:** [palladium-coin/palladiumcore](https://github.com/palladium-coin/palladiumcore)
|
||||
|
||||
@@ -15,8 +15,8 @@ services:
|
||||
# For testnet, expose: 12332 (RPC) and 12333 (P2P)
|
||||
|
||||
volumes:
|
||||
# Mount palladium-node-data folder (contains config and blockchain data)
|
||||
- ./palladium-node-data:/root/.palladium
|
||||
# Mount .palladium folder (contains config and blockchain data)
|
||||
- ./.palladium:/root/.palladium
|
||||
|
||||
command: >
|
||||
palladiumd
|
||||
@@ -70,7 +70,7 @@ services:
|
||||
|
||||
volumes:
|
||||
- ./electrumx-data:/data
|
||||
- ./palladium-node-data/palladium.conf:/palladium-config/palladium.conf:ro
|
||||
- ./.palladium/palladium.conf:/palladium-config/palladium.conf:ro
|
||||
|
||||
dashboard:
|
||||
build:
|
||||
@@ -92,5 +92,5 @@ services:
|
||||
ELECTRUMX_RPC_PORT: "8000"
|
||||
|
||||
volumes:
|
||||
- ./palladium-node-data/palladium.conf:/palladium-config/palladium.conf:ro
|
||||
- ./.palladium/palladium.conf:/palladium-config/palladium.conf:ro
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
@@ -13,7 +13,7 @@ get_conf_value() {
|
||||
# Check if palladium.conf exists
|
||||
if [ ! -f "$PALLADIUM_CONF" ]; then
|
||||
echo "ERROR: palladium.conf not found at $PALLADIUM_CONF"
|
||||
echo "Please ensure the palladium-node-data volume is mounted correctly."
|
||||
echo "Please ensure the .palladium volume is mounted correctly."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
Reference in New Issue
Block a user