1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Files
docs/source/reference/minio-mc/mc-license-update.rst
Daryl White 6482571bf2 Update mc reference docs for improved nav structure (#717)
- Adds landing pages for all two-word `mc` commands
- Nests three+ word commands under appropriate two-word commands
- Updates MinIO Client doc
- Uses description from each command to populate list of subcommand
descriptions
- Modifies toctree for MinIO Client doc and each command/subcommand to
improve left nav experienc

Closes #710
2023-02-02 16:52:36 -06:00

79 lines
2.0 KiB
ReStructuredText

=====================
``mc license update``
=====================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 1
.. mc:: mc license update
Description
-----------
.. start-mc-license-update-desc
Use the :mc-cmd:`mc license update` command to replace a license key for a deployment.
.. end-mc-license-update-desc
.. versionchanged:: RELEASE.2023-01-18T04-36-38Z
For deployments registered for |SUBNET|, MinIO automatically checks for and updates the license every month.
If not passed with the command, MinIO checks the license file on SUBNET and automatically updates it.
Examples
--------
Update the License Key for a Deployment with Alias ``minio1``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell
:class: copyable
mc license update minio1 license.key
Syntax
------
The command has the following syntax:
.. code-block:: shell
mc [GLOBALFLAGS] license update \
ALIAS \
[LICENSE-FILE-WITH-PATH] \
[--airgap]
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` of the MinIO deployment.
.. mc-cmd:: LICENSE-FILE-WITH-PATH
:optional:
The path (relative to the current working directory) and file name of the key to use to update the deployment's license.
See the :ref:`troubleshooting page <minio-subnet-license-file-download>` for instructions on downloading the license file.
.. mc-cmd:: --airgap
:optional:
Use in environments without network access to SUBNET (for example, airgapped, firewalled, or similar configuration).
If the deployment is airgapped, but the local device where you are using the :ref:`minio client <minio-client>` has network access, you do not need to use the ``--airgap`` flag.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals