From 14c0e97d85f7636a27a621f1efa03e289fd4b3e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Mon, 26 Nov 2018 14:40:50 -0500 Subject: [PATCH] Add "How to install" section to docs --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 96c579f..7bbacd7 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,26 @@ Bash script to deploy/update/undeploy stacks in a [Portainer](https://portainer. Script was created for the latest Portainer API, which at the time of writing is [1.9.2](https://app.swaggerhub.com/apis/deviantony/Portainer/1.19.2). -## Requirements +## How to install + +Just clone the repo and use the script + +```bash +git clone https://github.com/greenled/portainer-stack-utils.git +cd portainer-stack-utils +./psu ... +``` + +### Requirements + +You will need these dependecies installed: - [bash](https://www.gnu.org/software/bash/) - [httpie](https://httpie.org/) - [jq](https://stedolan.github.io/jq/) +For Debian and similar apt-powered systems: `apt install bash httpie jq`. + ## How to use The provided `psu` script allows to deploy/update/undeploy Portainer stacks. Settings can be passed through envvars and/or flags. Both envvars and flags can be mixed but flags will always overwrite envvar values. When deploying a stack, if it doesn't exist a new one is created, otherwise it's updated (unless strict mode is active).