Skip to content

Latest commit

 

History

History
144 lines (106 loc) · 5.4 KB

README.md

File metadata and controls

144 lines (106 loc) · 5.4 KB
Raw

@Strapi-community/dockerize

Add docker support for a Strapi Project with ease 🚀

Feel free to buy @Eventyret a ☕️ if this tool was helpful Open Collective

Strapi Discord NPM Version Monthly download on NPM

Table of Contents

🚦 Current Status

This package is currently under development and should be consider STABLE in terms of state. I/We are currently accepting contributions and/or dedicated contributors to help develop and maintain this package.

For more information on contributing please see the contrib message below.

✨ Usage

npx @strapi-community/dockerize

You can also call it directly with arguments

npx @strapi-community/dockerize new --dbclient=mysql --dbhost=localhost --dbport=1234 --dbname=strapi --dbusername=strapi --dbpassword=strapi --projecttype=js --packagemanager=yarn --usecompose=false --env=both

🤖 Using CLI Arguments

Please note the new keyword is required for this to take effect.

npx @strapi-community/dockerize
--dbtype=<dbtype>
--dbhost=<dbhost>
--dbport=<dbport>
--dbname=<dbname>
--dbuser=<dbuser>
--dbpassword=<dbpassword>
--type=<type>
--packagemanager=<packagemanager>
--useCompose=<useCompose>
--env=<env>
| 💻 Command     | 💬 Value                                | 🦄 Type | 🐲 Default    |
| -------------- | --------------------------------------- | ------- | ------------- |
| dbtype         | `postgres` \| `mysql` \| `mariadb`      | String  | `postgres`    |
| dbhost         |                                         | String  | `localhost`   |
| dbport         | `5432` \| `3306`                        | Number  | `5432`        |
| dbname         |                                         | String  | `strapi`      |
| dbuser         |                                         | String  | `strapi`      |
| dbpassword     |                                         | String  | `strapi`      |
| type           | `ts` \| `js`                            | String  | `js`          |
| packagemanager | `yarn` \| `npm`                         | String  | `yarn`        |
| useCompose     | `true` \| `false`                       | Boolean | `false`       |
| env            | `development` \| `production` \| `both` | String  | `development` |

🧹 Resetting project

npx @strapi-community/dockerize reset

Note that RESET will delete the config/env folder with all of it's content

🚀 Features

  • Easy add support for docker
  • Auto detects yarn or npm in your project
  • Build a docker-compose file

🐳 Docker-compose support

  • Postgres 14.5
  • MySQL 8
  • MariaDB 10

🎗 Contributing

I/We are actively looking for contributors, maintainers, and others to help shape this package. As this plugins sole purpose within the Strapi community is to be used by other developers and plugin maintainers to get fast responses time.

If interested please feel free to email the lead maintainer Simen at: simen@dehlin.dev or ping Cookie Monster#6725 on Discord.

⭐️ Show your support

Give a star if this project helped you. Feel free to buy [@Eventyret] a ☕️ if it was helpful. Open Collective

🔗 Links

🌎 Community support

🙋‍♀️ Authors

🙋‍♂️ Contributors (Thank you 🙏)

🔖 License

See the LICENSE file for licensing information.