1
0
mirror of https://github.com/minio/docs.git synced 2025-04-29 09:36:51 +03:00
docs/source/reference/minio-mc/mc-anonymous-links.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

111 lines
2.5 KiB
ReStructuredText

.. _minio-mc-policy-links:
======================
``mc anonymous links``
======================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc anonymous links
Syntax
------
.. start-mc-anonymous-links-desc
The :mc:`mc anonymous links` retrieves the HTTP URL for anonymous (i.e.
unauthenticated or public) access to a bucket.
.. end-mc-anonymous-links-desc
Buckets with anonymous policies allow clients to access the bucket contents
and perform actions consistent with the specified policy without
:ref:`authentication <minio-authentication-and-identity-management>`.
.. tab-set::
.. tab-item:: EXAMPLE
The following command retrieves HTTP URLs for the ``mydata`` bucket
on the ``myminio`` MinIO deployment:
.. code-block:: shell
:class: copyable
mc anonymous links --recursive myminio/mydata
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] policy links \
[--recursive] \
ALIAS
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
*Required* The full path to the bucket or bucket prefix for which the
command retrieves the anonymous bucket policies.
Specify the :ref:`alias <alias>` of the MinIO or other
S3-compatible service *and* the full path to the bucket or bucket
prefix. For example:
.. code-block:: shell
mc links public [FLAGS] play/mybucket
.. mc-cmd:: --recursive
*Optional* Retrieve the HTTP links recursively.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
List Anonymous Policies for Bucket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc anonymous links` to links the anonymous policies for a
bucket:
.. code-block:: shell
:class: copyable
mc anonymous links ALIAS/PATH
- Replace :mc-cmd:`ALIAS <mc anonymous get ALIAS>` with the
:mc-cmd:`alias <mc alias>` of a configured S3-compatible host.
- Replace :mc-cmd:`PATH <mc anonymous get ALIAS>` with the destination bucket.
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility