Docs Multiplatform Slice

source/includes/linux/common-installation.rst

@@ -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