minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-05 03:41:24 +03:00
Code Activity

DOCS-448: Create new per-platform quickstart guides

Browse Source 
Co-authored by: Ravind Kumar <ravind@min.io>
Co-authored by: Daryl White <53910321+djwfyi@users.noreply.github.com>
This commit is contained in:
Ravind Kumar
2022-03-22 19:18:03 -04:00
committed by Daryl White
parent eb1e901858
commit a566631be2
18 changed files with 1206 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

373
source/quickstart/container.rst Normal file
View File

@@ -0,0 +1,373 @@
.. _quickstart-container:
=========================
Quickstart for Containers
=========================
.. default-domain:: minio
.. |OS| replace:: Docker or Podman
This procedure deploys a :ref:`Standalone <minio-installation-comparison>` MinIO server onto |OS| for early development and evaluation of MinIO Object Storage and it's S3-compatible API layer.
Standalone deployments (also called "filesystem mode") support a :ref:`subset of MinIO features <minio-installation-comparison>` where redundancy or availability are dependent entirely on the underlying drive or volume.
For instructions on deploying to production environments, see :ref:`deploy-minio-distributed`.
Prerequisites
-------------
- `Podman <https://podman.io/getting-started/installation.html>`_ or `Docker <https://docs.docker.com/get-docker/>`_ installed.
- Read, write, and delete access to the folder or drive used for the persistent volume.
Procedure
---------
#. Start the container
Select a container type to view instructions to create the container.
Instructions are available for either GNU/Linux and MacOS or for Windows.
.. dropdown:: Podman (Rootfull or Rootless)
:name: podman-root-rootless
These steps work for both rootfull and rootless containers.
.. tab-set::
.. tab-item:: GNU/Linux or MacOS
.. code-block:: shell
:class: copyable
podman run \
-p 9000:9000 \
-p 9090:9090 \
-v ~/minio/data:/data \
-e "MINIO_ROOT_USER=ROOTNAME`" \
-e "MINIO_ROOT_PASSWORD=CHANGEME123" \
quay.io/minio/minio server /data --console-address ":9090"
The example above works this way:
- ``podman run`` starts the container.
The process is attached to the terminal session and ends when exiting the terminal.
- ``-p`` binds a local port to a container port.
- ``-v`` sets a file path as a persistent volume location for the container to use.
When MinIO writes data to ``/data``, that data mirrors to the local path ``~/minio/data``, allowing it to persist between container restarts.
You can set any file path to which the user has read, write, and delete permissions to use.
- ``-e`` sets the environment variables :envvar:`MINIO_ROOT_USER` and :envvar:`MINIO_ROOT_PASSWORD`, respectively.
These set the :ref:`root user credentials <minio-users-root>`.
Change the example values to use for your container.
.. tab-item:: Windows
.. code-block:: shell
:class: copyable
podman run \
-p 9000:9000 \
-p 9090:9090 \
-v D:\data:/data \
-e "MINIO_ROOT_USER=ROOTNAME`" \
-e "MINIO_ROOT_PASSWORD=CHANGEME123" \
quay.io/minio/minio server /data --console-address ":9090"
The example above works this way:
- ``podman run`` starts the container.
- ``-p`` binds a local port to a container port.
- ``-v`` sets a file path as a persistent volume location for the container to use.
When MinIO writes data to ``/data``, that data mirrors to the local path ``D:\data``, allowing it to persist between container restarts.
You can set any file path to which the user has read, write, and delete permissions to use.
- ``-e`` sets the environment variables :envvar:`MINIO_ROOT_USER` and :envvar:`MINIO_ROOT_PASSWORD`, respectively.
These set the :ref:`root user credentials <minio-users-root>`.
Change the example values to use for your container.
.. dropdown:: Docker (Rootfull)
:name: docker-rootfull
.. tab-set::
.. tab-item:: GNU/Linux or MacOS
.. code-block:: shell
:class: copyable
mkdir -p ~/minio/data
docker run \
-p 9000:9000 \
-p 9090:9090 \
--name minio \
-v ~/minio/data:/data \
-e "MINIO_ROOT_USER=ROOTNAME`" \
-e "MINIO_ROOT_PASSWORD=CHANGEME123" \
quay.io/minio/minio server /data --console-address ":9090"
The example above works this way:
- ``mkdir`` creates a new local directory at ``~/minio/data`` in your home directory.
- ``docker run`` starts the MinIO container.
- ``-p`` binds a local port to a container port.
- ``-name`` creates a name for the container.
- ``-v`` sets a file path as a persistent volume location for the container to use.
When MinIO writes data to ``/data``, that data mirrors to the local path ``~/minio/data``, allowing it to persist between container restarts.
You can replace ``~/minio/data`` with another local file location to which the user has read, write, and delete access.
- ``-e`` sets the environment variables :envvar:`MINIO_ROOT_USER` and :envvar:`MINIO_ROOT_PASSWORD`, respectively.
These set the :ref:`root user credentials <minio-users-root>`.
Change the example values to use for your container.
.. tab-item:: Windows
.. code-block:: shell
:class: copyable
docker run \
-p 9000:9000 \
-p 9090:9090 \
--name minio1 \
-v D:\data:/data \
-e "MINIO_ROOT_USER=ROOTUSER" \
-e "MINIO_ROOT_PASSWORD=CHANGEME123" \
quay.io/minio/minio server /data --console-address ":9090"
The example above works this way:
- ``docker run`` starts the MinIO container.
- ``-p`` binds a local port to a container port.
- ``-v`` sets a file path as a persistent volume location for the container to use.
When MinIO writes data to ``/data``, that data mirrors to the local path ``D:\data``, allowing it to persist between container restarts.
You can replace ``D:\data`` with another local file location to which the user has read, write, and delete access.
- ``-e`` sets the environment variables :envvar:`MINIO_ROOT_USER` and :envvar:`MINIO_ROOT_PASSWORD`, respectively.
These set the :ref:`root user credentials <minio-users-root>`.
Change the example values to use for your container.
.. dropdown:: Docker (Rootless)
:name: docker-rootless
.. tab-set::
.. tab-item:: GNU/Linux or MacOS
.. code-block:: shell
:class: copyable
mkdir -p ${HOME}/data
docker run \
-p 9000:9000 \
-p 9090:9090 \
--user $(id -u):$(id -g) \
--name minio1 \
-e "MINIO_ROOT_USER=ROOTUSER" \
-e "MINIO_ROOT_PASSWORD=CHANGEME123" \
-v ${HOME}/minio/data:/data \
quay.io/minio/minio server /data --console-address ":9090"
The example above works this way:
- ``mkdir`` creates a new local directory at ``~/minio/data`` in your home directory.
- ``docker run`` starts the MinIO container.
- ``-p`` binds a local port to a container port.
- ``-user`` sets the username for the container to the policies for the current user and user group.
- ``-name`` creates a name for the container.
- ``-v`` sets a file path as a persistent volume location for the container to use.
When MinIO writes data to ``/data``, that data actually writes to the local path ``~/minio/data`` where it can persist between container restarts.
You can replace ``${HOME}/minio/data`` with another location in the user's home directory to which the user has read, write, and delete access.
- ``-e`` sets the environment variables :envvar:`MINIO_ROOT_USER` and :envvar:`MINIO_ROOT_PASSWORD`, respectively.
These set the :ref:`root user credentials <minio-users-root>`.
Change the example values to use for your container.
.. tab-item:: Windows
Prerequisite:
- Windows `Group Managed Service Account <https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/manage-serviceaccounts>`_ already defined.
.. code-block:: shell
:class: copyable
docker run \
-p 9000:9000 \
-p 9090:9090 \
--name minio1 \
--security-opt "credentialspec=file://path/to/file.json"
-e "MINIO_ROOT_USER=ROOTUSER" \
-e "MINIO_ROOT_PASSWORD=CHANGEME123" \
-v D:\data:/data \
quay.io/minio/minio server /data --console-address ":9090"
The example above works this way:
- ``docker run`` starts the MinIO container.
- ``-p`` binds a local port to a container port.
- ``-name`` creates a name for the container.
- ``--security-opt`` grants access to the container via a ``credentialspec`` file for a `Group Managed Service Account (gMSA) <https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/gmsa-run-container>`_
- ``-v`` sets a file path as a persistent volume location for the container to use.
When MinIO writes data to ``/data``, that data actually writes to the local path ``D:\data`` where it can persist between container restarts.
You can replace ``D:\data`` with another local file location to which the user has read, write, and delete access.
- ``-e`` sets the environment variables :envvar:`MINIO_ROOT_USER` and :envvar:`MINIO_ROOT_PASSWORD`, respectively.
These set the :ref:`root user credentials <minio-users-root>`.
Change the example values to use for your container.
#. Connect your Browser to the MinIO Server
Access the :ref:`minio-console` by going to a browser and going to ``http://127.0.0.1:9000`` or one of the Console addresses specified in the :mc:`minio server` command's output.
For example, :guilabel:`Console: http://192.0.2.10:9090 http://127.0.0.1:9090` in the example output indicates two possible addresses to use for connecting to the Console.
While port ``9000`` is used for connecting to the API, MinIO automatically redirects browser access to the MinIO Console.
Log in to the Console with the credentials you defined in the :envvar:`MINIO_ROOT_USER` and :envvar:`MINIO_ROOT_PASSWORD` environment variables.
.. image:: /images/minio-console-login.png
:width: 600px
:alt: MinIO Console displaying login screen
:align: center
You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration.
Each MinIO server includes its own embedded MinIO Console.
.. image:: /images/minio-console-buckets.png
:width: 600px
:alt: MinIO Console displaying bucket start screen
:align: center
For more information, see the :ref:`minio-console` documentation.
#. `(Optional)` Install the MinIO Client
The :ref:`MinIO Client <minio-client>` allows you to work with your MinIO volume from the commandline.
Select your operating system for instructions.
.. dropdown:: GNU/Linux
The :ref:`MinIO Client <minio-client>` allows you to work with your MinIO server from the commandline.
Download the :mc:`mc` client and install it to a location on your system ``PATH`` such as
``/usr/local/bin``. You can alternatively run the binary from the download location.
.. code-block:: shell
:class: copyable
wget https://dl.min.io/client/mc/release/linux-amd64/mc
chmod +x mc
sudo mv mc /usr/local/bin/mc
Use :mc-cmd:`mc alias set` to create a new alias associated to your local deployment.
You can run :mc-cmd:`mc` commands against this alias:
.. code-block:: shell
:class: copyable
mc alias set local http://127.0.0.1:9000 {MINIO_ROOT_USER} {MINIO_ROOT_PASSWORD}
mc admin info local
Replace ``{MINIO_ROOT_USER}`` and ``{MINIO_ROOT_PASSWORD}`` with the credentials you defined for the container with the ``-e`` flags.
The :mc-cmd:`mc alias set` takes four arguments:
- The name of the alias
- The hostname or IP address and port of the MinIO server
- The Access Key for a MinIO :ref:`user <minio-users>`
- The Secret Key for a MinIO :ref:`user <minio-users>`
For additional details about this command, see :ref:`alias`.
.. dropdown:: MacOS
The :ref:`MinIO Client <minio-client>` allows you to work with your MinIO volume from the commandline.
.. tab-set::
.. tab-item:: Homebrew
Run the following command to install the latest stable MinIO Client package using `Homebrew <https://brew.sh>`_.
.. code-block:: shell
:class: copyable
brew install minio/stable/mc
.. tab-item:: Binary (arm64)
Run the following commands to install the latest stable MinIO Client package using a binary package for Apple chips.
.. code-block:: shell
:class: copyable
curl -O https://dl.min.io/client/mc/release/darwin-arm64/mc
chmod +x mc
sudo mv mc /usr/local/bin/mc
.. tab-item:: Binary (amd64)
Run the following commands to install the latest stable MinIO Client package using a binary package for Intel chips.
.. code-block:: shell
:class: copyable
curl -O https://dl.min.io/client/mc/release/darwin-amd64/mc
chmod +x mc
sudo mv mc /usr/local/bin/mc
Use :mc-cmd:`mc alias set` to quickly authenticate and connect to the MinIO deployment.
.. code-block:: shell
:class: copyable
mc alias set local http://127.0.0.1:9000 {MINIO_ROOT_USER} {MINIO_ROOT_PASSWORD}
mc admin info local
Replace ``{MINIO_ROOT_USER}`` and ``{MINIO_ROOT_PASSWORD}`` with the credentials you defined for the container with the ``-e`` flags.
The :mc-cmd:`mc alias set` takes four arguments:
- The name of the alias
- The hostname or IP address and port of the MinIO server
- The Access Key for a MinIO :ref:`user <minio-users>`
- The Secret Key for a MinIO :ref:`user <minio-users>`
For additional details about this command, see :ref:`alias`.
.. dropdown:: Windows
Download the standalone MinIO server for Windows from the following link:
https://dl.min.io/client/mc/release/windows-amd64/mc.exe
Double click on the file to run it.
Or, run the following in the Command Prompt or PowerShell.
.. code-block::
:class: copyable
\path\to\mc.exe --help
Use :mc-cmd:`mc alias set` to quickly authenticate and connect to the MinIO deployment.
.. code-block:: shell
:class: copyable
mc.exe alias set local http://127.0.0.1:9000 {MINIO_ROOT_USER} {MINIO_ROOT_PASSWORD}
mc.exe admin info local
Replace ``{MINIO_ROOT_USER}`` and ``{MINIO_ROOT_PASSWORD}`` with the credentials you defined for the container with the ``-e`` flags.
The :mc-cmd:`mc alias set` takes four arguments:
- The name of the alias
- The hostname or IP address and port of the MinIO server
- The Access Key for a MinIO :ref:`user <minio-users>`
- The Secret Key for a MinIO :ref:`user <minio-users>`
For additional details about this command, see :ref:`alias`.
Next Steps
----------
- :ref:`Connect your applications to MinIO <minio-drivers>`
- :ref:`Configure Object Retention <minio-object-retention>`
- :ref:`Configure Security <minio-authentication-and-identity-management>`
- :ref:`Deploy MinIO in a Distrbuted Environment <deploy-minio-distributed>`

