salt/doc/topics/installation/osx.rst
Jacob Hammons 9910b9c6f9 Fix incremental doc builds - OS X, postgres returner, tcp transport doc updates (#35865)
* Updates doc builds to generate build timestamp only when building for docs.saltstack.com. This re-enables incremental builds.
Adds notes to OS X page that Salt master on OS X is not officially supported
Adds note to postgres returners to cross-link modules with usage explanation (ZD #875)
Adds example showing how to enable tcp transport

* Generate copyright date
Footer updates
2016-08-31 09:51:36 -06:00

81 lines
2.3 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

====
OS X
====
Installation from the Official SaltStack Repository
===================================================
**Latest stable build from the selected branch**:
|osxdownload|
The output of ``md5 <salt pkg>`` should match the contents of the
corresponding md5 file.
`Earlier builds from supported branches <https://repo.saltstack.com/osx/>`__
`Archived builds from unsupported branches <https://repo.saltstack.com/osx/archive/>`__
Installation from Homebrew
==========================
.. code-block:: bash
brew install saltstack
It should be noted that Homebrew explicitly discourages the `use of sudo`_:
Homebrew is designed to work without using sudo. You can decide to use it but we strongly recommend not to do so. If you have used sudo and run into a bug then it is likely to be the cause. Please dont file a bug report unless you can reproduce it after reinstalling Homebrew from scratch without using sudo
.. _use of sudo: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/FAQ.md#sudo
Installation from MacPorts
==========================
.. code-block:: bash
sudo port install salt
Installation from Pip
=====================
When only using the OS X system's pip, install this way:
.. code-block:: bash
sudo pip install salt
Salt-Master Customizations
==========================
.. note::
Salt master on OS X is not tested or supported by SaltStack. See `SaltStack Platform Support <https://saltstack.com/product-support-lifecycle/>`_ for more information.
To run salt-master on OS X, sudo add this configuration option to the /etc/salt/master file:
.. code-block:: bash
max_open_files: 8192
On versions previous to OS X 10.10 (Yosemite), increase the root user maxfiles limit:
.. code-block:: bash
sudo launchctl limit maxfiles 4096 8192
.. note::
On OS X 10.10 (Yosemite) and higher, maxfiles should not be adjusted. The
default limits are sufficient in all but the most extreme scenarios.
Overriding these values with the setting below will cause system
instability!
Now the salt-master should run without errors:
.. code-block:: bash
sudo salt-master --log-level=all
Post-installation tasks
=======================
Now go to the :doc:`Configuring Salt</ref/configuration/index>` page.