Home

Welcome to the xud-docker wiki!

We create this project for 0-install xud environment which means:

1. Small installer size (like xud.sh)
2. No pre-installed dependencies (so shell scripts and binary is prefered)
3. Sandboxed environment (keep users' host clean)

Dependencies

• Bash (>=3.2)
• Docker (include docker-compose)
• POSIX Utilities

Bash Programming Guidelines

• Google shell style guide
• Shellcheck: A shell scripts static anaylsis tool

Project Structure

• xud.sh: The user need to download this file to start using xud-docker
• main.sh: The core script with command line options which checks the xud-docker environment and launch the xudctl bash shell
• setup.sh: A simple wrapper for main.sh which provides upgrading and network choosing features
• init.sh: The --init-file for the xudctl bash shell which setting up a bunch of aliases
• status.sh: The status command in xudctl shell which provide useful xud-docker components' statuses
• xud- folder: Place each network's docker-compose file
• images folder: Place all images' Dockerfiles
• tools folder: Development utilities
• tests folder: Xud-docker test cases
• supports folder: Additional images building supports