168
source/quickstart/k8s.rst Normal file
View File

@@ -0,0 +1,168 @@
.. _quickstart-kubernetes:
=========================
Quickstart for Kubernetes
=========================
.. default-domain:: minio
.. |OS| replace:: Kubernetes
This procedure deploys a :ref:`Standalone <minio-installation-comparison>` MinIO server onto |OS| for early development and evaluation of MinIO Object Storage and it's S3-compatible API layer.
Standalone deployments (also called "filesystem mode") support a :ref:`subset of MinIO features <minio-installation-comparison>` where redundancy or availability are dependent entirely on the underlying drive or volume.
For production-ready :ref:`Distributed <minio-installation-comparison>` MinIO deployments on Kubernetes, use the :docs-k8s:`MinIO Kubernetes Operator <>`.
Prerequisites
-------------
- An existing Kubernetes deployment where *at least* one Worker Node has a locally-attached drive.
- A local ``kubectl`` installation configured to create and access resources on the target Kubernetes deployment.
- Familiarity with Kubernetes environments
- Familiarity with using a Terminal or Shell environment
Procedure
---------
#. **Download the MinIO Object**
.. tab-set::
.. tab-item:: Download the MinIO Kubernetes Object Definition
Download `minio-dev.yaml <https://raw.githubusercontent.com/minio/docs/master/source/extra/examples/minio-dev.yaml>`__ to your host machine:
.. code-block:: shell
:class: copyable
curl https://raw.githubusercontent.com/minio/docs/master/source/extra/examples/minio-dev.yaml -O
The file describes two Kubernetes resources:
- A new namespace ``minio-dev``, and
- A MinIO pod using a drive or volume on the Worker Node for serving data
Select the :guilabel:`Overview of the MinIO Object YAML` for a more detailed description of the object.
.. tab-item:: Overview of the MinIO Object YAML
The ``minio-dev.yaml`` contains the following Kubernetes resources:
.. literalinclude:: /extra/examples/minio-dev.yaml
:language: yaml
The object deploys two resources:
- A new namespace ``minio-dev``, and
- A MinIO pod using a drive or volume on the Worker Node for serving data
The MinIO resource definition uses Kubernetes :kube-docs:`Node Selectors and Labels <concepts/scheduling-eviction/assign-pod-node/#built-in-node-labels>` to restrict the pod to a node with matching hostname label.
Use ``kubectl get nodes --show-labels`` to view all labels assigned to each node in the cluster.
The MinIO Pod uses a :kube-docs:`hostPath <concepts/storage/volumes/#hostpath>` volume for storing data. This path *must* correspond to a local drive or folder on the Kubernetes worker node.
Users familiar with Kubernetes scheduling and volume provisioning may modify the ``spec.nodeSelector``, ``volumeMounts.name``, and ``volumes`` fields to meet more specific requirements.
#. **Apply the MinIO Object Definition**
The following command applies the ``minio-dev.yaml`` configuration and deploys the objects to Kubernetes:
.. code-block:: shell
:class: copyable
kubectl apply -f minio-dev.yaml
The command output should resemble the following:
.. code-block:: shell
namespace/minio-dev created
pod/minio created
You can verify the state of the pod by running ``kubectl get pods``:
.. code-block:: shell
:class: copyable
kubectl get pods -n minio-dev
The output should resemble the following:
.. code-block:: shell
NAME READY STATUS RESTARTS AGE
minio 1/1 Running 0 77s
You can also use the following commands to retrieve detailed information on the pod status:
.. code-block:: shell
:class: copyable
kubectl describe pod/minio -n minio-dev
kubectl logs pod/minio -n minio-dev
#. **Temporarily Access the MinIO S3 API and Console**
Use the ``kubectl port-forward`` command to temporarily forward traffic from the MinIO pod to the local machine:
.. code-block:: shell
:class: copyable
kubectl port-forward pod/minio 9000 9090
The command forwards the pod ports ``9000`` and ``9090`` to the matching port on the local machine while active in the shell.
The ``kubectl port-forward`` command only functions while active in the shell session.
Terminating the session closes the ports on the local machine.
.. note::
The following steps of this procedure assume an active ``kubectl port-forward`` command.
To configure long term access to the pod, configure :kube-docs:`Ingress <concepts/services-networking/ingress/>` or similar network control components within Kubernetes to route traffic to and from the pod. Configuring Ingress is out of the scope for this documentation.
#. **Connect your Browser to the MinIO Server**
Access the :ref:`minio-console` by opening a browser on the local machine and navigating to ``http://127.0.0.1:9090``.
Log in to the Console with the credentials ``minioadmin | minioadmin``.
These are the default :ref:`root user <minio-users-root>` credentials.
.. image:: /images/minio-console-login.png
:width: 600px
:alt: MinIO Console displaying login screen
:align: center
You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration.
Each MinIO server includes its own embedded MinIO Console.
.. image:: /images/minio-console-buckets.png
:width: 600px
:alt: MinIO Console displaying bucket start screen
:align: center
For more information, see the :ref:`minio-console` documentation.
#. **(Optional) Connect the MinIO Client**
If your local machine has :mc:`mc` :ref:`installed <mc-install>`, use the :mc-cmd:`mc alias set` command to authenticate and connect to the MinIO deployment:
.. code-block:: shell
:class: copyable
mc alias set k8s-minio-dev http://127.0.0.1:9000 minioadmin minioadmin
mc admin info k8s-minio-dev
- The name of the alias
- The hostname or IP address and port of the MinIO server
- The Access Key for a MinIO :ref:`user <minio-users>`
- The Secret Key for a MinIO :ref:`user <minio-users>`
Next Steps
----------
- :ref:`Connect your applications to MinIO <minio-drivers>`
- :ref:`Configure Object Retention <minio-object-retention>`
- :ref:`Configure Security <minio-authentication-and-identity-management>`
- :ref:`Deploy MinIO for Production Environments <deploy-minio-distributed>`

