QUICKSTART.md

+# FaaS Registry deployment
+
+## Build the Faas-DB docker image 
+
+Clone the FaaS-DB Dockerfile
+
+```
+git clone https://gitlab.geant.org/edugain/faas-db
+```
+
+Build the docker image
+
+```
+cd faas-db/
+
+make build-nc
+
+cd ..
+```
+
+## Build the Faas-SMTP docker image
+
+Clone the FaaS-SMPT Dockerfile
+
+```
+git clone https://gitlab.geant.org/edugain/faas-smtp
+```
+
+Build the docker image
+
+```
+cd faas-smtp/
+
+make build-nc
+
+cd ..
+```
+
+## Build the Faas-Shib docker image
+
+Clone the FaaS-Shib Dockerfile
+
+```
+git clone https://gitlab.geant.org/edugain/faas-shib
+```
+
+Build the docker image
+
+```
+cd faas-shib/
+
+make build-nc
+
+cd ..
+```
+
+## Build the Faas-Registry docker image
+
+Clone the FaaS-Registry Dockerfile
+
+```
+git clone https://gitlab.geant.org/edugain/faas-registry
+```
+
+Build the docker image
+
+```
+cd faas-registry/
+
+make build-nc
+
+```
+
+## Configuring the FaaS Registry
+
+All the variables to configure the FaaS Registry and the related docker instances can be found in the `conf` directory:
+
+- `faas-db.cnf` 
+- `faas-smtp.cnf`
+- `faas-registry.cnf`
+- `credentials/faas-registry-default.yml`
+
+The `docker-compose.yml` file is referencing the variables defined in the `*.cnf` files, which will be exported to the environment. All the variables are already set up with default values that are good enough for a testing environment. 
+
+Please note that the default set up is based on localhost. If you want to run the FaaS Registry on a remote host or make it accessible from the outside, you need to configure the `FAAS_REGISTRY_BASE_URL` and `FAAS_REGISTRY_HOSTNAME` and obviously open the 9080 TCP port.
+
+## Run the FaaS Registry
+
+Move to the `faas-registry` directory if you are not already there and run docker-compose with the following make command:
+
+```
+make compose-up
+```
+
+This will export all the variables in the `*.cnf` files to the environament and run the `docker-compose up command`.
+
+To test the Faas Registry instance open a browser window on `http://localhost:9080` and login as `admin` with the default password `changeme` (if you didn't change it of course).
+
+Ignore the `..system update needed..` warning, just refresh the page.