astelm/minio
1
0
Fork 0
mirror of https://github.com/pgsty/minio.git synced 2026-08-09 15:53:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: rebrand the repository documentation, templates and dashboards

Browse Source 
README, README_ZH, SECURITY, COMPLIANCE, CONTRIBUTING, NOTICE,
code_of_conduct, the vulnerability and PR-etiquette documents, the GitHub issue
and pull request templates, and the docs/ tree all present Silo as the product.
The Grafana dashboards under docs/metrics/prometheus/grafana/ have their panel
titles and descriptions rebranded while every minio_* query, label and
expression is left alone, so existing alerts and recording rules keep matching.

The distinction the review demanded is applied per hit rather than by
search-and-replace:

- Product and command text becomes Silo and silo: install and run instructions,
  systemd examples, compose services, download links, badges.
- Protocol and interface text keeps MinIO: MINIO_* variables, minio_* metrics,
  x-minio-* headers, /minio/* routes, .minio.sys, arn:minio, and API field and
  error names.
- Attribution keeps MinIO and gains the fork's own: the AGPL obligations,
  original copyright, CREDITS and NOTICE stay, with the modification notice
  added alongside rather than replacing them.
- Historical and third-party references are left as facts, not rewritten for
  brand tidiness.

README and README_ZH each carry an explicit non-affiliation notice, document
the side-by-side package migration including the
/etc/systemd/system/silo.service.d/10-legacy-user.conf drop-in for keeping a
legacy UID/GID, and state that recursive chown is never performed. The trademark
attribution uses the policy's approved "based on MinIO technology" wording, not
the shortened form the policy rejects.

github.com/pgsty/minio links are left in place and labelled transitional. The
repository has not been renamed, and rewriting them now would produce documented
URLs that 404 until the cutover; they change in the cutover commit together with
the goreleaser release target, the OCI source label and the raw-content branch.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Feng Ruohang
2026-08-06 08:49:30 +08:00
parent 6613c2a3cb
commit fd2ca1c6d2
94 changed files with 1613 additions and 1347 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sts/keycloak.md
+19 -19
View File
@@ -1,6 +1,6 @@
# Keycloak Quickstart Guide [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)
# Keycloak Quickstart Guide
Keycloak is an open source Identity and Access Management solution aimed at modern applications and services, this document covers configuring Keycloak identity provider support with MinIO.
Keycloak is an open source Identity and Access Management solution aimed at modern applications and services, this document covers configuring Keycloak identity provider support with Silo.
## Prerequisites
@@ -16,11 +16,11 @@ For a quick installation, docker-compose reference configs are also available on
- Save
- Click on credentials tab
- Copy the `Secret` to clipboard.
- This value is needed for `MINIO_IDENTITY_OPENID_CLIENT_SECRET` for MinIO.
- This value is needed for `MINIO_IDENTITY_OPENID_CLIENT_SECRET` for Silo.
- Go to Users
- Click on the user
- Attribute, add a new attribute `Key` is `policy`, `Value` is name of the `policy` on MinIO (ex: `readwrite`)
- Attribute, add a new attribute `Key` is `policy`, `Value` is name of the `policy` on Silo (ex: `readwrite`)
- Add and Save
- Go to Clients
@@ -78,18 +78,18 @@ curl \
"http://localhost:8080/auth/admin/realms/{realm}/users/{userid}"
```
### Configure MinIO
### Configure Silo
```
export MINIO_ROOT_USER=minio
export MINIO_ROOT_PASSWORD=minio123
minio server /mnt/export
export MINIO_ROOT_PASSWORD=silo123
silo server /mnt/export
```
Here are all the available options to configure OpenID connect
```
mc admin config set myminio/ identity_openid
mc admin config set mysilo/ identity_openid
KEY:
identity_openid enable OpenID SSO support
@@ -106,7 +106,7 @@ comment (sentence) optionally add a comment to this setting
and ENV based options
```
mc admin config set myminio/ identity_openid --env
mc admin config set mysilo/ identity_openid --env
KEY:
identity_openid enable OpenID SSO support
@@ -120,18 +120,18 @@ MINIO_IDENTITY_OPENID_SCOPES (csv) Comma separated list of OpenID s
MINIO_IDENTITY_OPENID_COMMENT (sentence) optionally add a comment to this setting
```
Set `identity_openid` config with `config_url`, `client_id` and restart MinIO
Set `identity_openid` config with `config_url`, `client_id` and restart Silo
```
~ mc admin config set myminio identity_openid config_url="http://localhost:8080/auth/realms/{your-realm-name}/.well-known/openid-configuration" client_id="account"
~ mc admin config set mysilo identity_openid config_url="http://localhost:8080/auth/realms/{your-realm-name}/.well-known/openid-configuration" client_id="account"
```
> NOTE: You can configure the `scopes` parameter to restrict the OpenID scopes requested by minio to the IdP, for example, `"openid,policy_role_attribute"`, being `policy_role_attribute` a client_scope / client_mapper that maps a role attribute called policy to a `policy` claim returned by Keycloak
Once successfully set restart the MinIO instance.
Once successfully set restart the Silo instance.
```
mc admin service restart myminio
mc admin service restart mysilo
```
### Using WebIdentiy API
@@ -161,16 +161,16 @@ This will open the login page of keycloak, upon successful login, STS credential
> NOTE: You can use the `-cscopes` parameter to restrict the requested scopes, for example to `"openid,policy_role_attribute"`, being `policy_role_attribute` a client_scope / client_mapper that maps a role attribute called policy to a `policy` claim returned by Keycloak.
These credentials can now be used to perform MinIO API operations.
These credentials can now be used to perform Silo API operations.
### Using MinIO Console
### Using Silo Console
- Open MinIO URL on the browser, lets say <http://localhost:9000/>
- Open Silo URL on the browser, lets say <http://localhost:9000/>
- Click on `Login with SSO`
- User will be redirected to the Keycloak user login page, upon successful login the user will be redirected to MinIO page and logged in automatically,
- User will be redirected to the Keycloak user login page, upon successful login the user will be redirected to Silo page and logged in automatically,
the user should see now the buckets and objects they have access to.
## Explore Further
- [MinIO STS Quickstart Guide](https://silo.pgsty.com/developers/security-token-service/)
- [The MinIO documentation website](https://silo.pgsty.com/docs/)
- [Silo STS Quickstart Guide](https://silo.pgsty.com/developers/security-token-service/)
- [The Silo documentation website](https://silo.pgsty.com/docs/)