mirror of
https://github.com/minio/docs.git
synced 2025-07-31 18:04:52 +03:00
Docs Multiplatform Slice
This commit is contained in:
Ravind Kumar
261
source/includes/linux/common-installation.rst
Normal file
261
source/includes/linux/common-installation.rst
Normal file
@ -0,0 +1,261 @@
|
||||
.. start-install-minio-binary-desc
|
||||
|
||||
The following tabs provide examples of installing MinIO onto 64-bit Linux
|
||||
operating systems using RPM, DEB, or binary. The RPM and DEB packages
|
||||
automatically install MinIO to the necessary system paths and create a
|
||||
``systemd`` service file for running MinIO automatically. MinIO strongly
|
||||
recommends using RPM or DEB installation routes.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: RPM (RHEL)
|
||||
:sync: rpm
|
||||
|
||||
Use the following commands to download the latest stable MinIO RPM and
|
||||
install it.
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
:substitutions:
|
||||
|
||||
wget |minio-rpm| -O minio.deb
|
||||
sudo dnf install minio.rpm
|
||||
|
||||
.. tab-item:: DEB (Debian/Ubuntu)
|
||||
:sync: deb
|
||||
|
||||
Use the following commands to download the latest stable MinIO DEB and
|
||||
install it:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
:substitutions:
|
||||
|
||||
wget |minio-deb| -O minio.deb
|
||||
sudo dpkg -i minio.deb
|
||||
|
||||
.. tab-item:: Binary
|
||||
:sync: binary
|
||||
|
||||
Use the following commands to download the latest stable MinIO binary and
|
||||
install it to the system ``$PATH``:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
wget https://dl.min.io/server/minio/release/linux-amd64/minio
|
||||
chmod +x minio
|
||||
sudo mv minio /usr/local/bin/
|
||||
|
||||
.. end-install-minio-binary-desc
|
||||
|
||||
.. start-run-minio-binary-desc
|
||||
|
||||
Run the :mc-cmd:`minio server` command to start the MinIO server.
|
||||
Specify the path to the volume or folder to use as the storage directory.
|
||||
The :mc-cmd:`minio` process must have full access (``rwx``) to the specified path and all subfolders:
|
||||
|
||||
The following example uses the ``~/minio-data`` folder:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mkdir ~/minio-data
|
||||
minio server ~/minio-data --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
|
||||
|
||||
Open your browser to any of the listed :guilabel:`Console` addresses to open the
|
||||
:ref:`MinIO Console <minio-console>` and log in with the :guilabel:`RootUser`
|
||||
and :guilabel:`RootPass`. You can use the MinIO Console for performing
|
||||
administration on the MinIO server.
|
||||
|
||||
For applications, use the :guilabel:`API` addresses to access the MinIO
|
||||
server and perform S3 operations.
|
||||
|
||||
The following steps are optional but recommended for further securing the
|
||||
MinIO deployment.
|
||||
|
||||
.. end-run-minio-binary-desc
|
||||
|
||||
.. start-upgrade-minio-binary-desc
|
||||
|
||||
The following tabs provide examples of updating MinIO onto 64-bit Linux
|
||||
operating systems using RPM, DEB, or binary:
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: RPM (RHEL)
|
||||
:sync: rpm
|
||||
|
||||
Use the following commands to download the latest stable MinIO RPM and
|
||||
update the existing installation.
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
:substitutions:
|
||||
|
||||
wget |minio-rpm| -O minio.deb
|
||||
sudo dnf update minio.rpm
|
||||
|
||||
.. tab-item:: DEB (Debian/Ubuntu)
|
||||
:sync: deb
|
||||
|
||||
Use the following commands to download the latest stable MinIO DEB and
|
||||
upgrade the existing installation:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
:substitutions:
|
||||
|
||||
wget |minio-deb| -O minio.deb
|
||||
sudo dpkg -i minio.deb
|
||||
|
||||
.. tab-item:: Binary
|
||||
:sync: binary
|
||||
|
||||
Use the following commands to download the latest stable MinIO binary and
|
||||
overwrite the existing binary:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
wget https://dl.min.io/server/minio/release/linux-amd64/minio
|
||||
chmod +x minio
|
||||
sudo mv minio /usr/local/bin/
|
||||
|
||||
Replace ``/usr/local/bin`` with the location of the existing MinIO
|
||||
binary. Run ``which minio`` to identify the path if not already known.
|
||||
|
||||
.. end-upgrade-minio-binary-desc
|
||||
|
||||
.. start-install-minio-systemd-desc
|
||||
|
||||
The ``.deb`` or ``.rpm`` packages install the following
|
||||
`systemd <https://www.freedesktop.org/wiki/Software/systemd/>`__ service file to
|
||||
``/etc/systemd/system/minio.service``. For binary installations, create this
|
||||
file manually on all MinIO hosts:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
[Unit]
|
||||
Description=MinIO
|
||||
Documentation=https://docs.min.io
|
||||
Wants=network-online.target
|
||||
After=network-online.target
|
||||
AssertFileIsExecutable=/usr/local/bin/minio
|
||||
|
||||
[Service]
|
||||
WorkingDirectory=/usr/local
|
||||
|
||||
User=minio-user
|
||||
Group=minio-user
|
||||
ProtectProc=invisible
|
||||
|
||||
EnvironmentFile=-/etc/default/minio
|
||||
ExecStartPre=/bin/bash -c "if [ -z \"${MINIO_VOLUMES}\" ]; then echo \"Variable MINIO_VOLUMES not set in /etc/default/minio\"; exit 1; fi"
|
||||
ExecStart=/usr/local/bin/minio server $MINIO_OPTS $MINIO_VOLUMES
|
||||
|
||||
# Let systemd restart this service always
|
||||
Restart=always
|
||||
|
||||
# Specifies the maximum file descriptor number that can be opened by this process
|
||||
LimitNOFILE=65536
|
||||
|
||||
# Specifies the maximum number of threads this process can create
|
||||
TasksMax=infinity
|
||||
|
||||
# Disable timeout logic and wait until process is stopped
|
||||
TimeoutStopSec=infinity
|
||||
SendSIGKILL=no
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
|
||||
# Built for ${project.name}-${project.version} (${project.name})
|
||||
|
||||
The ``minio.service`` file runs as the ``minio-user`` User and Group by default.
|
||||
You can create the user and group using the ``groupadd`` and ``useradd``
|
||||
commands. The following example creates the user, group, and sets permissions
|
||||
to access the folder paths intended for use by MinIO. These commands typically
|
||||
require root (``sudo``) permissions.
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
groupadd -r minio-user
|
||||
useradd -M -r -g minio-user minio-user
|
||||
chown minio-user:minio-user /mnt/disk1 /mnt/disk2 /mnt/disk3 /mnt/disk4
|
||||
|
||||
The specified disk paths are provided as an example. Change them to match
|
||||
the path to those disks intended for use by MinIO.
|
||||
|
||||
Alternatively, change the ``User`` and ``Group`` values to another user and
|
||||
group on the system host with the necessary access and permissions.
|
||||
|
||||
MinIO publishes additional startup script examples on
|
||||
:minio-git:`github.com/minio/minio-service <minio-service>`.
|
||||
|
||||
.. end-install-minio-systemd-desc
|
||||
|
||||
.. start-install-minio-start-service-desc
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
sudo systemctl start minio.service
|
||||
|
||||
Use the following commands to confirm the service is online and functional:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
sudo systemctl status minio.service
|
||||
journalctl -f -u minio.service
|
||||
|
||||
MinIO may log an increased number of non-critical warnings while the
|
||||
server processes connect and synchronize. These warnings are typically
|
||||
transient and should resolve as the deployment comes online.
|
||||
|
||||
.. end-install-minio-start-service-desc
|
||||
|
||||
.. start-install-minio-restart-service-desc
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
sudo systemctl restart minio.service
|
||||
|
||||
Use the following commands to confirm the service is online and functional:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
sudo systemctl status minio.service
|
||||
journalctl -f -u minio.service
|
||||
|
||||
MinIO may log an increased number of non-critical warnings while the
|
||||
server processes connect and synchronize. These warnings are typically
|
||||
transient and should resolve as the deployment comes online.
|
||||
|
||||
.. end-install-minio-restart-service-desc
|
||||
96
source/includes/linux/deploy-standalone.rst
Normal file
96
source/includes/linux/deploy-standalone.rst
Normal file
@ -0,0 +1,96 @@
|
||||
1) Download the MinIO Server
|
||||
----------------------------
|
||||
|
||||
The following tabs provide examples of installing MinIO onto 64-bit Linux
|
||||
operating systems using RPM, DEB, or binary. The RPM and DEB packages
|
||||
automatically install MinIO to the necessary system paths and create a
|
||||
``systemd`` service file for running MinIO automatically. MinIO strongly
|
||||
recommends using RPM or DEB installation routes.
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: RPM (RHEL)
|
||||
:sync: rpm
|
||||
|
||||
Use the following commands to download the latest stable MinIO RPM and
|
||||
install it.
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
:substitutions:
|
||||
|
||||
wget |minio-rpm| -O minio.deb
|
||||
sudo dnf install minio.rpm
|
||||
|
||||
.. tab-item:: DEB (Debian/Ubuntu)
|
||||
:sync: deb
|
||||
|
||||
Use the following commands to download the latest stable MinIO DEB and
|
||||
install it:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
:substitutions:
|
||||
|
||||
wget |minio-deb| -O minio.deb
|
||||
sudo dpkg -i minio.deb
|
||||
|
||||
.. tab-item:: Binary
|
||||
:sync: binary
|
||||
|
||||
Use the following commands to download the latest stable MinIO binary and
|
||||
install it to the system ``$PATH``:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
wget https://dl.min.io/server/minio/release/linux-amd64/minio
|
||||
chmod +x minio
|
||||
sudo mv minio /usr/local/bin/
|
||||
|
||||
2) Run the MinIO Server
|
||||
-----------------------
|
||||
|
||||
Run the :mc-cmd:`minio server` command to start the MinIO server.
|
||||
Specify the path to the volume or folder to use as the storage directory.
|
||||
The :mc-cmd:`minio` process must have full access (``rwx``) to the specified path and all subfolders:
|
||||
|
||||
The following example uses the ``~/minio-data`` folder:
|
||||
|
||||
.. code-block:: shell
|
||||
:class: copyable
|
||||
|
||||
mkdir ~/minio-data
|
||||
minio server ~/minio-data --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
|
||||
|
||||
Open your browser to any of the listed :guilabel:`Console` addresses to open the
|
||||
:ref:`MinIO Console <minio-console>` and log in with the :guilabel:`RootUser`
|
||||
and :guilabel:`RootPass`. You can use the MinIO Console for performing
|
||||
administration on the MinIO server.
|
||||
|
||||
For applications, use the :guilabel:`API` addresses to access the MinIO
|
||||
server and perform S3 operations.
|
||||
|
||||
The following steps are optional but recommended for further securing the
|
||||
MinIO deployment.
|
||||
130
source/includes/linux/quickstart.rst
Normal file
130
source/includes/linux/quickstart.rst
Normal file
@ -0,0 +1,130 @@
|
||||
.. _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 its S3-compatible API layer.
|
||||
|
||||
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/linux/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/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/minio-console.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>`
|
||||
Reference in New Issue
Block a user