From fd27fb78a24c8641928beac10601df2c088cf7e8 Mon Sep 17 00:00:00 2001 From: superrnovae Date: Sun, 18 Sep 2022 23:00:32 +0200 Subject: [PATCH] docs: update docker usage --- docs/usage/run-in-docker.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/docs/usage/run-in-docker.md b/docs/usage/run-in-docker.md index c7e338dc..25513e67 100644 --- a/docs/usage/run-in-docker.md +++ b/docs/usage/run-in-docker.md @@ -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`. @@ -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! \ No newline at end of file