salt/README.rst

.. image:: https://img.shields.io/github/license/saltstack/salt
   :alt: Salt Project License: Apache v2.0
   :target: https://github.com/saltstack/salt/blob/master/LICENSE

.. image:: https://img.shields.io/pypi/dm/salt?label=pypi%20downloads
   :alt: PyPi Package Downloads
   :target: https://pypi.org/project/salt

.. image:: https://img.shields.io/lgtm/grade/python/github/saltstack/salt
   :alt: PyPi Package Downloads
   :target: https://lgtm.com/projects/g/saltstack/salt/context:python

.. image:: https://img.shields.io/badge/slack-@saltstackcommunity-blue.svg?logo=slack
   :alt: Salt Project Slack Community
   :target: https://saltstackcommunity.herokuapp.com/

.. image:: https://img.shields.io/twitch/status/saltstackinc
   :alt: Salt Project Twitch Channel
   :target: https://www.twitch.tv/saltstackinc

.. image:: https://img.shields.io/reddit/subreddit-subscribers/saltstack?style=social
   :alt: Salt Project subreddit
   :target: https://www.reddit.com/r/saltstack/

.. image:: https://img.shields.io/twitter/follow/Salt_Project_OS?style=social&logo=twitter
   :alt: Follow SaltStack on Twitter
   :target: https://twitter.com/intent/follow?screen_name=Salt_Project_OS

.. figure:: https://gitlab.com/saltstack/open/salt-branding-guide/-/raw/master/logos/SaltProject_altlogo_teal.png?inline=true
   :scale: 80 %
   :width: 1000px
   :height: 356px
   :align: center
   :alt: Salt Project Logo

* `Latest Salt Documentation`_
* `Open an issue`_ (bug report, feature request, etc.)

*Salt is the world’s fastest, most intelligent and scalable automation*
*engine.*

About Salt
==========

Built on python, Salt uses simple and human-readable YAML combined with
event-driven automation to deploy and configure complex IT systems. In addition
to leveling-up `vRealize Automation SaltStack Config`_, Salt can be found under
the hood of products from Juniper, Cisco, Cloudflare, Nutanix, SUSE, and Tieto,
to name a few.

About SaltStack
===============

`SaltStack was acquired by VMware in 2020 <https://www.vmware.com/company/acquisitions/saltstack.html>`_.
Salt Project remains an open source ecosystem that VMware supports and
contributes to.

Download Salt
=============

Salt is tested and packaged to run on CentOS, Debian, RHEL, Ubuntu, MacOS,
Windows, and more. Download Salt and get started now.

* `<https://repo.saltproject.io/>`_
* `Installation Instructions <https://docs.saltproject.io/en/latest/topics/installation/index.html>`_

Salt Project Documentation
==========================

Installation instructions, getting started guides, in-depth API
documentation, and contributing to Salt.

* `Getting Started with Salt <https://docs.saltproject.io/en/getstarted/>`_
* `Latest Salt Documentation`_
* `Salt’s Contributor Guide <https://docs.saltproject.io/en/latest/topics/development/contributing.html>`_

Security Advisories
===================

Keep an eye on the Salt Project
`Security Announcements <https://www.saltproject.io/security-announcements/>`_
landing page. Salt Project recommends subscribing to the
`Salt Project Security RSS feed <http://www.saltproject.io/feed/?post_type=security>`_
to receive notification when new information is available regarding security
announcements.

Other channels to receive security announcements include the
`Salt Community mailing list <https://groups.google.com/forum/#!forum/salt-users>`_
and the
`Salt Community Slack Channel <https://saltstackcommunity.herokuapp.com/>`_.

Responsibly Reporting Security Vulnerabilities
++++++++++++++++++++++++++++++++++++++++++++++

When reporting security vulnerabilities for Salt or other SaltStack projects,
refer to the `SECURITY.md`_ file found in this repository.

Engage the Salt Project and The Community
=========================================

Please be sure to review our
`Code of Conduct <https://github.com/saltstack/salt/blob/master/CODE_OF_CONDUCT.md>`_.
Also, check out some of our community resources including:

* `Salt Project Community Wiki <https://github.com/saltstack/community/wiki>`_
* `Salt Project Community Slack <https://saltstackcommunity.herokuapp.com/>`_
* `Salt Project: IRC on Freenode <https://webchat.freenode.net/#salt>`_
* `Salt Project YouTube channel <https://www.youtube.com/user/SaltStack>`_
* `Salt Project Twitch channel <https://www.twitch.tv/saltstackinc>`_

There are lots of ways to get involved in our community. Every month, there are
around a dozen opportunities to meet with other contributors and the Salt Core
team and collaborate in real time. The best way to keep track is by subscribing
to the **Salt Project Community Events Calendar** on the main
`<https://saltproject.io>`__ website.

If you have additional questions, email us at core@saltstack.com or reach out
directly to the Community Manager, Janae Andrus via Slack. We’d be glad to
have you join our community!

License
=======

Salt is licensed under the Apache 2.0 license. Please
see the
`LICENSE file <https://github.com/saltstack/salt/blob/master/LICENSE>`_ for the
full text of the Apache license, followed by a full summary of the licensing
used by external modules.

A complete list of attributions and dependencies can be found here:
`salt/DEPENDENCIES.md <https://github.com/saltstack/salt/blob/master/DEPENDENCIES.md>`_


.. _vRealize Automation SaltStack Config: https://www.vmware.com/products/vrealize-automation/saltstack-config.html
.. _Latest Salt Documentation: https://docs.saltproject.io/en/latest/
.. _Open an issue: https://github.com/saltstack/salt/issues/new/choose
.. _SECURITY.md: https://github.com/saltstack/salt/blob/master/SECURITY.md
.. _Calendar html: https://outlook.office365.com/owa/calendar/105f69bacd4541baa849529aed37eb2d@vmware.com/434ec2155b2b4cce90144c87f0dd03d56626754050155294962/calendar.html
.. _Calendar ics: https://outlook.office365.com/owa/calendar/105f69bacd4541baa849529aed37eb2d@vmware.com/434ec2155b2b4cce90144c87f0dd03d56626754050155294962/calendar.ics