132
source/quickstart/linux.rst Normal file
View File

@@ -0,0 +1,132 @@
.. _quickstart-linux:
====================
Quickstart for Linux
====================
.. default-domain:: minio
.. |OS| replace:: Linux
This procedure deploys a :ref:`Standalone <minio-installation-comparison>` MinIO server onto |OS| for early development and evaluation of MinIO Object Storage and it's S3-compatible API layer.
Standalone deployments (also called "filesystem mode") support a :ref:`subset of MinIO features <minio-installation-comparison>` where redundancy or availability are dependent entirely on the underlying drive or volume.
For instructions on deploying to production environments, see :ref:`deploy-minio-distributed`.
Prerequisites
-------------
- Read, Write and Execute permissions on your local user folder (e.g. ``~/minio``).
- Permission to install binaries to the system ``PATH`` (e.g. access to ``/usr/local/bin``).
- Familiarity with the Linux terminal or shell (Bash, ZSH, etc.).
- A 64-bit Linux OS (e.g. RHEL 8, Ubuntu LTS releases).
Procedure
---------
#. **Install the MinIO Server**
.. include:: /includes/common-installation.rst
:start-after: start-install-minio-binary-desc
:end-before: end-install-minio-binary-desc
#. **Launch the MinIO Server**
Run the following command from the system terminal or shell to start a local MinIO instance using the ``~/minio`` folder. You can replace this path with another folder path on the local machine:
.. code-block:: shell
:class: copyable
mkdir ~/minio
minio server ~/minio --console-address :9090
The ``mkdir`` command creates the folder explicitly at the specified path.
The ``minio server`` command starts the MinIO server. The path argument
``~/minio`` identifies the folder in which the server operates.
The :mc:`minio server` process prints its output to the system console, similar to the following:
.. code-block:: shell
API: http://192.0.2.10:9000 http://127.0.0.1:9000
RootUser: minioadmin
RootPass: minioadmin
Console: http://192.0.2.10:9090 http://127.0.0.1:9090
RootUser: minioadmin
RootPass: minioadmin
Command-line: https://docs.min.io/docs/minio-client-quickstart-guide
$ mc alias set myminio http://192.0.2.10:9000 minioadmin minioadmin
Documentation: https://docs.min.io
WARNING: Detected default credentials 'minioadmin:minioadmin', we recommend that you change these values with 'MINIO_ROOT_USER' and 'MINIO_ROOT_PASSWORD' environment variables.
#. **Connect Your Browser to the MinIO Server**
Open http://127.0.0.1:9000 in a web browser to access the :ref:`MinIO Console <minio-console>`.
You can alternatively enter any of the network addresses specified as part of the server command output.
For example, :guilabel:`Console: http://192.0.2.10:9090 http://127.0.0.1:9090` in the example output indicates two possible addresses to use for connecting to the Console.
While the port ``9000`` is used for connecting to the API, MinIO automatically redirects browser access to the MinIO Console.
Log in to the Console with the ``RootUser`` and ``RootPass`` user credentials displayed in the output.
These default to ``minioadmin | minioadmin``.
.. image:: /images/minio-console-login.png
:width: 600px
:alt: MinIO Console displaying login screen
:align: center
You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration.
Each MinIO server includes its own embedded MinIO Console.
.. image:: /images/minio-console-buckets.png
:width: 600px
:alt: MinIO Console displaying bucket start screen
:align: center
For more information, see the :ref:`minio-console` documentation.
#. `(Optional)` **Install the MinIO Client**
The :ref:`MinIO Client <minio-client>` allows you to work with your MinIO server from the commandline.
Download the :mc:`mc` client and install it to a location on your system ``PATH`` such as
``/usr/local/bin``. You can alternatively run the binary from the download location.
.. code-block:: shell
:class: copyable
wget https://dl.min.io/client/mc/release/linux-amd64/mc
chmod +x mc
sudo mv mc /usr/local/bin/mc
Use :mc-cmd:`mc alias set` to create a new alias associated to your local deployment.
You can run :mc-cmd:`mc` commands against this alias:
.. code-block:: shell
:class: copyable
mc alias set local http://127.0.0.1:9000 minioadmin minioadmin
mc admin info local
The :mc-cmd:`mc alias set` takes four arguments:
- The name of the alias
- The hostname or IP address and port of the MinIO server
- The Access Key for a MinIO :ref:`user <minio-users>`
- The Secret Key for a MinIO :ref:`user <minio-users>`
The example above uses the :ref:`root user <minio-users-root>`.
Next Steps
----------
- :ref:`Connect your applications to MinIO <minio-drivers>`
- :ref:`Configure Object Retention <minio-object-retention>`
- :ref:`Configure Security <minio-authentication-and-identity-management>`
- :ref:`Deploy MinIO for Production Environments <deploy-minio-distributed>`

