Update home authored by Michael Westergaard's avatar Michael Westergaard
...@@ -2,69 +2,3 @@ ...@@ -2,69 +2,3 @@
- [Planning](usage/planning) - [Planning](usage/planning)
- [Overall navigation](usage/overall-navigation) - [Overall navigation](usage/overall-navigation)
- [Installation](installation/index) - [Installation](installation/index)
## Installation ##
Installation is as simple as 1... 2... 3.
### Setting up application in Gitlab ###
Create an application in your Gitlab instance; you want it to have these settings:
![Screenshot_2021-01-13_at_21.05.14](uploads/d052befd2820269548aaf3faa1d56ee7/Screenshot_2021-01-13_at_21.05.14.png)
You can be as createive as your rcreativety allows for the application name, and you can switch off Trusted if you prefer (it will mean users have to approve the application gains access to their Gitlab resources).
Make sure to use the proper base URL instead of `http://localhost:8080/` for all the URLs; you need to whitelist all the URLs (though only the first two are in use right now). Here the URLs are in a copy-paste friendly format:
```
http://localhost:8080/
http://localhost:8080/planning/global
http://localhost:8080/planning/project
http://localhost:8080/doing/todo
http://localhost:8080/doing/random
http://localhost:8080/evaluating/milestones
http://localhost:8080/reporting/burndown
http://localhost:8080/reporting/time-report
http://localhost:8080/reporting/time-sheet
```
### Run in Docker ###
#### Prerequisites ####
- [Install Docker](https://docs.docker.com/get-docker/)
#### Start application ####
Execute the below command in a terminal. If you don't have a terminal or don't know how to use a terminal, you'll probably wait until a later version of the application that does not require a terminal.
```
docker run -itp 8080:8080 \
-e eu_brinformatics_servicedesk_auth_endpoint=ENDPOINT \
-e eu_brinformatics_servicedesk_auth_clientid=SECRET \
registry.westergaard.eu/brinformatics/service-desk/servicedesk:VERSION
```
`ENDPOINT` is the location of your Gitlab installation. You'll probably not fare well with the cl;oud version right now. The Gitlab where this is hosted is `https://gitlab.westergaard.eu`
`SECRET` is the application id you get when setting up the application in Gitlab. It's not super secret but you should probably also not just hand it out everywhere. The one from the screenshot above is `5fbd9da7b7c6d4b2fe3f89f2e253eb71dfba07ee1de342d5531cdb4a486cd8b4` (though in keeping with the last part that's no longer the case).
`VERSION` is the version of the application to run. See [here](https://gitlab.westergaard.eu/brinformatics/service-desk/container_registry/2) for a list of available versions.
#### Access application ####
- In a browser, navigate to [localhost:8080](http://localhost:8080/) (or click the link)
#### Server installation ####
You can also run the application in a central installation allowing access for multiple people. For that, you'll realistically want to put it behind an encrypting HTTPS proxy. The application may get repackaged to handle that automatically, but for now you're on your own or suggested to use the Kubernetes installation with an ingress below.
### Run on Kubernetes ###
## Version history ##
See [Releases](https://gitlab.westergaard.eu/brinformatics/service-desk/-/releases) for previous releases.
See [Milestones](https://gitlab.westergaard.eu/brinformatics/service-desk/-/milestones) for upcoming releases.
You can also view the planning on this demo instance. TODO
\ No newline at end of file