wand/README.md

83 lines
2.1 KiB
Markdown
Raw Normal View History

2020-05-07 03:08:11 +00:00
# wand
Wand makes it easy to configure dash, houdini and a media server utilizing docker & docker-compose.
2020-05-07 03:08:11 +00:00
> [!NOTE]
> This can also be ran on Windows using WSL.
## Installation script
**Step 1** run the script
```bash
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:
```bash
$ 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
2020-05-07 03:08:11 +00:00
<details>
<summary>Debian/Ubuntu</summary>
2020-05-07 03:08:11 +00:00
```bash
2020-05-07 16:29:09 +00:00
$ 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
```
</details>
<details>
<summary>Fedora/RHEL</summary>
```bash
$ 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
2020-05-07 03:08:11 +00:00
$ sudo chmod +x /usr/local/bin/docker-compose
```
</details>
<details>
<summary>Arch based distros</summary>
```bash
$ sudo pacman -Syu
$ sudo pacman -S docker docker-compose git curl
$ systemctl start docker.service
$ systemctl enable docker.service
```
</details>
2020-05-07 03:08:11 +00:00
2020-05-07 16:29:09 +00:00
**Step 2** Clone the repository & submodules
2020-05-07 03:08:11 +00:00
```bash
2020-05-07 16:29:09 +00:00
$ git clone --recurse-submodules https://github.com/solero/wand && cd wand
2020-05-07 03:08:11 +00:00
```
**Step 3** Edit the config file (optional, default values are fine for a local setup)
2020-05-07 03:08:11 +00:00
```bash
$ nano .env
```
**Step 4** Start the services
```bash
$ sudo docker-compose up
```
**Step 5** You're done!