From eb7c5a459b59b966b037cfe0ac37c1c8ef3d9bab Mon Sep 17 00:00:00 2001 From: Gavin Liddell <51942756+GavinL2001@users.noreply.github.com> Date: Sun, 8 Sep 2024 15:41:18 +0000 Subject: [PATCH 1/6] refactor README.md --- README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 66 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1a6a0d3..9e7c05e 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,76 @@ A dockerized version of [AltServer-Linux](https://github.com/NyaMisty/AltServer-Linux) with Wi-Fi sync capability. -## Run the server +## Requirements -### prerequisites +- Docker +- Avahi running on host system +- usbmuxd **NOT** running on host system -The only dependency is docker, but it is important to note two things: +## Installation -- You might not be able to refresh apps if **usbmuxd** is running in the _host_ system, the docker guest already includes it and binds to the usb interface. Make sure your host system is **NOT** running it. -- You might need to be running the **avahi-daemon** in the host system. +### Docker (if not installed already) -### docker compose (recommended) +#### Linux: +```shell +curl -sSL https://get.docker.com | sh +sudo usermod -aG docker $(whoami) +exit +``` + +#### Windows: +[Install WSL2](https://docs.docker.com/desktop/wsl/) then use the Linux install instructions or install using [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/). + +#### macOS: +Install using [Docker Desktop](https://docs.docker.com/desktop/install/mac-install/). + +### Avahi + +#### Arch-based distros: +```shell +pacman -S avahi +``` + +#### Debian/Ubuntu-based distros: +```shell +apt install avahi-daemon +``` + +#### Fedora-based distros: +```shell +dnf install avahi +``` + +#### Enable and start the service using systemd: +```shell +sudo systemctl enable avahi-daemon +sudo systemctl start avahi-daemon +``` + +### Removing usbmuxd from Host System + +#### Arch-based distros: +```shell +pacman -R usbmuxd +``` + +#### Debian/Ubuntu-based distros: +```shell +apt remove usbmuxd +``` + +#### Fedora-based distros: +```shell +dnf remove usbmuxd +``` + +#### Enable and start the service using systemd: +```shell +sudo systemctl stop usbmuxd +sudo systemctl disable usbmuxd +``` + +### Using Docker Compose (recommended) To start up the application, run the docker-compose stack: From f7df1cb3c22650e14bac6b7e7803b23a35e813d7 Mon Sep 17 00:00:00 2001 From: Gavin Liddell <51942756+GavinL2001@users.noreply.github.com> Date: Sun, 8 Sep 2024 15:47:56 +0000 Subject: [PATCH 2/6] change subheaders for better clarity --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9e7c05e..fe2b724 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A dockerized version of [AltServer-Linux](https://github.com/NyaMisty/AltServer- ## Installation -### Docker (if not installed already) +### Installing Docker (if not installed already) #### Linux: ```shell @@ -25,7 +25,7 @@ exit #### macOS: Install using [Docker Desktop](https://docs.docker.com/desktop/install/mac-install/). -### Avahi +### Installing Avahi on Host System #### Arch-based distros: ```shell @@ -71,7 +71,7 @@ sudo systemctl stop usbmuxd sudo systemctl disable usbmuxd ``` -### Using Docker Compose (recommended) +### Run Using Docker Compose (recommended) To start up the application, run the docker-compose stack: @@ -79,7 +79,7 @@ To start up the application, run the docker-compose stack: docker compose up -d --build ``` -### Using `docker run` +### Run Using `docker run` Just run `run.sh`, or manually in your terminal: From 98f3d9c3880d7051283b091b9fb0903cdbac8b71 Mon Sep 17 00:00:00 2001 From: Gavin Liddell <51942756+GavinL2001@users.noreply.github.com> Date: Mon, 9 Sep 2024 01:54:02 -0500 Subject: [PATCH 3/6] change install script to docker guides --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fe2b724..97f2844 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,8 @@ A dockerized version of [AltServer-Linux](https://github.com/NyaMisty/AltServer- ### Installing Docker (if not installed already) #### Linux: -```shell -curl -sSL https://get.docker.com | sh -sudo usermod -aG docker $(whoami) -exit -``` +[Docker Engine (preferred)](https://docs.docker.com/engine/install/) +[Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) #### Windows: [Install WSL2](https://docs.docker.com/desktop/wsl/) then use the Linux install instructions or install using [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/). From f0afbe1daed126ac8aaac0c5f3a1b218d4d6fdde Mon Sep 17 00:00:00 2001 From: Gavin Liddell <51942756+GavinL2001@users.noreply.github.com> Date: Mon, 9 Sep 2024 01:54:36 -0500 Subject: [PATCH 4/6] fix spacing --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 97f2844..c5528a0 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ A dockerized version of [AltServer-Linux](https://github.com/NyaMisty/AltServer- #### Linux: [Docker Engine (preferred)](https://docs.docker.com/engine/install/) + [Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) #### Windows: From 4fe3c66a2b08af1c51e2310662f7fcda3faf31cf Mon Sep 17 00:00:00 2001 From: Gavin Liddell <51942756+GavinL2001@users.noreply.github.com> Date: Mon, 9 Sep 2024 01:55:24 -0500 Subject: [PATCH 5/6] clarify install options --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c5528a0..0d6371e 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ A dockerized version of [AltServer-Linux](https://github.com/NyaMisty/AltServer- ### Installing Docker (if not installed already) #### Linux: -[Docker Engine (preferred)](https://docs.docker.com/engine/install/) +Option 1: [Docker Engine (preferred)](https://docs.docker.com/engine/install/) -[Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) +Option 2: [Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) #### Windows: [Install WSL2](https://docs.docker.com/desktop/wsl/) then use the Linux install instructions or install using [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/). From 2f5546bace2e42e837555258e6384b108e76a196 Mon Sep 17 00:00:00 2001 From: Gavin Liddell <51942756+GavinL2001@users.noreply.github.com> Date: Mon, 9 Sep 2024 07:08:48 +0000 Subject: [PATCH 6/6] small change in language --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d6371e..836e6f2 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ A dockerized version of [AltServer-Linux](https://github.com/NyaMisty/AltServer- ### Installing Docker (if not installed already) #### Linux: -Option 1: [Docker Engine (preferred)](https://docs.docker.com/engine/install/) +Option 1 (preferred): [Docker Engine](https://docs.docker.com/engine/install/) Option 2: [Docker Desktop](https://docs.docker.com/desktop/install/linux-install/)