203
source/quickstart/macos.rst Normal file
View File

@@ -0,0 +1,203 @@
.. _quickstart-macos:
=======================
Quickstart for Mac OSX
=======================
.. default-domain:: minio
.. |OS| replace:: MacOS
This procedure deploys a :ref:`Standalone <minio-installation-comparison>` MinIO server onto |OS| for early development and evaluation of MinIO Object Storage and it's S3-compatible API layer.
Standalone deployments (also called "filesystem mode") support a :ref:`subset of MinIO features <minio-installation-comparison>` where redundancy or availability are dependent entirely on the underlying drive or volume.
For instructions on deploying to production environments, see :ref:`deploy-minio-distributed`.
Prerequisites
-------------
- Read, write, and execute permissions for the user's home directory
- Familiarity with using the Terminal
Procedure
---------
#. Install the MinIO Server
.. tab-set::
.. tab-item:: Homebrew
Open a Terminal and run the following command to install the latest stable MinIO package using `Homebrew <https://brew.sh>`_.
.. code-block:: shell
:class: copyable
brew install minio/stable/minio
.. important::
If you previously installed the MinIO server using ``brew install minio``, then we recommend that you reinstall from ``minio/stable/minio`` instead.
.. code-block:: shell
:class: copyable
brew uninstall minio
brew install minio/stable/minio
.. tab-item:: Binary - arm64
Open a Terminal, then use the following commands to download the standalone MinIO server for MacOS and make it executable.
.. code-block:: shell
:class: copyable
curl -O https://dl.min.io/server/minio/release/darwin-arm64/minio
chmod +x minio
.. tab-item:: Binary - amd64
Open a Terminal, then use the following commands to download the standalone MinIO server for MacOS and make it executable.
.. code-block:: shell
:class: copyable
curl -O https://dl.min.io/server/minio/release/darwin-amd64/minio
chmod +x minio
#. Launch the :mc:`minio server`
From the Terminal, use this command to start a local MinIO instance in the ``~/data`` folder.
If desired, you can replace ``~/data`` with another location to which the user has read, write, and delete access for the MinIO instance.
.. code-block:: shell
:class: copyable
~/minio server ~/data --console-address :9090
If you installed with Homebrew, do not include the ``~/`` at the beginning of the command.
The :mc:`minio server` process prints its output to the system console, similar to the following:
.. code-block:: shell
API: http://192.0.2.10:9000 http://127.0.0.1:9000
RootUser: minioadmin
RootPass: minioadmin
Console: http://192.0.2.10:9090 http://127.0.0.1:9090
RootUser: minioadmin
RootPass: minioadmin
Command-line: https://docs.min.io/docs/minio-client-quickstart-guide
$ mc alias set myminio http://192.0.2.10:9000 minioadmin minioadmin
Documentation: https://docs.min.io
WARNING: Detected default credentials 'minioadmin:minioadmin', we recommend that you change these values with 'MINIO_ROOT_USER' and 'MINIO_ROOT_PASSWORD' environment variables.
#. Connect your Browser to the MinIO Server
Access the :ref:`minio-console` by going to a browser (such as Safari) and going to ``https://127.0.0.1:9000`` or one of the Console addresses specified in the :mc:`minio server` command's output.
For example, :guilabel:`Console: http://192.0.2.10:9090 http://127.0.0.1:9090` in the example output indicates two possible addresses to use for connecting to the Console.
While port ``9000`` is used for connecting to the API, MinIO automatically redirects browser access to the MinIO Console.
Log in to the Console with the ``RootUser`` and ``RootPass`` user credentials displayed in the output.
These default to ``minioadmin | minioadmin``.
.. image:: /images/minio-console-login.png
:width: 600px
:alt: MinIO Console displaying login screen
:align: center
You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration.
Each MinIO server includes its own embedded MinIO Console.
.. image:: /images/minio-console-buckets.png
:width: 600px
:alt: MinIO Console displaying bucket start screen
:align: center
For more information, see the :ref:`minio-console` documentation.
#. `(Optional)` Install the MinIO Client
The :ref:`MinIO Client <minio-client>` allows you to work with your MinIO volume from the commandline.
.. tab-set::
.. tab-item:: Homebrew
Run the following commands to install the latest stable MinIO Client package using `Homebrew <https://brew.sh>`_.
.. code-block:: shell
:class: copyable
brew install minio/stable/mc
To use the command, run
.. code-block::
mc {command} {flag}
.. tab-item:: Binary (arm64)
Download the standalone MinIO server for MacOS and make it executable.
.. code-block:: shell
:class: copyable
curl -O https://dl.min.io/client/mc/release/darwin-arm64/mc
chmod +x mc
sudo mv mc /usr/local/bin/mc
To use the command, run
.. code-block:: shell
mc {command} {flag}
.. tab-item:: Binary (amd64)
Download the standalone MinIO server for MacOS and make it executable.
.. code-block:: shell
:class: copyable
curl -O https://dl.min.io/client/mc/release/darwin-amd64/mc
chmod +x mc
sudo mv mc /usr/local/bin/mc
To use the command, run
.. code-block:: shell
mc {command} {flag}
Use :mc-cmd:`mc alias set` to quickly authenticate and connect to the MinIO deployment.
.. code-block:: shell
:class: copyable
mc alias set local http://127.0.0.1:9000 minioadmin minioadmin
mc admin info local
The :mc-cmd:`mc alias set` takes four arguments:
- The name of the alias
- The hostname or IP address and port of the MinIO server
- The Access Key for a MinIO :ref:`user <minio-users>`
- The Secret Key for a MinIO :ref:`user <minio-users>`
For additional details about this command, see :ref:`alias`.
Next Steps
----------
- :ref:`Connect your applications to MinIO <minio-drivers>`
- :ref:`Configure Object Retention <minio-object-retention>`
- :ref:`Configure Security <minio-authentication-and-identity-management>`
- :ref:`Deploy MinIO for Production Environments <deploy-minio-distributed>`

