[{"_1":2,"_175":-5,"_176":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_150":151},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_139":-5,"_140":11,"_141":21,"_142":11,"_143":-5,"_144":11,"_145":-5,"_146":147,"_148":91,"_149":-7},"canonicalUrl","https://hub.docker.com/r/slocomptech/portainer-deployer/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","slocomptech","reponame","portainer-deployer","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-04-28T08:22:20.090192Z","description","Portainer deployer service","is_private","last_updated","2020-05-03T19:32:11.895035Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",282,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# portainer-deployer\n\nNodeJS application that deploys/updates portainer stack with new version of containers.\n\n## Usage\n\n``` bash\nexport PORTAINER_API=\"http://localhost:9000/api\"\n\n# Development\nnpm run start:dev\n\n# Production\nnpm run start\n\n# Development run commands\nDISABLE_AUTH=1 PORTAINER_API=http://localhost:9000/api npm run start:dev\nPORTAINER_API=http://localhost:9000/api npm run start:dev\n```\n\n## Docker\n\n### Build\n\n``` bash\ndocker build -t .\n```\n\n### Run\n\n``` bash\ndocker create \\\n --name=deployer \\\n -e PORTAINER_API=\"http://localhost:9000/api\" \\\n -e TZ=Europe/Ljubljana \\\n -p 3000:3000 \\\n --restart unless-stopped \\\n slocomptech/portainer-deployer\n```\n\n### Docker compose\n\n``` yaml\nversion: \"2\"\nservices:\n portainer-deployer:\n image: slocomptech/portainer-deployer\n container_name: portainer-deployer\n environment:\n - PORTAINER_API=\"http://localhost:9000/api\"\n - TZ=Europe/Ljubljana\n ports:\n - \"3000:3000\"\n restart: unless-stopped\n```\n\n### Parameters\n\n|Parameter|Function|\n|:-------:|:-------|\n| `-e DISABLE_AUTH=true` | Disable authentication |\n| `-e PORTAINER_API=http(s):///api` | Portainer API URL (required) |\n| `-e PORTAINER_USER=` | Portainer (default) username |\n| `-e PORTAINER_PASS=` | Portainer (default) password |\n| `-e CONFIG=` | Custom config file path. |\n| `-e LOG_LEVEL=verbose` | Enable app output see [docs](https://www.npmjs.com/package/winston#logging)|\n| `-e FAIL_MODE=hard` | What to do if services fail. |\n| `-e PUID=1000` | for UserID - see below for explanation |\n| `-e PGID=1000` | for GroupID - see below for explanation |\n| `-e SKIP_APP=true` | Don't start app, useful for development. |\n| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |\n| `-v :/config` | All the config files reside here. |\n| `-p 3000:3000` | Expose port |\n\n## Request\n\nRequest metod is **POST** and depends on handler, but in general request looks like\n\n``` json\n{\n \"handler\": \"default\", /* Handler name, if omitted default is 'default' */\n \"data\": {\n /* Data send to handler */\n }\n}\n```\n\n### Authentication\n\nAuthenitcation of app is linked to portainer API login, so it hasn't any internal authentication mechanisms.\nBut there are multiple ways of authentication:\n\n- Header `Authorization: Bearer `\n- Header `Authorization: Basic `\n- No headers, set `PORTAINER_USER`, `PORTAINER_PASS` environment variables.\n\n### Handlers\n\n#### Default handler\n\nDefault handler **changes** value of **existing** *environment variables* of stack and triggers redeploy.\n\n``` json\n{\n \"data\": {\n \"stack\": \"\",\n \"env\": {\n \"\": \"\"\n }\n }\n}\n```\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",232410731,"orgData","recentTags",[91,129],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",3391283,"full_size",134192561,"id",98611364,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:14c0579b508b045faedb7686b83fdd05fe4a92bdf1125929d7bbb0ff28a468f6","features","","last_pulled","2026-10-04T11:57:26.90901235Z","last_pushed","2020-05-03T19:32:12Z","os","linux","os_features","os_version","size","variant","2020-05-03T19:32:11.598264Z","last_updater","last_updater_username","media_type","latest","repository",8928901,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_92":44,"_93":94,"_95":130,"_97":131,"_99":132,"_50":137,"_119":94,"_120":33,"_121":56,"_57":138,"_123":124,"_125":135,"_126":137,"_127":66,"_128":21},134192532,98610880,[133],{"_102":103,"_104":134,"_106":107,"_108":135,"_110":136,"_112":113,"_114":107,"_115":-5,"_116":130,"_63":66,"_117":-5},"sha256:a792a69e2b6ab914fc3642ca61421202c1ff01ca44445a66017aa59a7d0a159f","2026-10-04T11:57:26.797265658Z","2020-05-03T19:25:31Z","2020-05-03T19:25:31.044614Z","1.0.0","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":152,"_159":160,"_146":173,"_174":11},{"_40":153,"_42":154,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":155,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":156,"_79":11,"_80":158,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":157},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_161":162,"_163":-5,"_164":-5,"_165":166},"count",2,"next","previous","results",[167,170],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":168,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[169],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},{"_92":44,"_93":94,"_95":130,"_97":131,"_99":171,"_50":137,"_119":94,"_120":33,"_121":56,"_57":138,"_123":124,"_125":135,"_126":137,"_127":66,"_128":21},[172],{"_102":103,"_104":134,"_106":107,"_108":135,"_110":136,"_112":113,"_114":107,"_115":-5,"_116":130,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

slocomptech/portainer-deployer

Tags for slocomptech/portainer-deployer