document options for Nix package

urlordjames 2021-06-22 20:53:31 -04:00 committed by GitHub
parent 80baab782d
commit dceb7884f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions

@ -303,6 +303,25 @@ pkgs.mkShell {
Enter the shell by running `nix-shell`. This will install Drogon and enter you into an environment with all its dependancies. Enter the shell by running `nix-shell`. This will install Drogon and enter you into an environment with all its dependancies.
The Nix package has a few options which you can configure according to your needs:
| option | default value |
| --- | --- |
| sqliteSupport | true |
| postgresSupport | false |
| redisSupport | false |
| mysqlSupport | false |
Here is an example of how you can change their values:
```
buildInputs = with pkgs; [
(drogon.override {
sqliteSupport = false;
})
];
```
__if you haven't installed Nix:__ You can follow the instructions on the [NixOS website](https://nixos.org/download.html). __if you haven't installed Nix:__ You can follow the instructions on the [NixOS website](https://nixos.org/download.html).
# 03 [Quick Start](ENG-03-Quick-Start) # 03 [Quick Start](ENG-03-Quick-Start)