# dargstack > The dargstack script along with its and the template's documentation. Latest version **2.5.1** (published 2025-03-19) · GPL-3.0-only license · 0 weekly downloads ## Install ```sh npm install dargstack pnpm add dargstack yarn add dargstack bun add dargstack ``` ## Health **Score 45/100 (D)** — status: stable. Positive: esm support; no vulnerabilities; high maintenance score. Warnings: low downloads; no types. Negative: stale. ## Facts | | | |---|---| | Version | 2.5.1 | | Published | 2025-03-19 | | First published | 2022-10-28 | | Weekly downloads | 0 | | License | GPL-3.0-only | | TypeScript types | none | | Module format | ESM + CommonJS | | Node | 22 | | Dependencies | 0 | | Unpacked size | 56.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 11 | | Author | Jonas Thelemann | | Maintainers | dargmuesli | ## Links - npm: https://www.npmjs.com/package/dargstack - Repository: https://github.com/dargstack/dargstack - Homepage: https://github.com/dargstack/dargstack#readme - Issues: https://github.com/dargstack/dargstack/issues - npm.io page: https://npm.io/package/dargstack ## Recent versions - 2.5.1 (latest) — 2025-03-19 - 3.0.0 (main) — 2025-12-07 - 2.5.0 — 2025-03-18 - 2.4.1 — 2025-03-18 - 2.4.0 — 2025-03-18 - 2.3.0 — 2025-03-11 - 2.2.3 — 2025-02-05 - 2.2.2 — 2024-09-15 - 2.2.1 — 2023-03-27 - 2.2.0 — 2023-03-27 - 2.1.0 — 2023-01-24 - 2.0.3 — 2023-01-03 - 2.0.2 — 2023-01-03 - 2.0.1 — 2022-12-27 - 2.0.0 — 2022-11-08 - … 1 more at https://npm.io/package/dargstack/versions ## README # dargstack A template for Docker stack project layouts. Bootstrap it from [github.com/dargstack/dargstack_template](https://github.com/dargstack/dargstack_template)! > **This template solves the problem of separated development and production environments in the otherwise well-defined, containerized software development process. > It focuses on the development configuration, derives the production configuration from it and makes deployments a breeze!** ## Table of Contents 1. **[Installation Example](#installation-example)** 1. **[Skeleton](#skeleton)** 1. **[Helper Script](#helper-script)** 1. **[Configuration](#configuration)** 1. **[Example Projects](#example-projects)** ## Installation Example When using bash, you could setup this script as an executable the following way: ```bash mkdir ~/scripts/ \ && wget https://raw.githubusercontent.com/dargstack/dargstack/master/src/dargstack -O ~/scripts/dargstack \ && chmod +x ~/scripts/dargstack \ && echo 'export PATH="$PATH:$HOME/scripts"' >> ~/.bashrc \ && . ~/.bashrc ``` Feel free to deviate from this example and use your personal preference! ### Info for Apple users 1. `getopt` on macOS [differs from its Linux counterpart](https://en.wikipedia.org/wiki/Getopt#Extensions) in that it does not support long options with two hyphens. To solve this problem `gnu-getopt` has to be installed on macOS: ```sh brew install gnu-getopt ``` Dargstack will then automatically detect a getopt installation under `/opt/homebrew/opt/gnu-getopt/bin/getopt`. 2. Bash on macOS is of version 3.x which does not support [globstars](https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html). To run dargstack you need to install a newer bash version, i.e. from [brew](https://brew.sh/): ```sh brew install bash ``` You must then **always** use the newly installed bash version to invoke dargstack. To simplify the call, you might want to add an [alias to your `~/.bashrc`](https://wiki.ubuntuusers.de/alias/) ```sh /opt/homebrew/Cellar/bash/5.2.2/bin/bash dargstack # or echo "alias dargstack='/opt/homebrew/Cellar/bash/5.2.2/bin/bash dargstack'" >> ~/.bashrc ``` ## Skeleton The essential idea of this template. Read the full and detailed skeleton specification at [./README-skeleton.md](./README-skeleton.md). ## Helper Script Requires sudo >= 1.8.21 due to usage of the extended --preserve-env list syntax. That means the minimum supported Debian version is `buster`. ``` Dargstack template helper script. usage: dargstack modules build [sibling] Builds the main project or the specified sibling, tagged as dev. Only for development. deploy Deploys a Docker project either from a full local development clone of the project or, with the --production parameter provided, by doing a sparse Git checkout containing only the production configuration. In the latter case derive is executed first and the existence of required environment variables is checked before deployment starts. derive Derives a ./production/stack.yml from ./development/stack.yml. rgen Generate the README. rm Removes the stack. self-update Updates the helper script. validate Checks for an up-2-date README. options -a, --advertise-addr The address Docker Swarm advertises. -h, --help Display this help. Usable with modules: all. -o, --offline Do not try to update the checkout -p, --production Execute in production mode. Version must equal a tag name or latest. Usable with modules: deploy. -u, --url The URL to clone from. May include the substrings and that are replaced by their corresponding value that is inferred from the dargstack directory structure. Usable with modules: deploy. ``` ## Configuration A few setup strategies for the development environment have proven themselves useful, e.g. running a local dns server. ## Example Projects - [dargstack/dargstack-example](https://github.com/dargstack/dargstack-example/) - [dargstack/dargstack-example_stack](https://github.com/dargstack/dargstack-example_stack/) - [dargmuesli/jonas-thelemann_stack](https://github.com/dargmuesli/jonas-thelemann_stack/) - [flipdot/drinks-touch_stack](https://github.com/flipdot/drinks-touch_stack/) - [maevsi/maevsi_stack](https://github.com/maevsi/maevsi_stack/) --- _Source: https://npm.io/package/dargstack · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._