83
source/quickstart/quickstart.rst Normal file
View File

@@ -0,0 +1,83 @@
.. _quickstart-index:
==========
Quickstart
==========
.. default-domain:: minio
MinIO is a high performance object storage solution with native support for Kubernetes deployments. MinIO provides an Amazon Web Services S3-compatible API and supports all core S3 features. MinIO is released under `GNU Affero General Public License v3.0 <https://www.gnu.org/licenses/agpl-3.0.en.html>`__.
Select the card corresponding to the platform on which you want to deploy MinIO to display instructions for deploying a :ref:`Standalone <minio-installation-comparison>` MinIO server appropriate for early development and evaluation environments.
.. grid:: 3
:gutter: 3
.. grid-item-card:: Linux
:link-type: ref
:link: quickstart-linux
.. image:: /images/logos/linux.svg
:width: 100px
:height: 100px
:alt: Linux Quickstart
:align: center
:class: noshadow
.. grid-item-card:: MacOS
:link-type: ref
:link: quickstart-macos
.. image:: /images/logos/macos.svg
:width: 100px
:height: 100px
:alt: MacOS Quickstart
:align: center
:class: noshadow
.. grid-item-card:: Windows
:link-type: ref
:link: quickstart-windows
.. image:: /images/logos/windows.svg
:width: 100px
:height: 100px
:alt: Windows Quickstart
:align: center
:class: noshadow
.. grid-item-card:: Kubernetes (Generic)
:link-type: ref
:link: quickstart-kubernetes
.. image:: /images/logos/kubernetes.svg
:width: 100px
:height: 100px
:alt: Kubernetes Quickstart
:align: center
:class: noshadow
.. grid-item-card:: Docker / Podman
:link-type: ref
:link: quickstart-container
.. image:: /images/logos/docker.svg
:width: 100px
:height: 100px
:alt: Docker Quickstart
:align: center
:class: noshadow
:subscript:`All trademarks or logos displayed on this page are the property of their respective owners, and constitute neither an endorsement nor a recommendation of those organizations. In addition, such use of trademarks or links to the web sites of third-party organizations is not intended to imply, directly or indirectly, that those organizations endorse or have any affiliation with MinIO.`
.. toctree::
:titlesonly:
:hidden:
/quickstart/linux
/quickstart/container
/quickstart/macos
/quickstart/windows
/quickstart/k8s

