1
0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Files
docs/source/reference/minio-mc-admin/mc-admin-config.rst
Daryl White eb94513104 Breaking up envvars and config settings into separate settings pages (#1028)
- Creates a slew of folders and pages nested under the mc-server page to store settings.
- Breaks up all of the environment variable options formerly in the mc-server page into these separate pages.
- Moves the config settings formerly in the mc admin config page to the appropriate new settings pages.
- Adds a MiniO Client settings page and document `mc-host-<alias>`

Closes #1017
2023-11-03 07:55:22 -04:00

82 lines
1.8 KiB
ReStructuredText

.. _minio-mc-admin-config:
===================
``mc admin config``
===================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc admin config
Description
-----------
.. start-mc-admin-config-desc
The :mc:`mc admin config` command manages configuration settings for the
:mc:`minio` server.
.. end-mc-admin-bucket-remote-desc
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
:class: note
.. include:: /includes/facts-mc-admin.rst
:start-after: start-minio-only
:end-before: end-minio-only
Examples
--------
Syntax
------
.. mc-cmd:: set
:fullpath:
Sets a :ref:`configuration key <minio-server-configuration-settings>` on the MinIO deployment.
Configurations defined by environment variables override configurations defined by this command.
.. mc-cmd:: get
:fullpath:
Gets a :ref:`configuration key <minio-server-configuration-settings>` on the MinIO deployment created using `mc admin config set`.
.. mc-cmd:: export
:fullpath:
Exports any configuration settings created using `mc admin config set`.
.. mc-cmd:: history
:fullpath:
Lists the history of changes made to configuration keys by `mc admin config`.
Configurations defined by environment variables do not show.
.. mc-cmd:: import
:fullpath:
Imports configuration settings exported using `mc admin config export`.
.. mc-cmd:: reset
:fullpath:
Resets config to defaults.
Configurations defined in environment variables are not affected.
.. mc-cmd:: restore
:fullpath:
Roll back changes to configuration keys to a previous point in history.
Does not affect configurations defined by environment variables.
Configuration Settings
----------------------
For a list of available configuration settings, see :ref:`minio-server-configuration-settings`.