|
|
||
|---|---|---|
| app | ||
| config | ||
| deploy | ||
| Handler | ||
| messages | ||
| Settings | ||
| static | ||
| templates | ||
| tests | ||
| .gitignore | ||
| Application.hs | ||
| devel.hs | ||
| eidolon.cabal | ||
| Foundation.hs | ||
| Helper.hs | ||
| Import.hs | ||
| LICENSE.md | ||
| Model.hs | ||
| README.md | ||
| Settings.hs | ||
#eidolon
##Introduction
A image gallery service written in Haskell as a yesod webapp.
Visit the test instance at eidolon.nek0.eu
##Installation
###Dependencies
A working Haskell capable environment. For that you will need ghc and cabal-install.
update your package list with cabal update and upgrade cabal-install, if necessary.
Additionally to Haskell and its dependencies you will need the following software and libraries:
- alex
- happy
- libmagick++-dev
###Building
get the source with
git clone https://github.com/nek0/eidolon.git
It's generally a good idea to create a sandbox for compiling. To do so cd into the project directory and invoke
cabal sandbox init
Then install all dependencies with the following command. This may lead you into dependency hell, as I am working with very new libraries.
cabal install --only-dependencies
After installing all dependencies you can configure and build the software with
cabal configure
cabal build
##Deploying
After compiling you will find an executable called eidolon in dist/build/eidolon/. Copy or link it anywhere you want. The executable needs to be accompanied by the folders config and static and their contents. It's best to copy them to your desired destination.
Also check config/settings.yml and set the values there accrding to your configuration.
It may also be necessery to create a reverse proxy to your gallery. I would recommend using nginx.
##Customizing
Unfortunately the gallery is not highly customizable, but you can change most of its appearance by changing the files static/css/static-*.css. Especially the default background image can be changed by replacing static/css/img/bg.jpg.
##Starting
You can start the gallery now by running the executable. You need to provide a settings file, normally found in config/settings.yml
Since eidolon will block your console, I recommend wrapping a init-script around it. how you can do that is written in my blog.
##Acknowledgements:
-
This software uses the web Framework "Yesod" by Michael Snoyman. See more at: http://www.yesodweb.com/
-
This software uses parts of the template "Parallelism" by n33co. see more at: http://html5up.net/