Create a better description of the repo#12
Create a better description of the repo#12matejak wants to merge 2 commits intoEnterpriseyIntranet:masterfrom
Conversation
| - `build` folder: Contains data needed to build some of the container images. | ||
| - `data` folder: Contains persistent data used by the respective containers. The actual data is not part of the repository. |
There was a problem hiding this comment.
ChatGPT suggests (and I like it):
| - `build` folder: Contains data needed to build some of the container images. | |
| - `data` folder: Contains persistent data used by the respective containers. The actual data is not part of the repository. | |
| - `build` folder: Contains files used to build custom container images. | |
| - `data` folder: Contains persistent data for containers (not tracked in the repository). |
| ### Rocketchat | ||
|
|
||
| Available as http://localhost:1182 | ||
| Unlike other services, it doesn't recognize `admin` user, but uses the `$ROCKET_ADMIN_USERNAME`, typically `admin-rocket`. |
There was a problem hiding this comment.
Please explain why that is. I couldn't find any evidence that Rocket.Chat "doesn't recognize admin user". On the contrary, the Rocket.Chat documentation uses that value. So, is using a different admin username for Rocket.Chat just our preference? Why?
There was a problem hiding this comment.
It is about the acutal value of the username - at least at some point, admin was blacklisted. I am not able to find this documented anywhere. It is easy to verify though, so I will conveniently leave it as an exercise for the reviewer :-)
| ### Keycloak | ||
|
|
||
| Available as http://localhost:1184 | ||
| SSO server, connects to LDAP, and mainly uses SAML to provide SSO to the other various services. |
There was a problem hiding this comment.
I would suggest using a different style. Here, lines 55 and 56 are rendered by Markdown into a single line. Adding an empty line (making Available as http://localhost:1184 a separate paragraph) seems to take up too much vertical space in the source. Therefore, I suggest editing all sections this way:
-### Keycloak
+### Keycloak (http://localhost:1184)
-Available as http://localhost:1184
SSO server, connects to LDAP, and mainly uses SAML to provide SSO to the other various services.| You can use it to create a user (hopefully with admin privileges) using its CLI. | ||
| Then, you should be able to log in using SAML. |
There was a problem hiding this comment.
I suggest to shorten the "you can use it ... using" formulation.
A suggestion by ChatGPT:
| You can use it to create a user (hopefully with admin privileges) using its CLI. | |
| Then, you should be able to log in using SAML. | |
| You can use its CLI to create a user (ideally with admin privileges), then log in via SAML. |
Co-authored-by: hancar <pavel.hancar@gmail.com>
Document what is this repo about, and how to check out that it all works.