diff --git a/README.md b/README.md index b1cc24d..0ae882e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # Munki-MunkiReport -Single Docker Container running Apache for a Munki Repository and a MunkiReport instance. Expects an external Certificate for SSL \ No newline at end of file +Single Docker Container running Apache for a Munki Repository and a MunkiReport instance. Expects an external Certificate for SSL + +## Installation: + +Copy `.env.example`to `.env`and edit it to your needs. +Supply an SSL Certificate as `ssl.crt` and `ssl.key` files inside the "certs" folder. + +Then run `docker-compose up -d`. +This will start the nginx Container and MunkiReport will be accessible at https://FQDN/ +Initialize a Munki Repository in "repo", which will be accessible at https://FQDN/repo/ + +Create a user for MunkiReport at https://FQDN/auth/generate/ +You will get a .yml File which needs to be put into "user", after that you can login with your credentials. Upgrade the MunkiReport Database via the WebInterface.