Mirrored_Repos/wand
1
0
Fork 0
mirror of https://github.com/solero/wand.git synced 2025-10-24 07:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update install.sh & README.md (#37)

Browse Source 
* Update install.sh

Add support for more Linux distros as opposed to only being Debian.
Now supports: Debian/Ubuntu, Fedora, CentOS & Arch Linux.

* Update README.md

* Update install.sh

Added a repository update before installing on all platforms, added output for what the script is doing i.e installing docker, compose, git etc
This commit is contained in:
sina
2024-08-23 07:43:50 +01:00
committed by GitHub
parent a5c8752387
commit 4f02167300
2 changed files with 128 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -1,14 +1,16 @@
# wand
Wand makes it easy to configure dash, houdini and a media server.
Wand makes it easy to configure dash, houdini and a media server utilizing docker & docker-compose.
## Install script
> [!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
the questions are:
**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)
@@ -17,23 +19,57 @@ Run this command:
```bash
$ cd wand && sudo docker-compose up
```
## Basic setup
## Manual setup
**Step 1** Install git, docker & docker-compose
> [!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
<details>
<summary>Debian/Ubuntu</summary>
```bash
$ sudo apt update
$ sudo apt install docker.io git curl
$ 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
$ 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>
**Step 2** Clone the repository & submodules
```bash
$ git clone --recurse-submodules https://github.com/solero/wand && cd wand
```
**Step 3** Edit the config file
**Step 3** Edit the config file (optional, default values are fine for a local setup)
```bash
$ nano .env
```