nixos/modules/services/networking/onedrive.xml

   1 <chapter xmlns="http://docbook.org/ns/docbook"
   2          xmlns:xlink="http://www.w3.org/1999/xlink"
   3          xmlns:xi="http://www.w3.org/2001/XInclude"
   4          version="5.0"
   5          xml:id="onedrive">
   6  <title>Microsoft OneDrive</title>
   7  <para>
   8   Microsoft Onedrive is a popular cloud file-hosting service, used by 85% of Fortune 500 companies. NixOS uses a popular OneDrive client for Linux maintained by github user abraunegg. The Linux client is excellent and allows customization of which files or paths to download, not much unlike the default Windows OneDrive client by Microsoft itself. The client allows syncing with multiple onedrive accounts at the same time, of any type- OneDrive personal, OneDrive business, Office365 and Sharepoint libraries, without any additional charge.
   9  </para>
  10  <para>
  11   For more information, guides and documentation, see <link xlink:href="https://abraunegg.github.io/"/>.
  12  </para>
  13  <para>
  14   To enable OneDrive support, add the following to your <filename>configuration.nix</filename>:
  15 <programlisting>
  16 <xref linkend="opt-services.onedrive.enable"/> = true;
  17 </programlisting>
  18   This installs the <literal>onedrive</literal> package and a service <literal>onedriveLauncher</literal> which will instantiate a <literal>onedrive</literal> service for all your OneDrive accounts. Follow the steps in documentation of the onedrive client to setup your accounts. To use the service with multiple accounts, create a file named <filename>onedrive-launcher</filename> in <filename>~/.config</filename> and add the filename of the config directory, relative to <filename>~/.config</filename>. For example, if you have two OneDrive accounts with configs in <filename>~/.config/onedrive_bob_work</filename> and <filename>~/.config/onedrive_bob_personal</filename>, add the following lines:
  19 <programlisting>
  20 onedrive_bob_work
  21 # Not in use:
  22 # onedrive_bob_office365
  23 onedrive_bob_personal
  24 </programlisting>
  25   No such file needs to be created if you are using only a single OneDrive account with config in the default location <filename>~/.config/onedrive</filename>, in the absence of <filename>~/.config/onedrive-launcher</filename>, only a single service is instantiated, with default config path.
  26 </para>
  27
  28   <para>
  29   If you wish to use a custom OneDrive package, say from another channel, add the following line:
  30 <programlisting>
  31 <xref linkend="opt-services.onedrive.package"/> = pkgs.unstable.onedrive;
  32 </programlisting>
  33  </para>
  34 </chapter>