From 8131d7048e52ed9d882bf2051ccc72faf3531e6b Mon Sep 17 00:00:00 2001 From: davide3011 Date: Wed, 11 Feb 2026 12:29:16 +0100 Subject: [PATCH] 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 --- .dockerignore | 2 +- .gitignore | 4 +- .../palladium.conf | 0 README.md | 67 +++++++++---------- docker-compose.yml | 8 +-- entrypoint.sh | 2 +- 6 files changed, 41 insertions(+), 42 deletions(-) rename {palladium-node-data => .palladium}/palladium.conf (100%) diff --git a/.dockerignore b/.dockerignore index 2881242..c7dd5e4 100644 --- a/.dockerignore +++ b/.dockerignore @@ -16,7 +16,7 @@ docker-compose.yml # Data and runtime files electrumx-data/ -palladium-node-data/ +.palladium/ *.log *.pid diff --git a/.gitignore b/.gitignore index 197be29..e56f0e6 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/palladium-node-data/palladium.conf b/.palladium/palladium.conf similarity index 100% rename from palladium-node-data/palladium.conf rename to .palladium/palladium.conf diff --git a/README.md b/README.md index 553922a..ab3b177 100644 --- a/README.md +++ b/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 @@ -75,25 +75,25 @@ Internet Router/Firewall Docker Network β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚β”‚ β”‚ β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ–Όβ”€β–Όβ”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β” β”‚ - β”‚ β”‚ Docker Host β”‚ β”‚ - β”‚ β”‚ β”‚ β”‚ - β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ - β”‚ β”‚ β”‚ Palladium Node β”‚ β”‚ β”‚ - β”‚ β”‚ β”‚ (palladiumd) β”‚ β”‚ β”‚ - β”‚ β”‚ β”‚ Port: 2333 β”‚ β”‚ β”‚ - β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ - β”‚ β”‚ β”‚ β”‚ β”‚ - β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ - β”‚ β”‚ β”‚ ElectrumX Server β”‚ β”‚ β”‚ -Clients◄──────────────────────── TCP: 50001 β”‚ β”‚ β”‚ -(Electrum β”‚ β”‚ SSL: 50002 β”‚ β”‚ β”‚ - Wallets) β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ - β”‚ β”‚ β”‚ β”‚ β”‚ - β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ - β–Ό β”‚ β”‚ Web Dashboard β”‚ β”‚ β”‚ + β”‚ β”‚ Docker Host β”‚ β”‚ + β”‚ β”‚ β”‚ β”‚ + β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ + β”‚ β”‚ β”‚ Palladium Node β”‚ β”‚ β”‚ + β”‚ β”‚ β”‚ (palladiumd) β”‚ β”‚ β”‚ + β”‚ β”‚ β”‚ Port: 2333 β”‚ β”‚ β”‚ + β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ + β”‚ β”‚ β”‚ β”‚ β”‚ + β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ + β”‚ β”‚ β”‚ ElectrumX Server β”‚ β”‚ β”‚ +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 :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) diff --git a/docker-compose.yml b/docker-compose.yml index 51283e5..b7d751f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -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 \ No newline at end of file diff --git a/entrypoint.sh b/entrypoint.sh index 9dd47de..02b9e23 100644 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -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