summaryrefslogtreecommitdiffstats
path: root/INSTALL.md
diff options
context:
space:
mode:
authorJake McDermott <yo@jakemcdermott.me>2020-05-08 20:25:00 +0200
committerGitHub <noreply@github.com>2020-05-08 20:25:00 +0200
commit6f872bf7529b698ac032ed25dd751f70124bc8d6 (patch)
tree8159a02e5643a4868f5a189405a870cd1ff1977b /INSTALL.md
parentMerge pull request #6916 from nixocio/ui_issue_6742 (diff)
downloadawx-6f872bf7529b698ac032ed25dd751f70124bc8d6.tar.xz
awx-6f872bf7529b698ac032ed25dd751f70124bc8d6.zip
Document node and npm installation prerequisites
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/INSTALL.md b/INSTALL.md
index c9a671a2b5..f3d92fb1d2 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -80,9 +80,11 @@ Before you can run a deployment, you'll need the following installed in your loc
+ We use this module instead of `docker-py` because it is what the `docker-compose` Python module requires.
- [GNU Make](https://www.gnu.org/software/make/)
- [Git](https://git-scm.com/) Requires Version 1.8.4+
+- Python 3.6+
- [Node 10.x LTS version](https://nodejs.org/en/download/)
+ + This is only required if you're [building your own container images](#official-vs-building-images) with `use_container_for_build=false`
- [NPM 6.x LTS](https://docs.npmjs.com/)
-- Python 3.6+
+ + This is only required if you're [building your own container images](#official-vs-building-images) with `use_container_for_build=false`
### System Requirements
@@ -126,6 +128,10 @@ If these variables are present then all deployments will use these hosted images
> Multiple versions are provided. `latest` always pulls the most recent. You may also select version numbers at different granularities: 1, 1.0, 1.0.1, 1.0.0.123
+*use_container_for_build*
+
+> Use a local distribution build container image for building the AWX package. This is helpful if you don't want to bother installing the build-time dependencies as it is taken care of already.
+
## Upgrading from previous versions