Mirrored_Repos/psu
1
0
Fork 0
mirror of https://gitlab.com/psuapp/psu.git synced 2024-08-30 18:12:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add "How to install" section to docs

Browse Source
This commit is contained in:
Juan Carlos Mejías Rodríguez 2018-11-26 14:40:50 -05:00 committed by GitHub
parent 8a8020d013
commit 14c0e97d85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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).