nek0/eidolon
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Readme update

Browse source
This commit is contained in:
nek0 2016-09-06 16:47:43 +02:00
parent 1e5794418e
commit d25152b8ab
1 changed files with 29 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -12,25 +12,22 @@ Visit the test instance at [eidolon.nek0.eu][eidolon]
####Build dependencies ####Build dependencies
A working Haskell capable environment. For that you will need `haskell-stack` A working Haskell capable environment. For that you will need `cabal-install`,
and `cabal-install`, which you can install with: which you can install with:
```bash ```bash
sudo apt-get install haskell-stack sudo apt-get install cabal-install
``` ```
Shouldn't stack be available through your package repositories you can get it Now you can set up your cabal with `cabal update` and follow its instructions.
[here][stack]. with this you will have also installed the latest GHC Haskell compiler on your
system.
Now you can set up your stack with `stack setup` and follow its instructions.
This will install the latest GHC Haskell compiler on your system.
Additionally to Haskell and its dependencies you will need the following Additionally to Haskell and its dependencies you will need the following
software and libraries: software and libraries:
* alex * alex
* happy * happy
* libmagick++-dev
* libpq-dev * libpq-dev
* postgresql * postgresql
* libfftw3-dev * libfftw3-dev
@ -43,6 +40,8 @@ sudo apt-get install alex happy libmagick++-dev libpq-dev postgresql libmagickwa
####Elasticsearch dependencies ####Elasticsearch dependencies
**WARNING: THIS SECTION IS ONLY VALID FOR VERSIONS >= 0.0.5 and < 0.1.0.0**
Since version 0.0.5 there is an Elasticsearch integration for Eidolon. To Be Since version 0.0.5 there is an Elasticsearch integration for Eidolon. To Be
able to run eidolon , you need to install `elasticsearch` additionally with: able to run eidolon , you need to install `elasticsearch` additionally with:
@ -60,10 +59,16 @@ get the source with
git clone https://github.com/nek0/eidolon.git git clone https://github.com/nek0/eidolon.git
``` ```
build your sandbox with
```bash
cabal sandbox init
```
build the source with build the source with
```bash ```bash
stack build cabal install
``` ```
Everything should work automagically from there. Everything should work automagically from there.
@ -71,11 +76,9 @@ Everything should work automagically from there.
##Deploying ##Deploying
After compiling you will find an executable called `eidolon` in After compiling you will find an executable called `eidolon` in
`.stack-work/dist/<arch>/Cabal-<version>/build/eidolon/`, where `<arch>` is `dist/dist-sandbox-XXXXXXXX/build/eidolon/eidolon`. Copy or link it anywhere you
your system architecture and `<version>` your current cabal version. Copy or want. The executable needs to be accompanied by the folders `config` and
link it anywhere you want. The executable needs to be accompanied by the `static` and their contents. It's best to copy them to your desired destination.
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 Also check `config/settings.yml` and set the values there accrding to your
configuration. Especially the settings for elasticsearch are vital. configuration. Especially the settings for elasticsearch are vital.
@ -86,7 +89,7 @@ recommend using [nginx](http://nginx.org/).
##Customizing ##Customizing
Unfortunately the gallery is not highly customizable, but you can change most of Unfortunately the gallery is not highly customizable, but you can change most of
its appearance by changing the files `static/css/style-*.css`. Especially the its appearance by changing the files `static/css/main.css`. Especially the
default background image can be changed by replacing `static/css/img/bg.jpg`. default background image can be changed by replacing `static/css/img/bg.jpg`.
##Starting ##Starting
@ -123,6 +126,16 @@ all the images is located)
* without sandbox: `runghc /path/to/eidolon/Migrations/0.0.4-0.0.5/Migration.hs` * without sandbox: `runghc /path/to/eidolon/Migrations/0.0.4-0.0.5/Migration.hs`
* start or restart your eidolon service * start or restart your eidolon service
###0.0.7-0.1.0.0
You have two options to accomplish the migration:
1. Build the migration binary with `cabal exec -- ghc --make
Migrations/0.0.7-0.1.0.0/Migration.hs` and run the executable in your run
location.
2. Link the `static/data/` folder from your link location in the same location
in the project directory and run `cabal exec -- runghc
Migrations/0.0.7-0.1.0.0/Migration.hs`
##Acknowledgements: ##Acknowledgements:
* This software uses the web Framework "Yesod" by Michael Snoyman. See more at: * This software uses the web Framework "Yesod" by Michael Snoyman. See more at: