Skip to content

Commit

Permalink
issue ansible#2672 installation docs
Browse files Browse the repository at this point in the history
Co-authored-by: Bradley A. Thornton <18386516+cidrblock@users.noreply.github.com>
  • Loading branch information
oraNod and cidrblock committed Nov 21, 2022
1 parent 397dc1d commit 95d02c0
Showing 1 changed file with 23 additions and 17 deletions.
40 changes: 23 additions & 17 deletions docs/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,40 @@
```

Installing on Windows is not supported because we use symlinks inside Python
packages.
Install Ansible-lint to apply rules and follow best practices with your automation content.

Our project does not ship a container. Please avoid raising any bugs
related to containers and use the [discussions](https://github.com/ansible/ansible-lint/discussions) forum instead.
```{note}
Ansible-lint does not currently support installation on Windows systems.
```

For a container image, we recommend using [creator-ee](https://github.com/ansible/creator-ee/), which includes Ansible-lint.
If you have a use case that the `creator-ee` container does satisfy, please contact the team through the [discussions](https://github.com/ansible/ansible-lint/discussions) forum.

We recommend you to try [creator-ee](https://github.com/ansible/creator-ee/),
which is a container that also carries ansible-lint.
You can also run Ansible-lint on your source code with the [Ansible-lint GitHub action](https://github.com/marketplace/actions/ansible-lint) instead of installing it directly.

## Using pip or pipx
## Installing the latest version

You can use either [pip3] or [pipx] to install it; the latter one
automatically isolates the linter from your current python environment.
That approach may avoid having to deal with particularities of installing
python packages, like creating a virtual environment, activating it, installing
using `--user` or fixing potential conflicts if not using virtualenvs.
You can install the most recent version of Ansible-lint with the [pip3] or [pipx] Python package manager.
Use [pipx] to isolate Ansible-lint from your current Python environment as an alternative to creating a virtual environment.

```bash
# This will also install ansible-core if needed
# This also installs ansible-core if it is not already installed
pip3 install "ansible-lint"
```

(installing-from-source)=
## Installing on CentOS, Fedora, and RHEL

You can install Ansible-lint on CentOS, Fedora, or Red Hat Enterprise Linux (RHEL) with the `dnf` package manager.

```bash
# This also installs ansible-core if it is not already installed
dnf install "ansible-lint"
```

## From Source
## Installing from source code

**Note**: pip 19.0+ is required for installation. Please consult with the
[PyPA User Guide] to learn more about managing Pip versions.
**Note**: pip 19.0+ is required for installation from the source repository.
Please consult the [PyPA User Guide] to learn more about managing Pip versions.

```bash
pip3 install git+https://github.com/ansible/ansible-lint.git
Expand Down

0 comments on commit 95d02c0

Please sign in to comment.