Skip to content

Commit

Permalink
docs: update docker usage
Browse files Browse the repository at this point in the history
  • Loading branch information
superrnovae committed Sep 18, 2022
1 parent 5f843be commit fd27fb7
Showing 1 changed file with 8 additions and 18 deletions.
26 changes: 8 additions & 18 deletions docs/usage/run-in-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,6 @@
description: Run Permasigner in the official Docker container.
---

**TLDR:** The Docker commands are:
* Pull the container with `docker pull ghcr.io/permasigner/permasigner`
* To permasign:
* \[Windows] `docker run -it --rm -v ${pwd}/output:/permasigner/output -v ${pwd}/ipas:/permasigner/ipas permasigner/permasigner`
* \[Linux/macOS] `docker run -it --rm -v "$PWD/output":/permasigner/output -v "$PWD/ipas":/permasigner/ipas -e DEBUG=1 permasigner/permasigner`
* To permasign and install produced deb to your device (must be connected):
* \[Windows] `docker run -it --rm -v ${pwd}/output:/permasigner/output -v ${pwd}/ipas:/permasigner/ipas -e DEBUG=1 -e WINDOWS=1 -e INSTALL=1 permasigner/permasigner`
* \[Linux/macOS] `docker run -it --privileged --rm -p 2222:2222 -v /var/run/usbmuxd:/var/run/usbmuxd -v "$PWD/output":/permasigner/output -v "$PWD/ipas":/permasigner/ipas -e DEBUG=1 -e INSTALL=1 permasigner/permasigner`

---

* [Install Docker](https://docs.docker.com/get-docker/)
* Open a terminal
* \[Windows] Hold Win + R and type `powershell`.
Expand All @@ -21,13 +10,14 @@ description: Run Permasigner in the official Docker container.
* Pull the container with `docker pull ghcr.io/permasigner/permasigner`
* Create `output` and `ipas` directories.
* Launch the Docker container with:
* To permasign:
* \[Windows] `docker run -it --rm -v ${pwd}/output:/permasigner/output -v ${pwd}/ipas:/permasigner/ipas permasigner/permasigner`.
* \[Linux/macOS] `docker run -it --rm -v "$PWD/output":/permasigner/output -v "$PWD/ipas":/permasigner/ipas permasigner/permasigner`
* To permasign and install produced deb to your device (must be connected):
* \[Windows] `docker run -it --rm -v ${pwd}/output:/permasigner/output -v ${pwd}/ipas:/permasigner/ipas -e DEBUG=1 -e WINDOWS=1 -e INSTALL=1 permasigner/permasigner`
* \[Linux/macOS] `docker run -it --privileged --rm -p 2222:2222 -v /var/run/usbmuxd:/var/run/usbmuxd -v "$PWD/output":/permasigner/output -v "$PWD/ipas":/permasigner/ipas -e DEBUG=1 -e INSTALL=1 permasigner/permasigner`
* \[Windows] `docker run -it --rm -v ${pwd}/output:/app/output -v ${pwd}/ipas:/app/ipas permasigner/permasigner -d`.
* \[Linux/macOS] `docker run -it --rm -v "$PWD/output":/app/output -v "$PWD/ipas":/app/ipas permasigner/permasigner -d`\
* Append additional script arguments at the end of the command.

* It is possible to deploy produced deb to device and install it from within the docker container. For that pass additonal arguments to docker command.
* \[Windows] `no additional arguments are required`.
* \[Linux/macOS] `--privileged -p 2222:2222 -v /var/run/usbmuxd:/var/run/usbmuxd`
* Send the deb file to your iDevice
* The script can do that for you, you will be asked to input the user password for ssh access.
* Airdropping the file is probably the easiest, but you can use something like Dropbox or Mega. Advanced users can use openssh-sftp-server from Procursus.
* Reboot to stock, the app will still work!
* Reboot to stock, the app will still work!

0 comments on commit fd27fb7

Please sign in to comment.