137
source/quickstart/windows.rst Normal file
View File

@@ -0,0 +1,137 @@
.. _quickstart-windows:
======================
Quickstart for Windows
======================
.. default-domain:: minio
.. |OS| replace:: Windows
This procedure deploys a :ref:`Standalone <minio-installation-comparison>` MinIO server onto |OS| for early development and evaluation of MinIO Object Storage and it's S3-compatible API layer.
Standalone deployments (also called "filesystem mode") support a :ref:`subset of MinIO features <minio-installation-comparison>` where redundancy or availability are dependent entirely on the underlying drive or volume.
For instructions on deploying to production environments, see :ref:`deploy-minio-distributed`.
Prerequisites
-------------
- Read, write, and execute permissions for the preferred local directory or file path
- Familiarity with using the Command Prompt or PowerShell
Procedure
---------
#. Install the MinIO Server
Download the MinIO executable from the following URL:
.. code-block:: shell
:class: copyable
https://dl.min.io/server/minio/release/windows-amd64/minio.exe
The next step includes instructions for running the executable.
You cannot run the executable from the Explorer or by double clicking the file.
Instead, you call the executable to launch the server.
#. Launch the :mc:`minio server`
In PowerShell or the Command Prompt, navigate to the location of the executable or add the path of the ``minio.exe`` file to the system ``$PATH``.
Use this command to start a local MinIO instance in the ``C:\minio`` folder.
You can replace ``C:\minio`` with another drive or folder path on the local computer.
.. code-block::
:class: copyable
.\minio.exe server C:\minio --console-address :9090
The :mc:`minio server` process prints its output to the system console, similar to the following:
.. code-block:: shell
API: http://192.0.2.10:9000 http://127.0.0.1:9000
RootUser: minioadmin
RootPass: minioadmin
Console: http://192.0.2.10:9090 http://127.0.0.1:9090
RootUser: minioadmin
RootPass: minioadmin
Command-line: https://docs.min.io/docs/minio-client-quickstart-guide
$ mc alias set myminio http://192.0.2.10:9000 minioadmin minioadmin
Documentation: https://docs.min.io
WARNING: Detected default credentials 'minioadmin:minioadmin', we recommend that you change these values with 'MINIO_ROOT_USER' and 'MINIO_ROOT_PASSWORD' environment variables.
The process is tied to the current PowerShell or Command Prompt window.
Closing the window stops the server and ends the process.
#. Connect your Browser to the MinIO Server
Access the :ref:`minio-console` by going to a browser (such as Microsoft Edge) and going to ``http://127.0.0.1:9000`` or one of the Console addresses specified in the :mc:`minio server` command's output.
For example, :guilabel:`Console: http://192.0.2.10:9090 http://127.0.0.1:9090` in the example output indicates two possible addresses to use for connecting to the Console.
While port ``9000`` is used for connecting to the API, MinIO automatically redirects browser access to the MinIO Console.
Log in to the Console with the ``RootUser`` and ``RootPass`` user credentials displayed in the output.
These default to ``minioadmin | minioadmin``.
.. image:: /images/minio-console-login.png
:width: 600px
:alt: MinIO Console displaying login screen
:align: center
You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration.
Each MinIO server includes its own embedded MinIO Console.
.. image:: /images/minio-console-buckets.png
:width: 600px
:alt: MinIO Console displaying bucket start screen
:align: center
For more information, see the :ref:`minio-console` documentation.
#. `(Optional)` Install the MinIO Client
The :ref:`MinIO Client <minio-client>` allows you to work with your MinIO volume from the commandline.
Download the standalone MinIO server for Windows from the following link:
https://dl.min.io/client/mc/release/windows-amd64/mc.exe
Double click on the file to run it.
Or, run the following in the Command Prompt or PowerShell.
.. code-block::
:class: copyable
\path\to\mc.exe --help
Use :mc-cmd:`mc.exe alias set <mc alias set>` to quickly authenticate and connect to the MinIO deployment.
.. code-block:: shell
:class: copyable
mc.exe alias set local http://127.0.0.1:9000 minioadmin minioadmin
mc.exe admin info local
The :mc-cmd:`mc.exe alias set <mc alias set>` takes four arguments:
- The name of the alias
- The hostname or IP address and port of the MinIO server
- The Access Key for a MinIO :ref:`user <minio-users>`
- The Secret Key for a MinIO :ref:`user <minio-users>`
For additional details about this command, see :ref:`alias`.
Next Steps
----------
- :ref:`Connect your applications to MinIO <minio-drivers>`
- :ref:`Configure Object Retention <minio-object-retention>`
- :ref:`Configure Security <minio-authentication-and-identity-management>`
- :ref:`Deploy MinIO for Production Environments <deploy-minio-distributed>`