diff --git a/INSTALL.md b/INSTALL.md index 590ddb4d98..a3dc14b333 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -24,6 +24,8 @@ If you're attempting to migrate an older Docker-based AWX installation, see: [Mi Starting in version 18.0, the [AWX Operator](https://github.com/ansible/awx-operator) is the preferred way to install AWX. +AWX can also alternatively be installed and [run in Docker](./tools/docker-compose/README.md), but this install path is only recommended for development/test-oriented deployments, and has no official published release. + ### Quickstart with minikube If you don't have an existing OpenShift or Kubernetes cluster, minikube is a fast and easy way to get up and running. diff --git a/tools/docker-compose/README.md b/tools/docker-compose/README.md index d381614a75..3987e596d2 100644 --- a/tools/docker-compose/README.md +++ b/tools/docker-compose/README.md @@ -1,5 +1,23 @@ # Docker Compose for Development +## Getting started + +### Clone the repo + +If you have not already done so, you will need to clone, or create a local copy, of the [AWX repo](https://github.com/ansible/awx). We generally recommend that you view the releases page: + +https://github.com/ansible/awx/releases/latest + +...and clone the latest stable tag, e.g., + +`git clone -b x.y.z https://github.com/ansible/awx.git` + +Please note that deploying from `HEAD` (or the latest commit) is **not** stable, and that if you want to do this, you should proceed at your own risk. + +For more on how to clone the repo, view [git clone help](https://git-scm.com/docs/git-clone). + +Once you have a local copy, run the commands in the following sections from the root of the project tree. + ## Overview Here are the main make targets: