0.9.57 • Published 6 months ago

dargstack_rgen v0.9.57

Weekly downloads
71
License
GPL-3.0-only
Repository
github
Last release
6 months ago

CI

DargStack RGen

DargStack's README.md generator.

Run the script using node ./src/generator.js or dargstack rgen.

Help

Options:
  --version   Show version number                                      [boolean]
  --path, -p  Path to a DargStack stack project                         [string]
  --help, -h  Show help                                                [boolean]

Example

YAML input:

# example.com
# https://example.com/
# example
# https://github.com/example/example/
---
configs:
  service_config:
  # The service's config.
    file: ./path/to/con.fig
secrets:
  service_password:
  # The service's login password
    file: ./path/to/password.secret
services:
  adminer:
  # You can access the service's frontend at [service.localhost](https://service.localhost/).
  # This information is required for login:
  #
  # |          |                     |
  # | -------- | ------------------- |
  # | Username | service_user     |
  # | Password | [service_password] |
  #
  # Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).
    configs:
    - source: service_config
      target: /src/app/config/con.fig
    image: service:1.2.3
    secrets:
    - service_password
    volumes:
    - service_data:/mnt/data/
version: "3.8"
volumes:
  service_data:
  # The service's data.
    {}

Markdown output:

# example_stack


The Docker stack configuration for [example.com](https://example.com/).

This project is deployed in accordance to the [DargStack template](https://github.com/dargstack/dargstack_template/) to make deployment a breeze. It is closely related to [example's source code](https://github.com/example/example/).

## Table of Contents


 1. [configs](#configs)

 2. [secrets](#secrets)

 3. [services](#services)

 4. [volumes](#volumes)


## configs


 - ### `service_config`

    The service's config.


## secrets


 - ### `service_password`

    The service's login password


## services


 - ### `adminer`

    You can access the service's frontend at [service.localhost](https://service.localhost/).
    This information is required for login:

    |          |                     |
    | -------- | ------------------- |
    | Username | service_user     |
    | Password | [service_password] |

    Values in square brackets are [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).


## volumes


 - ### `service_data`

    The service's data.

Markdown rendered:

example_stack

The Docker stack configuration for example.com.

This project is deployed in accordance to the DargStack template to make deployment a breeze. It is closely related to example's source code.

Table of Contents

  1. configs

  2. secrets

  3. services

  4. volumes

configs

  • service_config

    The service's config.

secrets

  • service_password

    The service's login password

services

volumes

  • service_data

    The service's data.

0.9.57

6 months ago

0.9.56

6 months ago

0.9.55

7 months ago

0.9.54

7 months ago

0.9.53

8 months ago

0.9.52

8 months ago

0.9.51

9 months ago

0.9.50

9 months ago

0.9.49

10 months ago

0.9.48

10 months ago

0.9.47

10 months ago

0.9.46

11 months ago

0.9.45

11 months ago

0.9.42

12 months ago

0.9.43

12 months ago

0.9.44

11 months ago

0.9.41

1 year ago

0.9.40

1 year ago

0.9.39

1 year ago

0.9.37

1 year ago

0.9.38

1 year ago

0.9.36

1 year ago

0.9.35

1 year ago

0.9.34

1 year ago

0.9.33

1 year ago

0.9.32

1 year ago

0.9.31

1 year ago

0.9.30

1 year ago

0.9.29

1 year ago

0.9.28

1 year ago

0.9.27

2 years ago

0.9.26

2 years ago

0.9.25

2 years ago

0.9.24

2 years ago

0.9.23

2 years ago

0.9.22

2 years ago

0.9.20

2 years ago

0.9.21

2 years ago

0.9.12

2 years ago

0.9.13

2 years ago

0.9.14

2 years ago

0.9.15

2 years ago

0.9.10

2 years ago

0.9.11

2 years ago

0.9.16

2 years ago

0.9.17

2 years ago

0.9.18

2 years ago

0.9.19

2 years ago

0.9.9

2 years ago

0.9.8

2 years ago

0.9.7

2 years ago

0.9.6

2 years ago

0.9.5

2 years ago

0.9.2

2 years ago

0.9.4

2 years ago

0.9.3

2 years ago

0.9.1

2 years ago

0.8.9

2 years ago

0.8.8

2 years ago

0.9.0

2 years ago

0.8.7

3 years ago

0.8.6

3 years ago

0.8.5

3 years ago

0.8.4

3 years ago

0.7.16

3 years ago

0.8.1

3 years ago

0.8.0

3 years ago

0.8.3

3 years ago

0.8.2

3 years ago

0.7.11

3 years ago

0.7.13

3 years ago

0.7.12

3 years ago

0.7.15

3 years ago

0.7.14

3 years ago

0.7.10

3 years ago

0.7.9

3 years ago

0.7.4

3 years ago

0.7.3

3 years ago

0.7.6

3 years ago

0.7.5

3 years ago

0.7.8

3 years ago

0.7.7

3 years ago

0.6.54

3 years ago

0.6.53

3 years ago

0.6.55

3 years ago

0.7.2

3 years ago

0.7.1

3 years ago

0.7.0

3 years ago

0.6.50

3 years ago

0.6.52

3 years ago

0.6.51

3 years ago

0.6.47

3 years ago

0.6.46

3 years ago

0.6.49

3 years ago

0.6.48

3 years ago

0.6.45

4 years ago

0.6.43

4 years ago

0.6.44

4 years ago

0.6.39

4 years ago

0.6.38

4 years ago

0.6.37

4 years ago

0.6.36

4 years ago

0.6.35

4 years ago

0.6.34

4 years ago

0.6.33

4 years ago

0.6.32

4 years ago

0.6.24

4 years ago

0.6.23

4 years ago

0.6.22

4 years ago

0.6.21

4 years ago

0.6.20

4 years ago

0.6.19

4 years ago

0.6.18

4 years ago

0.6.17

4 years ago

0.6.16

4 years ago

0.6.15

4 years ago

0.6.14

5 years ago

0.6.13

5 years ago

0.6.12

5 years ago

0.6.11

5 years ago

0.6.10

5 years ago

0.6.9

5 years ago

0.6.8

5 years ago

0.6.7

5 years ago

0.6.6

5 years ago

0.6.5

5 years ago

0.6.4

5 years ago

0.6.3

5 years ago

0.6.2

5 years ago

0.6.1

5 years ago

0.6.0

5 years ago