Redshift: Difference between revisions

Latest revision as of 20:18, 3 December 2025

Redshift is an open-source software application designed to adjust color temperature of screens based on the time of day.

It does this by gradually shifting the color temperature of the display to reduce the amount of blue light towards the night, and increasing the amount of blue light in the morning.

Users may choose to have screen temperature automatically match their lighting based on geographic location, or based on manually set time-frames. Users may also customize day and night color temperatures, adjust the speed of transitions, and more.

Redshift is best used on X11 systems as it is unmaintained and does not support Wayland.

For Wayland support you may consider Gammastep, a modern fork of Redshift. Alternatively there is also wlsunset, which is a lightweight modern alternative.

Installation

Using Global Configuration

❄︎ /etc/nixos/configuration.nix

environment.systemPackages = [
  pkgs.redshift
];

Using Home Configuration

❄︎ /etc/nixos/home.nix

home.packages = [ 
  pkgs.redshift 
];

Configuration

Global Configuration:

Options may be found under services.redshift. For more options for configuring Geoclue, check the Geoclue page.

❄︎ /etc/nixos/configuration.nix

services.redshift = {
  enable = true;
  temperature = {
    day = 5500;
    night = 3700;
  };
};

services.geoclue2.enable = true;
location.provider = "geoclue2";

Home Manager

Example Usage

You can find more options in Home Manager: services.redshift. This configuration defines the temperature the display will use at night and day, the schedule and length of the transition, brightness for the display to use, and whether it will use a tray icon. extraOptions defines additional command-line arguments to pass to redshift.

❄︎ /etc/nixos/home.nix

services.redshift = {
  enable = true;
  
  # Display temperature settings (in Kelvin)
  temperature = {
    day = 5500;
    night = 3500;
  };
  
  # Schedule settings
  dawnTime = "6:00-7:45";
  duskTime = "18:35-20:15";
  
  # Brightness
  brightness = {
    day = "1";
    night = "0.8";
  };
  
  extraOptions = [
    "-v"
    "-m randr"
  ];
  
  # Tray Icon
  tray = false;

};

Location Based Transitions

You can choose to use Redshift with location based screen temperature to match when the sun actually sets and rises in your area. Below are examples of those options using Geoclue and manually set coordinates.

Geoclue

Geoclue provides location using GPS, 3G modems, GeoIP, and WiFi Geolocation. Some integrations may require additional setup.

❄︎ /etc/nixos/home.nix

services.redshift = {
  enable = true;
  provider = "geoclue2";
};

You will also need to enable Geoclue in your global configuration (See options on the Geoclue page).

❄︎ /etc/nixos/configuration.nix

services.geoclue2.enable = true;
location.provider = "geoclue2";

Coordinates

❄︎ /etc/nixos/home.nix

services.redshift = {
  enable = true;

  # Coordinates based location
  provider = "manual";

  latitude = "27.9880614";
  longitude = "86.92521";

};

Instead of declaring your coordinates in Redshift, you can also declare them globally for your device in your global configuration:

❄︎ /etc/nixos/configuration.nix

location = {
  provider = "manual";
  latitude = "27.9880614";
  longitude = "86.92521";
};

Troubleshooting

Provider is unable to determine location

It may happen that Redshift gets stuck at "Waiting for initial location to become available..." when using the geoclue2 location provider. This may happen when Geoclue is unable to determine your location due to missing information. In that case, you may resort to setting the location manually or using an alternate location service such as beaconDB, which can take advantage of WiFi scanning.

An example of using beaconDB as an alternative:

❄︎ /etc/nixos/configuration.nix

location.provider = "geoclue2";
services.geoclue2 = {
    enable = true;
    geoProviderUrl = "https://api.beacondb.net/v1/geolocate";
  };

References

