mirror of
https://github.com/RfidResearchGroup/proxmark3.git
synced 2025-08-20 13:23:51 -07:00
Merge pull request #1309 from linuxgemini/doc-pass
Doc correction for windows, macos and troubleshooting
This commit is contained in:
commit
61542bb1db
4 changed files with 23 additions and 15 deletions
|
@ -18,11 +18,15 @@ Visual Studio Code still runs under Rosetta 2 and if you're developing for proxm
|
||||||
|
|
||||||
## Install Proxmark3 tools
|
## Install Proxmark3 tools
|
||||||
|
|
||||||
These instructions comes from @Chrisfu, where we got the proxmark3.rb scriptfile from.
|
These instructions comes from \@Chrisfu, where we got the proxmark3.rb scriptfile from.
|
||||||
For further questions about Mac & Homebrew, contact @Chrisfu (https://github.com/chrisfu/)
|
For further questions about Mac & Homebrew, contact [\@Chrisfu on Twitter](https://github.com/chrisfu/)
|
||||||
|
|
||||||
|
0. Install XCode Command Line Tools if you haven't yet already done so: `xcode-select --install`
|
||||||
|
|
||||||
1. Install homebrew if you haven't yet already done so: http://brew.sh/
|
1. Install homebrew if you haven't yet already done so: http://brew.sh/
|
||||||
|
|
||||||
|
2. Install xquartz: `brew install xquartz`
|
||||||
|
|
||||||
2. Tap this repo: `brew tap RfidResearchGroup/proxmark3`
|
2. Tap this repo: `brew tap RfidResearchGroup/proxmark3`
|
||||||
|
|
||||||
3. Install Proxmark3:
|
3. Install Proxmark3:
|
||||||
|
|
|
@ -175,7 +175,7 @@ When ```explorer.exe .``` doesn't work.
|
||||||
Trying to access the dump files created in WSL, you will need to run ```explorer.exe .``` but sometimes this doesn't work.
|
Trying to access the dump files created in WSL, you will need to run ```explorer.exe .``` but sometimes this doesn't work.
|
||||||
[As seen here](https://github.com/microsoft/WSL/issues/4027) they suggest checking the following registry value for *P9NP*
|
[As seen here](https://github.com/microsoft/WSL/issues/4027) they suggest checking the following registry value for *P9NP*
|
||||||
|
|
||||||
[<img src="http://www.icedev.se/proxmark3/rdv40/wsl2_p9np.png">](www.icedev.se/proxmark3/rdv40/wsl2_p9np.png)
|
[](/doc/md/Use_of_Proxmark/wsl2_p9np.png)
|
||||||
|
|
||||||
## Troubles with running the Proxmark3 client
|
## Troubles with running the Proxmark3 client
|
||||||
Some reports has stated that they needed to execute the Proxmark3 as root on their *nix system.
|
Some reports has stated that they needed to execute the Proxmark3 as root on their *nix system.
|
||||||
|
@ -228,7 +228,9 @@ If you get the message
|
||||||
|
|
||||||
```
|
```
|
||||||
Qt: Session management error: None of the authentication protocols specified are supported
|
Qt: Session management error: None of the authentication protocols specified are supported
|
||||||
``` when running the Proxmark3 client it might be because a a environment variable.
|
```
|
||||||
|
|
||||||
|
when running the Proxmark3 client it might be because a a environment variable.
|
||||||
|
|
||||||
Solution:
|
Solution:
|
||||||
Try running the client without the SESSION_MANAGER environment variable.
|
Try running the client without the SESSION_MANAGER environment variable.
|
||||||
|
|
|
@ -21,7 +21,7 @@ We have listed three ways to use these two setups (dev environment vs pre-compi
|
||||||
|
|
||||||
## Video Installation guide
|
## Video Installation guide
|
||||||
_note: this video is a bit out-of-date but still informative_
|
_note: this video is a bit out-of-date but still informative_
|
||||||
[](https://youtu.be/zzF0NCMJnYU "Windows Installation Tutorial")
|
[](https://youtu.be/zzF0NCMJnYU "Windows Installation Tutorial")
|
||||||
|
|
||||||
## Driver Installation ( Windows 7 )
|
## Driver Installation ( Windows 7 )
|
||||||
|
|
||||||
|
@ -92,10 +92,10 @@ to be done (tcprst)
|
||||||
|
|
||||||
WSL 1 requires to run on Windows 10 version 1709 or above. Previous windows versions didn't have support for COM ports.
|
WSL 1 requires to run on Windows 10 version 1709 or above. Previous windows versions didn't have support for COM ports.
|
||||||
|
|
||||||
### stay away from WSL 2
|
### Stay away from WSL 2
|
||||||
*Microsoft introduced WSL 2 starting on Windows 10 version 2004 with Hyper-V powering its virtualization; As of 2020-08-13, WSL 2 does not support USB and Serial.*
|
*Microsoft introduced WSL 2 starting on Windows 10 version 2004 with Hyper-V powering its virtualization; As of 2020-08-13, WSL 2 does not support USB and Serial.*
|
||||||
|
|
||||||
###
|
### More about WSL
|
||||||
Install WSL 1 with e.g. the standard Ubuntu. You can follow the guide on [Microsoft Docs](https://docs.microsoft.com/en-us/windows/wsl/install-win10) but be careful to follow WSL 1 specific instructions! When they recommend you to restart, you must restart.
|
Install WSL 1 with e.g. the standard Ubuntu. You can follow the guide on [Microsoft Docs](https://docs.microsoft.com/en-us/windows/wsl/install-win10) but be careful to follow WSL 1 specific instructions! When they recommend you to restart, you must restart.
|
||||||
|
|
||||||
For WSL configuration, see [Manage and configure Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/wsl-config).
|
For WSL configuration, see [Manage and configure Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/wsl-config).
|
||||||
|
@ -107,23 +107,25 @@ Make sure your WSL can launch Windows processes to get the `pm3` scripts working
|
||||||
If you want to run the graphical components of the Proxmark3 client, you need to install a X Server such as [VcXsrv](https://sourceforge.net/projects/vcxsrv/) or [Xming](https://sourceforge.net/projects/xming/) and launch it, e.g. by executing XLaunch.
|
If you want to run the graphical components of the Proxmark3 client, you need to install a X Server such as [VcXsrv](https://sourceforge.net/projects/vcxsrv/) or [Xming](https://sourceforge.net/projects/xming/) and launch it, e.g. by executing XLaunch.
|
||||||
|
|
||||||
|
|
||||||
## Window terminal Installation
|
## Windows Terminal Installation
|
||||||
Microsoft has recent released a new terminal for their OS. It is much better experience than old `cmd.exe` so we strongly recommend installing it.
|
Microsoft has recently released a new terminal for their OS. It is much better experience than old `cmd.exe` so we strongly recommend installing it.
|
||||||
It is also open sourced, ref [terminal](https://github.com/microsoft/terminal). You can download and install from here: [windows terminal](https://aka.ms/terminal)
|
It is also open sourced (see [github.com/microsoft/terminal](https://github.com/microsoft/terminal)). You can download and install from [GitHub](https://github.com/microsoft/terminal/releases/latest) or [Microsoft Store](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701).
|
||||||
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
Enter WSL prompt (`wsl` or `start windows terminal`) and from there, follow the [Linux Installation Instructions](/doc/md/Installation_Instructions/Linux-Installation-Instructions.md) for Ubuntu, summarized here below:
|
Enter WSL prompt (`wsl` or Start Windows Terminal) and from there, follow the [Linux Installation Instructions](/doc/md/Installation_Instructions/Linux-Installation-Instructions.md) for Ubuntu, summarized here below:
|
||||||
|
|
||||||
|
Make sure your WSL guest OS is up-to-date first:
|
||||||
|
|
||||||
Make sure your WSL guest OS is up-to-date first
|
|
||||||
```sh
|
```sh
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get upgrade -y
|
sudo apt-get upgrade -y
|
||||||
sudo apt-get auto-remove -y
|
sudo apt-get auto-remove -y
|
||||||
```
|
```
|
||||||
|
|
||||||
Install dependencies
|
Install dependencies:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
sudo apt-get install --no-install-recommends git ca-certificates build-essential pkg-config \
|
sudo apt-get install --no-install-recommends git ca-certificates build-essential pkg-config \
|
||||||
libreadline-dev gcc-arm-none-eabi libnewlib-dev libbz2-dev qtbase5-dev
|
libreadline-dev gcc-arm-none-eabi libnewlib-dev libbz2-dev qtbase5-dev
|
||||||
|
@ -158,13 +160,13 @@ If group ownership is `dialout` and your user is member of `dialout` group, all
|
||||||
sudo chmod 666 /dev/ttySX
|
sudo chmod 666 /dev/ttySX
|
||||||
```
|
```
|
||||||
|
|
||||||
If you installed a X Server and compiled the Proxmark3 with QT4 support, you've to export the `DISPLAY` environment variable:
|
If you installed an X Server and compiled the Proxmark3 with QT5 support, you've to export the `DISPLAY` environment variable:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export DISPLAY=:0
|
export DISPLAY=:0
|
||||||
```
|
```
|
||||||
|
|
||||||
and add it to your Bash profile for the next times:
|
And add it to your Bash (or your preferred shell) profile for the next times:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
echo "export DISPLAY=:0" >> ~/.bashrc
|
echo "export DISPLAY=:0" >> ~/.bashrc
|
||||||
|
|
BIN
doc/md/Installation_Instructions/wsl2_p9np.png
Normal file
BIN
doc/md/Installation_Instructions/wsl2_p9np.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 24 KiB |
Loading…
Add table
Add a link
Reference in a new issue