├── AUTHORS.md ├── LICENSE ├── README.md └── cookbook ├── 01-introduction └── README.md └── 02-environments ├── README.md └── haskell-aaronmblevin ├── README.md ├── project-name.cabal ├── project-name.nix ├── run.nix └── shell.nix /AUTHORS.md: -------------------------------------------------------------------------------- 1 | Authors 2 | ======= 3 | 4 | Aaron Levin | @aaronmblevin | vilevin Π gmail λ com 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | NixOS Cookbook 2 | ============== 3 | 4 | Cookbook for working with Nix 5 | 6 | This is work in progress. Please feel free to contribute! 7 | -------------------------------------------------------------------------------- /cookbook/01-introduction/README.md: -------------------------------------------------------------------------------- 1 | Introduction 2 | ============ 3 | 4 | Cookbooks for working with [Nix](https://nixos.org/nix/) and [NixOS](https://nixos.org/). 5 | 6 | ## Introduction to Nix 7 | 8 | Nix is the named used for 2 different things. The first one, is the daemon which is used to do the build on behalf of users and to manage the nix store. The second, is a programming language which is used to abstract over the recipes used by the build daemon. 9 | 10 | The Nix daemon is responsible for building recipes, independently of the language used to produce them. A recipe can be recorded by a tools, such as the Nix language interpreter, or [Guix](www.gnu.org/s/guix). The daemon is responsible of the consistency of the nix store, which implies that a package is not mutable once installed, and it cannot be removed if it is referenced. The consistency makes Nix reliable. 11 | 12 | The Nix language is a pure functional programming language. Its pure aspect is essential to ensure that one evaluation will produce the same recipes over time. This leads to the reproducible aspect of Nix. 13 | 14 | ## Introduction to NixOS 15 | 16 | NixOS is a Linux distribution written using the Nix language. The main idea is that all the configuration files are produced by a recipe. A configuration might refer to the installation path of a program. Such reference is converted into a dependency for the recipe used for building the configuration file. By design, NixOS inherits from all properties of Nix. 17 | 18 | In addition, NixOS benefits from a module system which fosters a declarative aspect of the configuration. Every hardware aspect, service, file system layout are managed in modules. With the properties inherited from Nix, NixOS can be claimed as a reliable and reproducible configuration management system. 19 | 20 | ## Helpful to Keep In Mind 21 | 22 | When working on a project, it's helpful to keep in mind there are several different types of dependencies: 23 | 24 | 1. Build dependencies 25 | 2. Development dependencies 26 | 3. Runtime dependencies 27 | 28 | *Build* dependencies refers to any packages and configuration required to build your project. For example, this may include `gcc`, your source code, and some libraries you need to link against. *Development dependencies* refers to the tools you need to develop your project and is quite often a superset of your build dependencies. *Development dependencies* may include things like static code analysis, editors, [MySQL Workbench](http://www.mysql.com/products/workbench/), etc. They are dependencies you need to get work done but not to actually build your project. Lastly, runtime dependencies are any dependencies you need at runtime. This may include libraries you dynamically link against or applications like [PostgreSQL](http://www.postgresql.org/) or [Redis](http://redis.io/). 29 | -------------------------------------------------------------------------------- /cookbook/02-environments/README.md: -------------------------------------------------------------------------------- 1 | Environments 2 | ============ 3 | 4 | Example Nix expressions for creating environments. 5 | -------------------------------------------------------------------------------- /cookbook/02-environments/haskell-aaronmblevin/README.md: -------------------------------------------------------------------------------- 1 | Haskell - Aaron Levin 2 | ===================== 3 | 4 | This is how I work with Haskell projects using Nix. 5 | 6 | 1. `project-name.nix` contains the nix expression generated by `cabal2nix` 7 | 2. `shell.nix` contains dependencies I need to develop my project. 8 | 3. `run.nix` contains any run-time dependencies 9 | 10 | My typical workflow: 11 | 12 | 1. `nix-shell` to work on the project. 13 | 2. `nix-build run.nix` to build the project and yield an environment with external dependencies (e.g. `redis` in this example) 14 | 15 | ## Issues 16 | 17 | One issue with this workflow is that adding a dependency to `project-name.cabal` requires me to add that same dependency to `shell.nix`. 18 | -------------------------------------------------------------------------------- /cookbook/02-environments/haskell-aaronmblevin/project-name.cabal: -------------------------------------------------------------------------------- 1 | name: project-name 2 | version: 0.0.0.1 3 | synopsis: Some project 4 | homepage: https://github.com/aaronlevin/nixos-cookbook 5 | category: Web 6 | build-type: Simple 7 | cabal-version: >=1.10 8 | library 9 | exposed-modules: 10 | 11 | ghc-options: 12 | -threaded 13 | -Wall 14 | -fno-warn-name-shadowing 15 | -O2 16 | 17 | build-depends: base >=4.7 && <4.8 18 | , aeson 19 | , bytestring 20 | , base64-bytestring 21 | , containers 22 | , free 23 | , http-types 24 | , jwt 25 | , mtl 26 | , text 27 | , time 28 | , transformers 29 | , uuid 30 | 31 | default-language: Haskell2010 32 | 33 | hs-source-dirs: src 34 | -------------------------------------------------------------------------------- /cookbook/02-environments/haskell-aaronmblevin/project-name.nix: -------------------------------------------------------------------------------- 1 | # This file was auto-generated by cabal2nix. Please do NOT edit manually! 2 | 3 | { cabal, aeson, base64Bytestring, free, httpTypes, jwt, mtl, text 4 | , time, transformers, uuid 5 | }: 6 | 7 | cabal.mkDerivation (self: { 8 | pname = "project-name"; 9 | version = "0.0.0.1"; 10 | src = ./.; 11 | buildDepends = [ 12 | aeson base64Bytestring free httpTypes jwt mtl text time 13 | transformers uuid 14 | ]; 15 | meta = { 16 | homepage = "https://github.com/aaronlevin/nixos-cookbook"; 17 | description = "Some project"; 18 | license = self.stdenv.lib.licenses.unfree; 19 | platforms = self.ghc.meta.platforms; 20 | }; 21 | }) 22 | -------------------------------------------------------------------------------- /cookbook/02-environments/haskell-aaronmblevin/run.nix: -------------------------------------------------------------------------------- 1 | { nixpkgs ? (import {}) 2 | , haskell ? (import {}).haskellPackages }: 3 | let 4 | myEnvFun = nixpkgs.myEnvFun; 5 | projectName = haskell.callPackage (import ./project-name.nix) { }; 6 | redis = nixpkgs.redis; 7 | in rec { 8 | galeneCommonEnv = myEnvFun { 9 | name = "project-name-run-env"; 10 | 11 | buildInputs = [ 12 | redis 13 | projectName 14 | ]; 15 | }; 16 | } 17 | 18 | -------------------------------------------------------------------------------- /cookbook/02-environments/haskell-aaronmblevin/shell.nix: -------------------------------------------------------------------------------- 1 | { nixpkgs ? (import {}) 2 | , haskell ? (import {}).haskellPackages }: 3 | let 4 | myEnvFun = nixpkgs.myEnvFun; 5 | ghcmod = haskell.ghcMod; 6 | ghc = haskell.ghc; 7 | cabalInstall = haskell.cabalInstall; 8 | aeson = haskell.aeson; 9 | base64Bytestring = haskell.base64Bytestring; 10 | free = haskell.free; 11 | httpTypes = haskell.httpTypes; 12 | jwt = haskell.jwt; 13 | mtl = haskell.mtl; 14 | text = haskell.text; 15 | time = haskell.time; 16 | transformers = haskell.transformers; 17 | uuid = haskell.uuid; 18 | in rec { 19 | projectNameDevEnv = myEnvFun { 20 | name = "project-name-dev"; 21 | 22 | buildInputs = [ 23 | # dev needs 24 | ghcmod 25 | ghc 26 | cabalInstall 27 | 28 | # libs 29 | aeson 30 | base64Bytestring 31 | free 32 | httpTypes 33 | jwt 34 | mtl 35 | text 36 | time 37 | transformers 38 | uuid 39 | ]; 40 | }; 41 | } 42 | --------------------------------------------------------------------------------