@@ Line 1: / Line 1: @@
-== Prerequisites ==
+[https://github.com/jonls/redshift Redshift] is an open-source software application designed to adjust color temperature of screens based on the time of day.
-You can either manually configure a location or specify a location provider such as geoclue2 with the following options:
+It does this by gradually shifting the color temperature of the display to reduce the amount of blue light towards the night, and increasing the amount of blue light in the morning.
-* [https://nixos.org/nixos/options.html#location.provider {{ic|location.provider}}]
+Users may choose to have screen temperature automatically match their lighting based on geographic location, or based on manually set time-frames. Users may also customize day and night color temperatures, adjust the speed of transitions, and more.
-* [https://nixos.org/nixos/options.html#location.latitude {{ic|location.latitude}}] (Used by the {{ic|manual}} provider.)
-* [https://nixos.org/nixos/options.html#location.longitude {{ic|location.longitude}}] (Used by the {{ic|manual}} provider.)
+Redshift is best used on X11 systems as it is unmaintained and does not support Wayland.
+For Wayland support you may consider [[Gammastep]], a modern fork of Redshift. Alternatively there is also [[wlsunset]], which is a lightweight modern alternative.
 == Installation ==
+==== Using Global Configuration ====
+{{File|3=environment.systemPackages = [
+  pkgs.redshift
+];|name=/etc/nixos/configuration.nix|lang=nix}}
+==== Using Home Configuration ====
+{{File|3=home.packages = [
+  pkgs.redshift
+];|name=/etc/nixos/home.nix|lang=nix}}
+== Configuration ==
+==== Global Configuration: ====
+Options may be found under [https://search.nixos.org/options?query=services.redshift services.redshift]. For more options for configuring Geoclue, check the [[Geoclue|Geoclue page]].{{File|3=services.redshift = {
+  enable = true;
+  temperature = {
+    day = 5500;
+    night = 3700;
+  };
+};
-Install it with the <syntaxhighlight lang="nix" inline>redshift</syntaxhighlight> package.
+services.geoclue2.enable = true;
-Example snippet of <code>configuration.nix</code>:
+location.provider = "geoclue2";|name=/etc/nixos/configuration.nix|lang=nix}}
-<syntaxHighlight lang=nix>
-{ config, pkgs, callPackage, ... }: {
+==== Home Manager ====
-   environment.systemPackages = with pkgs; [
-     ...
+===== Example Usage =====
-     redshift
+You can find more options in [https://nix-community.github.io/home-manager/options.xhtml#opt-services.redshift.enable Home Manager: services.redshift]. This configuration defines the temperature the display will use at night and day, the schedule and length of the transition, brightness for the display to use, and whether it will use a tray icon. <code>extraOptions</code> defines additional command-line arguments to pass to <code>redshift</code>.
+{{File|3=services.redshift = {
+  enable = true;
+  # Display temperature settings (in Kelvin)
+  temperature = {
+    day = 5500;
+    night = 3500;
+  };
+  # Schedule settings
+  dawnTime = "6:00-7:45";
+  duskTime = "18:35-20:15";
+  # Brightness
+  brightness = {
+    day = "1";
+    night = "0.8";
+  };
+   extraOptions = [
+     "-v"
+     "-m randr"
    ];
-   ...
-   # All values except 'enable' are optional.
+  # Tray Icon
-  services.redshift = {
+  tray = false;
+};|name=/etc/nixos/home.nix|lang=nix}}
+===== Location Based Transitions =====
+You can choose to use Redshift with location based screen temperature to match when the sun actually sets and rises in your area. Below are examples of those options using [https://gitlab.freedesktop.org/geoclue/geoclue/-/wikis/home Geoclue] and manually set coordinates.
+====== Geoclue ======
+Geoclue provides location using GPS, 3G modems, GeoIP, and WiFi Geolocation. Some integrations may require additional setup.{{File|3=services.redshift = {
+  enable = true;
+  provider = "geoclue2";
+};|name=/etc/nixos/home.nix|lang=nix}}You will also need to enable Geoclue in your global configuration [[Geoclue|(See options on the Geoclue page)]].
+{{File|3=services.geoclue2.enable = true;
+location.provider = "geoclue2";|name=/etc/nixos/configuration.nix|lang=nix}}
+====== Coordinates ======
+{{File|3=services.redshift = {
+  enable = true;
+   # Coordinates based location
+  provider = "manual";
+  latitude = "27.9880614";
+  longitude = "86.92521";
+};|name=/etc/nixos/home.nix|lang=nix}}
+Instead of declaring your coordinates in Redshift, you can also declare them globally for your device in your global configuration:
+{{File|3=location = {
+  provider = "manual";
+  latitude = "27.9880614";
+  longitude = "86.92521";
+};|name=/etc/nixos/configuration.nix|lang=nix}}
+== Troubleshooting ==
+==== Provider is unable to determine location ====
+It may happen that Redshift gets stuck at ''"Waiting for initial location to become available..."'' when using the {{Ic|geoclue2}} location provider. This may happen when Geoclue is unable to determine your location due to missing information. In that case, you may resort to setting the location manually or using an alternate location service such as [https://beacondb.net/ beaconDB], which can take advantage of WiFi scanning.
+An example of using beaconDB as an alternative:
+{{File|3=location.provider = "geoclue2";
+services.geoclue2 = {
      enable = true;
-     brightness = {
+     geoProviderUrl = "https://api.beacondb.net/v1/geolocate";
-      # Note the string values below.
+  };|name=/etc/nixos/configuration.nix|lang=nix}}
-      day = "1";
-      night = "1";
+== References ==
-    };
+* https://github.com/jonls/redshift
-    temperature = {
+* https://nix-community.github.io/home-manager/options.xhtml#opt-services.gammastep.enable
-      day = 5500;
+* https://search.nixos.org/options?query=redshift
-      night = 3700;
-    };
+[[Category:Applications]]
-  };
-};
-</syntaxHighlight>