Skip to content

Create a better description of the repo#12

Open
matejak wants to merge 2 commits intoEnterpriseyIntranet:masterfrom
matejak:descriptions
Open

Create a better description of the repo#12
matejak wants to merge 2 commits intoEnterpriseyIntranet:masterfrom
matejak:descriptions

Conversation

@matejak
Copy link
Copy Markdown
Contributor

@matejak matejak commented Mar 28, 2026

Document what is this repo about, and how to check out that it all works.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment on lines 26 to 27
- `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.
Copy link
Copy Markdown
Contributor

@hancar hancar Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ChatGPT suggests (and I like it):

Suggested change
- `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).

Comment thread README.md Outdated
Comment thread README.md
### Rocketchat

Available as http://localhost:1182
Unlike other services, it doesn't recognize `admin` user, but uses the `$ROCKET_ADMIN_USERNAME`, typically `admin-rocket`.
Copy link
Copy Markdown
Contributor

@hancar hancar Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 :-)

Comment thread README.md
Comment on lines +53 to +56
### Keycloak

Available as http://localhost:1184
SSO server, connects to LDAP, and mainly uses SAML to provide SSO to the other various services.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread README.md
Comment on lines +63 to +64
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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to shorten the "you can use it ... using" formulation.
A suggestion by ChatGPT:

Suggested change
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.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: hancar <pavel.hancar@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants