fix example commands to export envvars for linux#1409

Merged

Bradamant3 merged 1 commit intomainfrom

Feb 7, 2025

Contributor

Bradamant3 commented Feb 6, 2025 •

edited

Loading

Fixes #1404

Two sets of fixes:

add conditionals for windows and linux where shared
search/replace for linux only (MinIO Server reference pages)

Staging server not available, tested/checked locally


          fix example commands to export envvars for linux

21bdfad

Bradamant3 requested review from djwfyi, feorlen and ravindk89

February 6, 2025 22:15

Contributor

feorlen commented Feb 7, 2025

When I build windows I get this error. But this file wasn't touched in your diff? The typo substitions should have made it fail for you also, don't know what is up with that.

source/includes/windows/common-minio-kes.rst:31: ERROR: Error in "code-block" directive:
unknown option: "substitions".

.. code-block:: shell
   :substitions:

   MINIO_KMS_KES_CERT_FILE=|miniocertpath|\minio-kes.cert
   MINIO_KMS_KES_KEY_FILE=|miniocertpath|\minio-kes.key

allanrogerr reviewed

View reviewed changes

source/reference/minio-server/settings/console.rst

                           :class: copyable
-                          set MINIO_BROWSER_CONTENT_SECURITY_POLICY="default-src 'self' 'unsafe-eval' 'unsafe-inline';"
+                          export MINIO_BROWSER_CONTENT_SECURITY_POLICY="default-src 'self' 'unsafe-eval' 'unsafe-inline';"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/metrics-and-logging.rst

                        :class: copyable
-                       set MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"
+                       export MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/amqp.rst

    
                       set MINIO_NOTIFY_AMQP_ENABLE_PRIMARY="on"

                       set MINIO_NOTIFY_AMQP_URL_PRIMARY="amqp://user:password@amqp-endpoint.example.net:5672"

                       export MINIO_NOTIFY_AMQP_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/elasticsearch.rst

    
                       set MINIO_NOTIFY_ELASTICSEARCH_URL_PRIMARY="https://user:password@elasticsearch-endpoint.example.net:9200"

                       set MINIO_NOTIFY_ELASTICSEARCH_INDEX_PRIMARY="bucketevents"

                       set MINIO_NOTIFY_ELASTICSEARCH_FORMAT_PRIMARY="namespace"

                       export MINIO_NOTIFY_ELASTICSEARCH_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/kafka.rst

    
                       set MINIO_NOTIFY_KAFKA_ENABLE_PRIMARY="on"

                       set MINIO_NOTIFY_KAFKA_BROKERS_PRIMARY="https://kafka1.example.net:9200, https://kafka2.example.net:9200"

                       export MINIO_NOTIFY_KAFKA_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/nats.rst

    
                       set MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"

                       set MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="nats-endpoint.example.net:4222"

                       export MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/nsq.rst

    
                       set MINIO_NOTIFY_NSQ_ENABLE_PRIMARY="on"

                       set MINIO_NOTIFY_NSQ_NSQD_ADDRESS_PRIMARY="https://user:password@nsq-endpoint.example.net:9200"

                       set MINIO_NOTIFY_NSQ_TOPIC_PRIMARY="bucketevents"

                       export MINIO_NOTIFY_NSQ_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/postgresql.rst

    
                       set MINIO_NOTIFY_POSTGRES_CONNECTION_STRING_PRIMARY="host=postgresql-endpoint.example.net port=4222..."

                       set MINIO_NOTIFY_POSTGRES_TABLE_PRIMARY="minioevents"

                       set MINIO_NOTIFY_POSTGRES_FORMAT_PRIMARY="namespace"

                       export MINIO_NOTIFY_POSTGRES_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/redis.rst

    
                       set MINIO_NOTIFY_REDIS_ADDRESS_PRIMARY="redis-endpoint.example.net:9200"

                       set MINIO_NOTIFY_REDIS_KEY_PRIMARY="bucketevents"

                       set MINIO_NOTIFY_REDIS_FORMAT_PRIMARY="namespace"

                       export MINIO_NOTIFY_REDIS_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

source/reference/minio-server/settings/notifications/webhook-service.rst

    
                       set MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"

                       set MINIO_NOTIFY_WEBHOOK_ENDPOINT_PRIMARY="https://webhook1.example.net"

                       export MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"

Contributor

allanrogerr Feb 7, 2025

Is there a windows | not windows differentiator for this text?

Contributor Author

Bradamant3 Feb 7, 2025

no, we don't produce windows docs for the Minio Server reference docs. They're linux only.

djwfyi approved these changes

View reviewed changes

Contributor

djwfyi left a comment

LGTM

Bradamant3 merged commit 80cc97e into main

1 check passed

Bradamant3 deleted the export-not-set branch

February 7, 2025 16:25

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet