nixos-hardware/README.md

175 lines
9.5 KiB
Markdown
Raw Normal View History

NixOS profiles to optimize settings for different hardware.
## Setup
2020-07-28 04:53:58 -04:00
### Using channels
Add and update `nixos-hardware` channel:
```
$ sudo nix-channel --add https://github.com/NixOS/nixos-hardware/archive/master.tar.gz nixos-hardware
README: fix nix-channel --update command Following the current instructions yields these errors for some reason: ``` $ sudo nixos-rebuild switch warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos' was not found in the Nix search path (add it using $NIX_PATH or -I), at (string):1:13 building Nix... warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos' was not found in the Nix search path (add it using $NIX_PATH or -I) warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I) warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos/modules/installer/tools/nix-fallback-paths.nix' was not found in the Nix search path (add it using $NIX_PATH or -I) /tmp/nixos-rebuild.vs4JVw/nix warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I) building the system configuration... warning: Nix search path entry '/nix/var/nix/profiles/per-user/root/channels/nixos' does not exist, ignoring error: file 'nixpkgs/nixos' was not found in the Nix search path (add it using $NIX_PATH or -I) ```
2020-04-24 04:36:40 -04:00
$ sudo nix-channel --update
```
Then import an appropriate profile path from the table below. For example, to
enable ThinkPad X220 profile, your `imports` in `/etc/nixos/configuration.nix`
should look like:
```
imports = [
<nixos-hardware/lenovo/thinkpad/x220>
./hardware-configuration.nix
];
```
2020-07-28 04:53:58 -04:00
New updates to the expressions here will be fetched when you update the channel.
## Using nix flakes support
2020-06-24 01:06:51 -04:00
There is also experimental flake support. In your `/etc/nixos/flake.nix` add the following:
```nix
{
description = "NixOS configuration with flakes";
inputs.nixos-hardware.url = github:NixOS/nixos-hardware/master;
outputs = { self, nixpkgs, nixos-hardware }: {
# replace <your-hostname> with your actual hostname
nixosConfigurations.<your-hostname> = nixpkgs.lib.nixosSystem {
# ...
modules = [
# ...
# add your model from this list: https://github.com/NixOS/nixos-hardware/blob/flakes/flake.nix
nixos-hardware.nixosModules.dell-xps-13-9380
];
};
};
}
```
2020-07-28 04:53:58 -04:00
2020-10-13 07:55:46 -04:00
### Using fetchGit
2020-07-28 04:53:58 -04:00
You can fetch the git repository directly:
```nix
2021-02-06 12:03:00 -05:00
imports = [
2020-10-13 07:55:46 -04:00
"${builtins.fetchGit { url = "https://github.com/NixOS/nixos-hardware.git"; }}/lenovo/thinkpad/x220"
2020-07-28 04:53:58 -04:00
];
```
2021-02-06 12:03:00 -05:00
Unlike the channel, this will update the git repository on a rebuild. However,
2020-07-28 04:53:58 -04:00
you can easily pin to a particular revision if you desire more stability.
2020-06-21 04:14:32 -04:00
## List of Profiles
See code for all available configurations.
2019-09-28 17:58:20 -04:00
| Model | Path |
| --------------------------------- | -------------------------------------------------- |
| [Acer Aspire 4810T][] | `<nixos-hardware/acer/aspire/4810t>` |
| Airis N990 | `<nixos-hardware/airis/n990>` |
| Apple MacBook Air 3,X | `<nixos-hardware/apple/macbook-air/3>` |
2019-09-28 17:58:20 -04:00
| Apple MacBook Air 4,X | `<nixos-hardware/apple/macbook-air/4>` |
| Apple MacBook Air 6,X | `<nixos-hardware/apple/macbook-air/6>` |
| [Apple MacBook Pro 10,1][] | `<nixos-hardware/apple/macbook-pro/10-1>` |
| Apple MacBook Pro 12,1 | `<nixos-hardware/apple/macbook-pro/12-1>` |
2020-05-20 10:35:48 -04:00
| Asus TUF FX504GD | `<nixos-hardware/asus/fx504gd>` |
2019-09-28 17:58:20 -04:00
| BeagleBoard PocketBeagle | `<nixos-hardware/beagleboard/pocketbeagle>` |
| [Dell G3 3779][] | `<nixos-hardware/dell/g3/3779>` |
| Dell Latitude 3480 | `<nixos-hardware/dell/latitude/3480>` |
2020-08-29 05:36:27 -04:00
| Dell Precision 5530 | `<nixos-hardware/dell/precision/5530>` |
2019-10-09 10:12:00 -04:00
| [Dell XPS E7240][] | `<nixos-hardware/dell/e7240>` |
2019-10-30 15:15:22 -04:00
| [Dell XPS 13 7390][] | `<nixos-hardware/dell/xps/13-7390>` |
2020-01-08 23:49:26 -05:00
| [Dell XPS 13 9343][] | `<nixos-hardware/dell/xps/13-9343>` |
2019-09-28 17:58:20 -04:00
| [Dell XPS 13 9360][] | `<nixos-hardware/dell/xps/13-9360>` |
| [Dell XPS 13 9370][] | `<nixos-hardware/dell/xps/13-9370>` |
| [Dell XPS 13 9380][] | `<nixos-hardware/dell/xps/13-9380>` |
2020-02-04 06:53:51 -05:00
| [Dell XPS 15 7590][] | `<nixos-hardware/dell/xps/15-7590>` |
2019-09-28 17:58:20 -04:00
| [Dell XPS 15 9550][] | `<nixos-hardware/dell/xps/15-9550>` |
| [Dell XPS 15 9560][] | `<nixos-hardware/dell/xps/15-9560>` |
| [Dell XPS 15 9560, intel only][] | `<nixos-hardware/dell/xps/15-9560/intel>` |
| [Dell XPS 15 9560, nvidia only][] | `<nixos-hardware/dell/xps/15-9560/nvidia>` |
| [Dell XPS 15 9500][] | `<nixos-hardware/dell/xps/15-9500>` |
| [Dell XPS 15 9500, nvidia][] | `<nixos-hardware/dell/xps/15-9500/nvidia>` |
2020-05-07 10:12:35 -04:00
| [Google Pixelbook][] | `<nixos-hardware/google/pixelbook>` |
2019-09-28 17:58:20 -04:00
| [Inverse Path USB armory][] | `<nixos-hardware/inversepath/usbarmory>` |
| Lenovo IdeaPad Z510 | `<nixos-hardware/lenovo/ideapad/z510>` |
| Lenovo ThinkPad E470 | `<nixos-hardware/lenovo/thinkpad/e470>` |
2020-02-12 04:56:49 -05:00
| Lenovo ThinkPad E495 | `<nixos-hardware/lenovo/thinkpad/e495>` |
2020-01-07 10:04:52 -05:00
| Lenovo ThinkPad L13 | `<nixos-hardware/lenovo/thinkpad/l13>` |
| Lenovo ThinkPad L14 (Intel) | `<nixos-hardware/lenovo/thinkpad/l14/intel> |
| Lenovo ThinkPad L14 (AMD) | `<nixos-hardware/lenovo/thinkpad/l14/amd> |
| Lenovo ThinkPad P53 | `<nixos-hardware/lenovo/thinkpad/p53>` |
| Lenovo ThinkPad T14 | `<nixos-hardware/lenovo/thinkpad/t14>` |
| Lenovo ThinkPad T14 AMD Gen 1 | `<nixos-hardware/lenovo/thinkpad/t14/amd/gen1>` |
2020-10-25 14:24:43 -04:00
| Lenovo ThinkPad T14s | `<nixos-hardware/lenovo/thinkpad/t14s>` |
| Lenovo ThinkPad T14s AMD Gen 1 | `<nixos-hardware/lenovo/thinkpad/t14s/amd/gen1>` |
2019-09-28 17:58:20 -04:00
| Lenovo ThinkPad T410 | `<nixos-hardware/lenovo/thinkpad/t410>` |
2019-11-02 06:52:58 -04:00
| Lenovo ThinkPad T420 | `<nixos-hardware/lenovo/thinkpad/t420>` |
2019-09-28 17:58:20 -04:00
| Lenovo ThinkPad T430 | `<nixos-hardware/lenovo/thinkpad/t430>` |
| Lenovo ThinkPad T440s | `<nixos-hardware/lenovo/thinkpad/t440s>` |
| Lenovo ThinkPad T440p | `<nixos-hardware/lenovo/thinkpad/t440p>` |
| Lenovo ThinkPad T450s | `<nixos-hardware/lenovo/thinkpad/t450s>` |
| Lenovo ThinkPad T460s | `<nixos-hardware/lenovo/thinkpad/t460s>` |
| Lenovo ThinkPad T470s | `<nixos-hardware/lenovo/thinkpad/t470s>` |
| Lenovo ThinkPad T480s | `<nixos-hardware/lenovo/thinkpad/t480s>` |
| Lenovo ThinkPad T490 | `<nixos-hardware/lenovo/thinkpad/t490>` |
| Lenovo ThinkPad T495 | `<nixos-hardware/lenovo/thinkpad/t495>` |
2021-02-06 12:03:00 -05:00
| Lenovo ThinkPad X113 Yoga | `<nixos-hardware/lenovo/thinkpad/x13-yoga>` |
2019-09-28 17:58:20 -04:00
| Lenovo ThinkPad X140e | `<nixos-hardware/lenovo/thinkpad/x140e>` |
| Lenovo ThinkPad X220 | `<nixos-hardware/lenovo/thinkpad/x220>` |
| Lenovo ThinkPad X230 | `<nixos-hardware/lenovo/thinkpad/x230>` |
| Lenovo ThinkPad X250 | `<nixos-hardware/lenovo/thinkpad/x250>` |
| [Lenovo ThinkPad X260][] | `<nixos-hardware/lenovo/thinkpad/x260>` |
| Lenovo ThinkPad X270 | `<nixos-hardware/lenovo/thinkpad/x270>` |
2019-12-31 06:43:42 -05:00
| Lenovo ThinkPad X280 | `<nixos-hardware/lenovo/thinkpad/x280>` |
2019-09-28 17:58:20 -04:00
| [Lenovo ThinkPad X1 (6th Gen)][] | `<nixos-hardware/lenovo/thinkpad/x1/6th-gen>` |
2020-05-16 16:12:10 -04:00
| [Lenovo ThinkPad X1 (7th Gen)][] | `<nixos-hardware/lenovo/thinkpad/x1/7th-gen>` |
2019-09-28 17:58:20 -04:00
| Lenovo ThinkPad X1 Extreme Gen 2 | `<nixos-hardware/lenovo/thinkpad/x1-extreme/gen2>` |
| [Microsoft Surface Pro 3][] | `<nixos-hardware/microsoft/surface-pro/3>` |
| PC Engines APU | `<nixos-hardware/pcengines/apu>` |
| [Raspberry Pi 2][] | `<nixos-hardware/raspberry-pi/2>` |
| [Samsung Series 9 NP900X3C][] | `<nixos-hardware/samsung/np900x3c>` |
| [Purism Librem 13v3][] | `<nixos-hardware/purism/librem/13v3>` |
| [Purism Librem 15v3][] | `<nixos-hardware/purism/librem/15v3>` |
2019-09-28 17:58:20 -04:00
| Supermicro A1SRi-2758F | `<nixos-hardware/supermicro/a1sri-2758f>` |
| Supermicro X10SLL-F | `<nixos-hardware/supermicro/x10sll-f>` |
| [Toshiba Chromebook 2 `swanky`][] | `<nixos-hardware/toshiba/swanky>` |
2020-05-05 18:20:10 -04:00
| [Tuxedo InfinityBook v4][] | `<nixos-hardware/tuxedo/infinitybook/v4>` |
[Acer Aspire 4810T]: acer/aspire/4810t
2020-05-20 10:35:48 -04:00
[Asus TUF FX504GD]: asus/fx504gd
[Apple MacBook Pro 10,1]: apple/macbook-pro/10-1
[Dell G3 3779]: dell/g3/3779
2019-10-16 10:05:55 -04:00
[Dell XPS E7240]: dell/e7240
2019-10-30 15:15:22 -04:00
[Dell XPS 13 7390]: dell/xps/13-7390
2020-01-08 23:49:26 -05:00
[Dell XPS 13 9343]: dell/xps/13-9343
[Dell XPS 13 9360]: dell/xps/13-9360
2018-10-19 09:45:05 -04:00
[Dell XPS 13 9370]: dell/xps/13-9370
[Dell XPS 13 9380]: dell/xps/13-9380
[Dell XPS 15 7590]: dell/xps/15-7590
[Dell XPS 15 9550]: dell/xps/15-9550
[Dell XPS 15 9560]: dell/xps/15-9560
[Dell XPS 15 9560, intel only]: dell/xps/15-9560/intel
[Dell XPS 15 9560, nvidia only]: dell/xps/15-9560/nvidia
2020-05-07 10:12:35 -04:00
[Google Pixelbook]: google/pixelbook
[Inverse Path USB armory]: inversepath/usbarmory
[Lenovo ThinkPad X1 (6th Gen)]: lenovo/thinkpad/x1/6th-gen
2020-05-16 16:12:10 -04:00
[Lenovo ThinkPad X1 (7th Gen)]: lenovo/thinkpad/x1/7th-gen
2021-02-06 12:03:00 -05:00
[Lenovo ThinkPad X13 Yoga]: lenovo/thinkpad/x13-yoga
2018-08-30 08:59:11 -04:00
[Lenovo ThinkPad X260]: lenovo/thinkpad/x260
[Microsoft Surface Pro 3]: microsoft/surface-pro/3
[Raspberry Pi 2]: raspberry-pi/2
[Samsung Series 9 NP900X3C]: samsung/np900x3c
[Purism Librem 13v3]: purism/librem/13v3
2020-06-21 09:32:53 -04:00
[Purism Librem 15v5]: purism/librem/15v5
[Toshiba Chromebook 2 `swanky`]: toshiba/swanky
2020-05-17 03:07:37 -04:00
[Tuxedo InfinityBook v4]: nixos-hardware/tuxedo/infinitybook/v4
## How to contribute a new device profile
1. Add your device profile expression in the appropriate directory
2. Link it in the table in README.md and in flake.nix
3. Run ./tests/run.py to test it. The test script script will parse all the profiles from the README.md