https://github.com/obsidiansystems/gargoyle

A framework for managing daemons from Haskell and libraries for use with postgresql and nix
https://github.com/obsidiansystems/gargoyle

daemon haskell nix postgresql

Last synced: 3 days ago
JSON representation

A framework for managing daemons from Haskell and libraries for use with postgresql and nix

• Host: GitHub
• URL: https://github.com/obsidiansystems/gargoyle
• Owner: obsidiansystems
• License: bsd-3-clause
• Created: 2017-08-29T17:52:55.000Z (about 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-01-26T14:39:54.000Z (10 months ago)
• Last Synced: 2024-04-14T09:51:51.241Z (7 months ago)
• Topics: daemon, haskell, nix, postgresql
• Language: Haskell
• Homepage:
• Size: 128 KB
• Stars: 17
• Watchers: 26
• Forks: 7
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gargoyle

[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/gargoyle.svg)](https://hackage.haskell.org/package/gargoyle) [![Github CI](https://github.com/obsidiansystems/gargoyle/workflows/github-action/badge.svg)](https://github.com/obsidiansystems/gargoyle/actions) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/obsidiansystems/gargoyle/blob/master/LICENSE)

Gargoyle is a framework for managing daemons from Haskell. Currently, the only requirement is that the daemon be able to communicate over a Unix domain socket. See [gargoyle-postgresql](https://hackage.haskell.org/package/gargoyle-postgresql) for an example that uses gargoyle to manage postgresql.

To use Gargoyle the client must:

* Define a value of the 'Gargoyle' type which specifies how to administer the daemon.

* Create an executable whose `main` is `gargoyleMain`. The name of this executable should match the executable name specified in the `_gargoyle_exec` field of the `Gargoyle`.

* The client will run their code with `withGargoyle` to gain access to the daemon.

# Importing into Haskell package set

```nix

haskellPackages.override {

  overrides = self: super:

    let gargoylePkgs = import ./path/to/gargoyle-repo { haskellPackages = self; };

    in gargoylePkgs // {

      # .. your overrides

    };

}

```

By default `gargoyle-postgresql-nix` will use the `postgresql` of the `pkgs` used by your `haskellPackages`. To override this, pass `postgresql` by changing the above line to look more like

```nix

gargoylePkgs = import ./path/to/gargoyle-repo { haskellPackages = self; postgresql = myCustomVersion; }

```

# Hacking

Do something like this:

```shell

nix-shell -A gargoyle-postgresql.env --run 'cd gargoyle-postgresql && cabal new-repl'

```