{"id":18566826,"url":"https://github.com/morrownr/8814au","last_synced_at":"2025-05-15T10:07:35.566Z","repository":{"id":39515493,"uuid":"317134646","full_name":"morrownr/8814au","owner":"morrownr","description":"Linux Driver for USB WiFi Adapters that are based on the RTL8814AU Chipset","archived":false,"fork":false,"pushed_at":"2025-03-04T15:32:45.000Z","size":3136,"stargazers_count":560,"open_issues_count":54,"forks_count":111,"subscribers_count":25,"default_branch":"main","last_synced_at":"2025-04-14T16:57:59.282Z","etag":null,"topics":["8814au","kali","linux","linux-driver","linux-mint","raspberry-pi","realtek","rtl8814au","ubuntu","usb","wifi"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/morrownr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"supported-device-IDs","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-11-30T06:46:22.000Z","updated_at":"2025-04-09T09:56:29.000Z","dependencies_parsed_at":"2024-11-06T22:30:58.756Z","dependency_job_id":"7d4d0732-8004-421b-8377-2cd5ccbc0c37","html_url":"https://github.com/morrownr/8814au","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morrownr%2F8814au","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morrownr%2F8814au/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morrownr%2F8814au/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/morrownr%2F8814au/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/morrownr","download_url":"https://codeload.github.com/morrownr/8814au/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319720,"owners_count":22051073,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["8814au","kali","linux","linux-driver","linux-mint","raspberry-pi","realtek","rtl8814au","ubuntu","usb","wifi"],"created_at":"2024-11-06T22:24:30.146Z","updated_at":"2025-05-15T10:07:30.553Z","avatar_url":"https://github.com/morrownr.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"Notice: This notice is to let you know that a new mac80211 compatible\nrtl8814au driver is available. It is currently being upstreamed into\nthe Linux Mainline kernel. Testing shows the driver is stabile and\nrelatively bug free. It is a much better quality driver than the one in\nthis repo. It is expected that the driver will be available in kernel\n6.15.\n\nThe driver can be installed now at the following repo:\n\nhttps://github.com/lwfinger/rtw88\n\nRemember to first remove the driver in this repo or from whatever repo\nyou may have installed. You can run the following to remove it if using\nthis repo:\n\n$ sudo sh remove-driver.sh\n\nMy plan is to discontinue maintenance updates on this repo with the\nupdate for kernel 6.14.\n\nRegards,\n\n@morrownr\n\n## 8814au ( 8814au.ko ) :rocket:\n\n## Linux Driver for USB WiFi Adapters that are based on the RTL8814AU Chipset\n\n- v5.8.5.1 (Realtek) (20191029) - Plus updates from the Linux community\n\nNote: Please read the file \"supported-device-IDs\" for information about\nhow to confirm that this is the correct driver for your adapter.\n\nNote: Posting this driver is not a recommendation for Linux users to buy\nUSB WiFi adapters based on the Realtek chipsets supported by this driver.\nRealtek out-of-kernel wifi drivers, such as this one, are not Linux Wireless\nStandards compliant and appear to be designed to be used by skilled\nprogrammers producing products such as embedded systems. Users of desktop\nand server distros such as Ubuntu, Debian, Manjaro, Fedora, Raspberry Pi OS\nand other mainline desktop and server distros will likely find adapters that\nuse in-kernel drivers (Linux Wireless Standards compliant) to be more stable\nand much more trouble-free. The following links will provide more\ninformation:\n\n[USB WiFi adapters that are supported with Linux in-kernel drivers](https://github.com/morrownr/USB-WiFi/blob/main/home/USB_WiFi_Adapters_that_are_supported_with_Linux_in-kernel_drivers.md)\n\n[USB WiFi adapter information for Linux](https://github.com/morrownr/USB-WiFi/blob/main/home/USB_WiFi_Adapter_Information_for_Linux.md)\n\n### Supported Features\n\n- IEEE 802.11 b/g/n/ac WiFi compliant\n- 802.1x, WEP, WPA TKIP and WPA2 AES/Mixed mode for PSK and TLS (Radius)\n- IEEE 802.11b/g/n/ac Client mode\n  * Supports wireless security for WEP, WPA TKIP and WPA2 AES PSK\n  * Supports site survey scan and manual connect\n  * Supports power saving mode\n- Supported interface modes\n  * Managed\n  * Monitor (see FAQ)\n  * AP (see FAQ)\n- Log level control\n- LED control\n- Power saving control\n- VHT control (allows 80 MHz channel width in AP mode)\n- USB mode control\n\n### A FAQ is available in this repo with the name `FAQ.md`\n\n- Please read the FAQ and this document before posting issues.\n\n### Additional documentation is in the file `8812au.conf`\n\n### Compatible CPU Architectures\n\n- x86, i386, i686\n- x86-64, amd64\n- armv6l, armv7l (arm)\n- aarch64 (arm64)\n\nNote: Additional CPU architectures may work but I currently only have\nthe hardware to test the above.\n\n### Compatible Kernels\n\n- Kernels: 5.4 - 5.2  (Realtek)\n- Kernels: 5.3 - 6.13 (community support)\n\nNote: Kernels earlier than 5.4 may work but are not tested or\nsupported.\n\n### Tested Compilers\n\n- gcc 12, 13 and 14\n\n### Tested Linux Distributions\n\nNote: The information in this section depends largely on user reports\nwhich can be provided via PR or message in Issues.\n\n- [Arch Linux](https://www.archlinux.org) (kernels 5.4, 5.11 and 6.6)\n\n- [Armbian](https://www.armbian.com/) (kernel 5.15) (Rock 4 SE (Rock 4b image with xfce))\n\n- [Debian](https://www.debian.org/) (kernels 5.10, 5.15, 6.1 and 6.6)\n\n- [Fedora](https://getfedora.org) Fedora 38 (6.2.13-300)\n\n- [Manjaro](https://manjaro.org) (kernel 5.15)\n\n- [openSUSE](https://www.opensuse.org/) Tumbleweed (rolling) (kernel 5.15)\n\n- [Raspberry Pi OS](https://www.raspberrypi.org) (2023-12-05)(ARM 32 bit and 64 bit)\n\n- [Raspberry Pi Desktop](https://www.raspberrypi.org) (2022-07-01) (x86 32 bit) (kernel 5.10)\n\n- [Ubuntu](https://www.ubuntu.com) 22.04 (kernel 5.15) and 22.10 (kernel 5.19) (kernel 6.5)\n\n- [Ubuntu](https://www.ubuntu.com) 22.04 (kernel 5.15) and 22.10 (kernel 5.19) (kernel 6.2)\n\n- [Void Linux](https://voidlinux.org/) (kernel 5.18)\n\nNote: Red Hat Enterprise Linux (RHEL) and distros based on RHEL are not\nsupported due to the way kernel patches are handled. I will support\nknowledgable RHEL developers if they want to merge the required\nsupport and keep it current. I reserve the right to delete this support\nif it causes any problems.\n\nNote: Android is supported in the driver according to Realtek. I will\nsupport knowledgable Android developers if they want to merge and keep\ncurrent the required support (most likely just instructions about how to\ncompile and make a modification or two to the Makefile).\n\n### Compatible Devices\n\n* ALFA AWUS1900\n* ASUS USB-AC68 AC1900 Dual-Band USB 3.0 WiFi Adapter\n* Edimax EW-7833 UAC AC1750 Dual-Band Wi-Fi USB 3.0 Adapter\n* COMFAST CF-958AC\n* Numerous adapters that are based on the supported chipset.\n\nNote: If you are looking for information about what adapter to buy,\nclick [here](https://github.com/morrownr/USB-WiFi) and look for Main Menu\nitem 2 which will show information about and links to recommended adapters.\n\n### Installation Information\n\nWarning: Installing multiple out-of-kernel drivers for the same hardware\nusually does not end well. The install-driver.sh script has the capability\nto detect and remove many conflicting drivers but not all. If this driver\ndoes not work well after installation and you have previously installed a\ndriver that you did not remove, it is suggested that you run the following\ncommand in an effort to determine if you need to take action to manually\nremove conflicting drivers:\n\n```\nsudo dkms status\n```\n\nWarning: If you decide to do a distro upgrade, which will likely install a\nnew version of kernel such as 5.15 to 6.1, you need to upgrade this driver\nwith the newest available code before performing the disto upgrade. Use\nthe following commands in the driver directory:\n\n```\ngit pull\n```\n\n```\nsudo ./install-driver.sh\n```\n\nTemporary internet access is required for installation. There are numerous ways\nto enable temporary internet access depending on your hardware and situation.\n[One method is to use tethering from a phone.](https://www.makeuseof.com/tag/how-to-tether-your-smartphone-in-linux).\nAnother method is to keep a [WiFi adapter that uses an in-kernel driver](https://github.com/morrownr/USB-WiFi/blob/main/home/USB_WiFi_Adapters_that_are_supported_with_Linux_in-kernel_drivers.md) in your toolkit.\n\nYou will need to use the terminal interface. The quick way to open a terminal:\nCtrl+Alt+T (hold down on the Ctrl and Alt keys then press the T key).\n\nAn alternative terminal is to use SSH (Secure Shell) from the same or from\nanother computer, in which case you will be in a suitable terminal after logging\nin, but this step requires that an SSH daemon/server has already been\nconfigured. (There are lots of SSH guides available, e.g., for the [Raspberry Pi](https://www.raspberrypi.com/documentation/computers/remote-access.html#setting-up-an-ssh-server) and for [Ubuntu](https://linuxconfig.org/ubuntu-20-04-ssh-server). Do not forget [to secure the SSH server](https://www.howtogeek.com/443156/the-best-ways-to-secure-your-ssh-server/).)\n\nYou will need to have sufficient access rights to use `sudo` so that commands\ncan be executed as the `root` user. (If the command `sudo echo Yes` returns\n\"Yes\", with or without having to enter your password, you do have sufficient\naccess rights.)\n\nDKMS is used for the installation, if available. DKMS is a system utility\nwhich will automatically recompile and reinstall this driver when a new\nkernel is installed. DKMS is provided by and maintained by Dell.\n\nIt is recommended that you do not delete the driver directory after\ninstallation as the directory contains information and scripts that you\nmay need in the future.\n\nSecure Boot: see FAQ.\n\n### Installation Steps\n\nNote: The installation instructions are for the novice user. Experienced users are\nwelcome to alter the installation to meet their needs. Support will be provided,\non a best effort basis, based on the steps below.\n\n#### Step 1: Open a terminal (e.g. Ctrl+Alt+T)\n\n#### Step 2: Update and upgrade system packages (select the option for the distro you are using)\n\nNote: If your Linux distro does not fall into one of options listed\nbelow, you will need to research how to `update` and `upgrade` your system\npackages.\n\n- Option for Debian based distributions such as Ubuntu, Kali, Armbian and Raspberry Pi OS\n\n```\nsudo apt update \u0026\u0026 sudo apt upgrade\n```\n\n- Option for Arch based distributions such as Manjaro\n\n```\nsudo pacman -Syu\n```\n\n- Option for Fedora based distributions\n\n```\nsudo dnf upgrade\n```\n\n- Option for openSUSE based distributions\n\n```\nsudo zypper update\n```\n\n- Option for Void Linux\n\n```\nsudo xbps-install -Syu\n```\n\nNote: It is recommended that you reboot your system at this point. The\nrest of the installation will appreciate having a fully up-to-date\nsystem to work with. The installation can then be continued with Step 3.\n\n```\nsudo reboot\n```\n\n#### Step 3: Install the required packages (select the option for the distro you are using)\n\nNote: If your Linux distro does not fall into one of options listed\nbelow, you will need to research how to properly setup up the development\nenvironment for your system. General guidance follows.\n\nDevelopment Environment Requirements: (package names may vary by distro)\n\n- Mandatory packages: `gcc` `make` `bc` `kernel-headers` `build-essential` `git`\n- Highly recommended packages: `dkms` `rfkill` `iw` `ip`\n- Mandatory packages if Secure Boot is active: `openssl` `sign-file` `mokutil`\n\nNote: The below options should take care of the mandatory and highly recommended\nrequirements. If Secure Boot is active on your system, please also install the\nmandatory packages for Secure Boot as shown above.\n\n- Option for Armbian (arm64)\n\n```\nsudo apt install -y build-essential\n```\n\n- Option for Raspberry Pi OS (arm/arm64)\n\n```\nsudo apt install -y raspberrypi-kernel-headers build-essential bc dkms git\n```\n\n- Option for Debian, Kali, and Raspberry Pi Desktop (x86) (if using kali-pi for RasPi4B/5B, see note)\n\n```\nsudo apt install -y linux-headers-$(uname -r) build-essential bc dkms git libelf-dev rfkill iw\n```\n\nNote: The following is needed if using kali-pi for RasPi4B/5B.\n\n```\nsudo apt install -y kalipi-kernel-headers build-essential bc dkms git\n```\n\n- Option for Ubuntu (all official flavors) and the numerous Ubuntu based distros\n\n```\nsudo apt install -y build-essential dkms git iw\n```\n\n- Option for Fedora\n\n```\nsudo dnf -y install git dkms kernel-devel\n```\n\n- Option for openSUSE\n\n```\nsudo zypper install -t pattern devel_kernel dkms\n```\n\n- Option for Alpine\n\n```\nsudo apk add linux-lts-dev make gcc\n```\n\n- Option for Void Linux\n\n```\nsudo xbps-install linux-headers dkms git make\n```\n\n- Options for Arch and Manjaro (if using Manjaro for RasPi4B/5B, see note)\n\nIf using pacman\n\n```\nsudo pacman -S --noconfirm linux-headers dkms git bc iw\n```\n\nNote: The following is needed if using Manjaro for RasPi4B/5B.\n\n```\nsudo pacman -S --noconfirm linux-rpi4-headers dkms git bc\n```\n\nNote: If you are asked to choose a provider, make sure to choose the one\nthat corresponds to your version of the linux kernel (for example,\n\"linux510-headers\" for Linux kernel version 5.10). If you install the\nincorrect version, you'll have to uninstall it and install the correct\nversion.\n\nIf using other methods, please follow the instructions provided by those\nmethods.\n\n#### Step 4: Create a directory to hold the downloaded driver\n\n```\nmkdir -p ~/src\n```\n\n#### Step 5: Move to the newly created directory\n\n```\ncd ~/src\n```\n\n#### Step 6: Download the driver\n\n```\ngit clone https://github.com/morrownr/8814au.git\n```\n\n#### Step 7: Move to the newly created driver directory\n\n```\ncd ~/src/8814au\n```\n\n#### Step 8: Run the installation script (`install-driver.sh`)\n\nNote: It is recommended that you terminate running apps so as to provide the\nmaximum amount of RAM to the compilation process.\n\nNote: For automated builds (non-interactive), use `NoPrompt` as an option.\n\n```\nsudo ./install-driver.sh\n```\n\nor\n\n```\nsudo sh install-driver.sh\n```\n\nNote: If you elect to skip the reboot at the end of the installation\nscript, the driver may not load immediately and the driver options will\nnot be applied. Rebooting is strongly recommended.\n\nNote: Fedora users that have secure boot turned on may need to run the\nfollowing to enroll the key:\n\n```\nsudo mokutil --import /var/lib/dkms/mok.pub\n```\n\n### Manual Installation Instructions\n\nNote: The above installation steps automate the installation process,\nhowever, if you want to or need to do a basic command line installation,\nuse the following:\n\n```\nmake clean\n```\n\n```\nmake\n```\n\nIf secure boot is off:\n\n```\nsudo make install\n```\n\n```\nsudo reboot\n```\n\nIf secure boot is on:\n\nNote: Please read to the end of this section before coming back here to\nenter commands.\n\n```\nsudo make sign-install\n```\n\nYou will be promted for a password, please remember the password as it\nwill be used in some of the following steps.\n\n```\nsudo reboot\n```\n\nThe MOK managerment screen will appear during boot:\n\n`Shim UEFI Key Management\"\n\n`Press any key...`\n\nSelect \"Enroll key\"\n\nSelect \"Continue\"\n\nSelect \"Yes\"\n\nWhen promted, enter the password you entered earlier.\n\nIf you enter the wrong password, your computer will not be bootable. In\nthis case, use the BOOT menu from your BIOS to boot then as follows:\n\n```\nsudo mokutil --reset\n```\n\nRestart your computer and use the BOOT menu from BIOS to boot. In the MOK\nmanagerment screen, select `reset MOK list`. Then Reboot and retry from\nthe step `sudo make sign-install`.\n\nTo remove the driver if installed by the manual installation instructions:\n\n```\nsudo make uninstall\n```\n\n```\nsudo reboot\n```\n\nNote: If you use the manual installation instructions, you will need to\nrepeat the process each time a new kernel is installed in your distro.\n\n-----\n\n### Driver Options (`edit-options.sh`)\n\nA file called `8814au.conf` will be installed in `/etc/modprobe.d` by\ndefault if you use the `install-driver.sh` script.\n\nNote: The installation script will prompt you to edit the options.\n\nLocation: `/etc/modprobe.d/8814au.conf`\n\nThis file will be read and applied to the driver on each system boot.\n\nTo edit the driver options file, run the `edit-options.sh` script\n\n```\nsudo ./edit-options.sh\n```\n\nNote: Documentation for Driver Options is included in the file `8814au.conf`.\n\n-----\n\n### Upgrading the Driver\n\nNote: Linux development is continuous therefore work on this driver is continuous.\n\nNote: Upgrading the driver is advised in the following situations:\n\n- if a new or updated version of the driver needs to be installed\n- if a distro version upgrade is going to be installed (i.e. going from kernel 5.10 to kernel 5.15)\n\n#### Step 1: Move to the driver directory\n\n```\ncd ~/src/8814au\n```\n\n#### Step 2: Remove the currently installed driver\n\n```\nsudo ./remove-driver.sh\n```\n\n#### Step 3: Pull updated code from this repo\n\n```\ngit pull\n```\n\n#### Step 4: Install the driver\n\n```\nsudo ./install-driver.sh\n```\n\n-----\n### Removal of the Driver (`remove-driver.sh`)\n\nNote: Removing the driver is advised in the following situations:\n\n- if the driver is no longer needed\n\nNote: The following removes everything that has been installed, with the\nexception of the packages installed in Step 3 and the driver directory.\nThe driver directory can be deleted after running this script.\n\n#### Step 1: Open a terminal (e.g. Ctrl+Alt+T)\n\n#### Step 2: Move to the driver directory\n\n```\ncd ~/src/8814au\n```\n\n#### Step 3: Run the removal script\n\nNote: For automated builds (non-interactive), use `NoPrompt` as an\noption.\n\n```\nsudo ./remove-driver.sh\n```\n\n-----\n\n### Recommended WiFi Router/ Access Point Settings\n\nNote: These recommendations apply when using your adapter in managed\n(client) mode, not AP mode.\n\nNote: These are general recommendations, some of which may not apply to\nyour specific situation.\n\n- Security: Set WPA2-AES or WPA2/WPA3 mixed or WPA3. Do not set WPA2\nmixed mode or WPA or TKIP.\n\n- Channel width for 2.4 GHz: Set 20 MHz fixed width. Do not use 40 MHz\nor 20/40 automatic.\n\n- Channels for 2.4 GHz: Set channel 1 or 6 or 11 depending on the\ncongestion at your location. Do not set automatic channel selection. As\ntime passes, if you notice poor performance, recheck congestion and set\nchannel appropriately. The environment around you can and does change\nover time.\n\n- Mode for 2.4 GHz: For best performance, set \"N only\" if you no longer\nuse B or G capable devices.\n\n- Network names: Do not set the 2.4 GHz Network and the 5 GHz Network\nto the same name. Note: Unfortunately many routers come with both\nnetworks set to the same name. You need to be able to control which\nnetwork that is in use so changing the name of one of the networks is\nrecommended. Since many IoT devices use the 2.4 GHz network, it may be\nbetter to change the name of the 5 GHz network.\n\n- Channels for 5 GHz: Not all devices are capable of using DFS channels\n(I'm looking at you Roku.) It may be necessary to set a fixed channel in\nthe range of 36 to 48 or 149 to 165 in order for all of your devices to\nwork on 5 GHz. (For US, other countries may vary.)\n\n- Best location for the WiFi router/access point: Near center of\napartment or house, at least a couple of feet away from walls, in an\nelevated location. You may have to test to find the best location is\nin your environment.\n\n- Check congestion: There are apps available for smart phones that allow\nyou to get an idea of the congestion levels on WiFi channels. The apps\ngenerally go by the name of `WiFi Analyzer` or something similar.\n\nAfter making and saving changes, reboot the router.\n\n-----\n\n### Recommendations regarding USB\n\n- Moving your USB WiFi adapter to a different USB port has been known to\nfix a variety of problems.\n\n- If connecting your USB WiFi adapter to a desktop computer, use the USB\nports on the rear of the computer if you encounter any problems. Why?\nThe ports on the rear are directly connected to the motherboard which\nwill reduce problems with interference and disconnection. An extension\ncable can be helpful to position the adapter for best reception.\n\n- If your USB WiFi adapter is USB 3 capable and you want it to operate\nin USB3 mode, plug it into a USB 3 port.\n\n- Avoid USB 3.1 Gen 2 ports if possible as most currently available\nadapters have been tested with USB 3.1 Gen 1 (aka USB 3) and not with\nUSB 3.1 Gen 2.\n\n- If you use an extension cable and your adapter is USB 3 capable, the\ncable needs to be USB 3 capable (if not, you will be limited to USB 2\nspeeds).\n\n- Extention cables can be problematic. A way to check if the extension\ncable is the problem is to plug the adapter temporarily into a USB port\non the computer.\n\n- Some USB WiFi adapters require considerable electrical current and\npush the capabilities of the power available via USB port. One example\nis adapters that use the Realtek 8814au chipset. Using a powered\nmultiport USB extension can be a good idea in cases like this.\n\n-----\n\nTo Contribute:\n\n- Fork this repository.\n- Make your edits.\n- TEST THEM!\n- Create a pull request.\n\n-----\n\n#### [Go to Main Menu](https://github.com/morrownr/USB-WiFi)\n\n-----\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorrownr%2F8814au","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorrownr%2F8814au","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorrownr%2F8814au/lists"}