wand/README.md
2024-08-30 22:26:44 +03:00

2.3 KiB

wand

Wand makes it easy to configure dash, houdini and a media server utilizing docker & docker-compose.

Note

This can also be ran on Windows using WSL.
This can also be ran on MacOS (Darwin)

Installation script

Step 1 run the script

bash <(curl -s https://raw.githubusercontent.com/solero/wand/master/install.sh)

Step 2 Answer Questions which are:

  • Database password (Leave blank for random password)
  • Hostname (example: clubpenguin.com) (Leave empty for localhost)
  • External IP Address (Leave empty for localhost)
    Step 3 Run and enjoy. Run this command:
$ cd wand && sudo docker-compose up

Manual setup

Important

This is not recommended for beginners. If you're not sure what you're doing, use the install script.

Step 1 Choose your Linux Distribution / MacOS

Debian/Ubuntu
$ sudo apt update
$ sudo apt install git curl
$ curl -fsSL https://get.docker.com -o get-docker.sh
$ sh get-docker.sh
$ sudo curl -L "https://github.com/docker/compose/releases/download/v2.20.3/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
Fedora/RHEL
$ sudo dnf update
$ sudo dnf install git curl
$ curl -fsSL https://get.docker.com -o get-docker.sh
$ sh get-docker.sh
$ sudo curl -L "https://github.com/docker/compose/releases/download/v2.20.3/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
Arch based distros
$ sudo pacman -Syu
$ sudo pacman -S docker docker-compose git curl
$ systemctl start docker.service
$ systemctl enable docker.service
MacOS (Darwin OS)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install docker
brew install git
brew install docker-compose@2.20.3

Step 2 Clone the repository & submodules

$ git clone --recurse-submodules https://github.com/solero/wand && cd wand

Step 3 Edit the config file (optional, default values are fine for a local setup)

$ nano .env

Step 4 Start the services

$ sudo docker-compose up

Step 5 You're done!