{"id":13912505,"url":"https://github.com/rzrbld/adminio-api","last_synced_at":"2025-07-18T12:30:56.747Z","repository":{"id":40990803,"uuid":"215136515","full_name":"rzrbld/adminio-api","owner":"rzrbld","description":"simple admin API for min.io (minio) s3 server","archived":false,"fork":false,"pushed_at":"2023-02-17T22:45:55.000Z","size":35980,"stargazers_count":23,"open_issues_count":7,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-08T01:56:06.372Z","etag":null,"topics":["adminio-api","minio","minio-api","minio-rest","minio-server","minio-ui","openapi","prometheus","web-ui"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rzrbld.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-14T20:13:23.000Z","updated_at":"2024-01-15T08:04:29.000Z","dependencies_parsed_at":"2024-01-14T08:17:44.684Z","dependency_job_id":"fe97a8a6-4ed9-455a-999d-bb5a2f29f6e1","html_url":"https://github.com/rzrbld/adminio-api","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzrbld%2Fadminio-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzrbld%2Fadminio-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzrbld%2Fadminio-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzrbld%2Fadminio-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rzrbld","download_url":"https://codeload.github.com/rzrbld/adminio-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226403804,"owners_count":17619726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adminio-api","minio","minio-api","minio-rest","minio-server","minio-ui","openapi","prometheus","web-ui"],"created_at":"2024-08-07T01:01:30.475Z","updated_at":"2024-11-25T21:31:16.048Z","avatar_url":"https://github.com/rzrbld.png","language":"Go","funding_links":[],"categories":["others","Go"],"sub_categories":[],"readme":"# Adminio-api\nThis is a simple admin \"REST\" API for [minio](https://min.io/) s3 server.\nHere is a Web UI for this API - [adminio-ui](https://github.com/rzrbld/adminio-ui)\n\n![Docker hub stats](https://img.shields.io/docker/pulls/rzrbld/adminio-api?style=flat-square) ![GitHub License](https://img.shields.io/github/license/rzrbld/adminio-api?style=flat-square)\n\n## OpenAPI v3\n\nsee OpenAPI v3 specs at `openAPI/openapi_v3.yaml` or [html version](https://rzrbld.github.io/openapi/)\n\n### Run full stack demo\nobtain [docker-compose.yml](https://raw.githubusercontent.com/rzrbld/adminio-ui/master/docker-compose.yml) from [adminio-ui](https://github.com/rzrbld/adminio-ui) repository. And run it:\n`docker-compose -f docker-compose.yml up`\n\nit will bring up:\n\n - minio server on 9000 port\n - adminio API on 8080 port\n - adminio UI on 80 port\n\nafter that you can go to `http://localhost` and try out\n\n### Run with docker\n```\ndocker run -d \\\n      -p 8080:8080 \\\n      -e ADMINIO_HOST_PORT=\":8080\" \\\n      -e MINIO_HOST_PORT=\"localhost:9000\" \\\n      -e MINIO_ACCESS=\"test\" \\\n      -e MINIO_SECRET=\"testtest123\" \\\n      rzrbld/adminio-api:latest\n\n```\n\n### Run with Kubernetes/OpenShift/OKD/OCP\ngo to [Helm charts](https://github.com/rzrbld/adminio-helm) repo\n\n### Run manually\n - [start](https://docs.min.io/) minio server\n - set env variables\n - go to `src` folder and compile with `go build main.go`, then run `./main` binary\n\n\n### Monitoring\nAdminio-API expose metrics for [Prometheus](https://prometheus.io/) at `/metrics` if `ADMINIO_METRICS_ENABLE` is set to `true`.\n\n### Config Env variables\n| Variable   |      Description      |  Default |\n|--------------|:-----------------------:|-----------:|\n| `ADMINIO_HOST_PORT` | which host and port API should listening. This is Iris based API, so you will need to provide 0.0.0.0:8080 for listening on all interfaces | localhost:8080 |\n| `MINIO_HOST_PORT` |  provide a minio server host and port  |  localhost:9000 |\n| `MINIO_SSL` | enable or disable ssl |  false |\n| `MINIO_SSL_INSECURE` | skip SSL verify| false |\n| `MINIO_SSL_CACERT` | path to CA certificate | \"\" |\n| `MINIO_REGION` | set minio region | us-east-1 |\n| `MINIO_ACCESS` | set minio Access Key | test |\n| `MINIO_SECRET` | set minio Secret Key | testtest123 |\n| `MINIO_DEFAULT_LOCK_OBLECT_ENABLE` | set minio default make bucket behaviour with locking object  | false |\n| `ADMINIO_CORS_DOMAIN` | set adminio-api CORS policy domain  | * |\n| `ADMINIO_OAUTH_ENABLE` | enable oauth over supported providers | false |\n| `ADMINIO_OAUTH_PROVIDER` | oauth provider, for more information see the full list of supported providers | github |\n| `ADMINIO_OAUTH_CLIENT_ID` | oauth app client id | my-github-oauth-app-client-id |\n| `ADMINIO_OAUTH_CLIENT_SECRET` | oauth app secret | my-github-oauth-app-secret |\n| `ADMINIO_OAUTH_CALLBACK` | oauth callback, default listener on /auth/callback | http://\"+ADMINIO_HOST_PORT+\"/auth/callback |\n| `ADMINIO_OAUTH_CUSTOM_DOMAIN` | oauth custom domain, for supported providers (auth0\\wso2) | - |\n| `ADMINIO_COOKIE_HASH_KEY` | hash key for session cookies. AES only supports key sizes of 16, 24 or 32 bytes | NRUeuq6AdskNPa7ewZuxG9TrDZC4xFat |\n| `ADMINIO_COOKIE_BLOCK_KEY` | block key for session cookies. AES only supports key sizes of 16, 24 or 32 bytes | bnfYuphzxPhJMR823YNezH83fuHuddFC |\n| `ADMINIO_COOKIE_NAME` | name for the session cookie | adminiosessionid |\n| `ADMINIO_AUDIT_LOG_ENABLE` | enable audit log, mae sense if oauth is enabled, othervise set to false | false |\n| `ADMINIO_METRICS_ENABLE` | enable default iris/golang metrics and bucket sizes metric on `/metrics/` uri path | false |\n| `ADMINIO_PROBES_ENABLE` | enable liveness and readiness probes for k8s at `/ready/` and `/live/` uri path installations | false |\n\n### List of supported oauth providers\n\n - amazon\n - auth0\n - bitbucket\n - box\n - digitalocean\n - dropbox\n - github\n - gitlab\n - heroku\n - onedrive\n - salesforce\n - slack\n - wso2\n\n\n ### Example config\n - prometheus config for adminio metrics: `examples/prometheus.yml`\n - bucket lifecycle: `examples/lifecycle.xml`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frzrbld%2Fadminio-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frzrbld%2Fadminio-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frzrbld%2Fadminio-api/lists"}