diff --git a/README.md b/README.md index e6b42fe4f..afa47f082 100644 --- a/README.md +++ b/README.md @@ -6,68 +6,75 @@ The following Description applies to Ubuntu or similar. Clone this repository `git clone https://gitlab.cip.ifi.lmu.de/jost/UniWorX.git` and navigate into the new directory `cd UniWorX`. ## LDAP - install: + install: `sudo apt-get install slapd ldap-utils` ## PostgreSQL - install: + install: `sudo apt-get install postgresql` - switch to user *postgres* (got created during installation): + switch to user *postgres* (got created during installation): `sudo -i -u postgres` - add db user *uniworx*: + add db user *uniworx*: `createuser --interactive` you'll get a prompt: ``` - Enter name of role to add:` - [enter 'uniworx'] + Enter name of role to add:` - uniworx Shall the new role be a superuser? (y/n)` - [not exactly sure. Guess not?] + Password: uniworx + ... ``` - create database *uniworx*: + create database *uniworx*: `createdb uniworx` + after you added the database switch back to your own user with `Ctrl + D`. - to access the database as user *uniworx* you now need to add a new linux-user called *uniworx*: + to access the database as user *uniworx* you now need to add a new linux-user called *uniworx*. when you get asked for a password enter *uniworx*. `sudo adduser uniworx` - log-in as new user *uniworx*: + log-in as new user *uniworx*: `sudo -i -u uniworx` you can now use `psql uniworx` to execute SQL-commands and such. ## stack - Install with: + Install with: `curl -sSL https://get.haskellstack.org/ | sh` - setup stack and install dependencies: + setup stack and install dependencies: `stack setup` - During this step or the next you might get an error that says something about missing C libraries for `ldap` and `lber`. You can install these using + During this step or the next you might get an error that says something about missing C libraries for `ldap` and `lber`. You can install these using `sudo apt-get install libsasl2-dev libldap2-dev` - If you get an error that says *You need to install postgresql-server-dev-X.Y for building a server-side extension or libpq-dev for building a client-side application.* - Go ahead an install `libpq-dev` with + If you get an error that says *You need to install postgresql-server-dev-X.Y for building a server-side extension or libpq-dev for building a client-side application.* + Go ahead an install `libpq-dev` with `sudo apt-get install libpq-dev` - Build the app: + Other packages you might need to install during this process: + `sudo apt-get install pkg-config` + `sudo apt-get install libsodium-dev` + + Build the app: `stack build` This might take a few minutes if not hours... be prepared. - install yesod: + install yesod: `stack install yesod-bin --install-ghc` ## Add Dumy-Data and run the app After building the app you can prepare the database and add some dummy data: - `./fill-db.hs` + `./db.sh -f` - Run the app: + Run the app: `./start.sh` - `Devel application launched: http://localhost:3000` + `Devel application launched: http://localhost:3000` means you are good to go. If you followed the steps above you should now be able to login as user Gregor Kleen using `LDAP:g.kleen@ifi.lmu.de` as dummy login. @@ -75,7 +82,7 @@ The following Description applies to Ubuntu or similar. *** # Sources and more infos - PostgreSQl: + PostgreSQl: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-16-04 stack: https://docs.haskellstack.org/en/stable/README/#how-to-install