diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..d3ffa40 --- /dev/null +++ b/Installation.md @@ -0,0 +1,34 @@ +# Installation +The installation process of Livebeat is kind of complicated currently but this will change as we move more towards release. + +## Dependencies +These programs are **required** in order to run Livebeat: + +| Program | Tested version | Install | Purpose | +|---------- |---------------- |-------------- |------------------------------------------------------------------------- | +| Node.js | v15.3.0 | instructions | Both backend & frontend require Node.js as runtime in order to run. | +| RabbitMQ | 3.8.9 | instructions | Is used for real-time and continuous communication between all parties. | +| MongoDB | MongoDB Atlas | instructions | Main database | + +## Getting started +Since we have everyting installed, we have to make our hands dirty before we can even touch Livebeat. + +### RabbitMQ +We need to change a few things for RabbitMQ. Since Livebeat handles all authentifications we have to tell RabbitMQ to use Livebeat as authentification backend. + +We need to enable the `rabbitmq_auth_backend_http` plugin: +```sh +rabbitmq-plugins enable rabbitmq_auth_backend_http +``` + +Now go into the `/etc/rabbitmq/rabbitmq.conf` config file and put this at the beginning of the file: +``` +auth_backends.1 = http +auth_http.http_method = get +auth_http.user_path = http://localhost:8040/user/rabbitlogin +auth_http.vhost_path = http://localhost:8040/user/vhost +auth_http.resource_path = http://localhost:8040/user/resource +auth_http.topic_path = http://localhost:8040/user/topic +``` +This will basicly tell RabbitMQ to use this plugin as authentification method and then which paths and method to use. +