@Strapi-community/dockerize
Add docker support for a Strapi Project with ease
Feel free to buy @Eventyret a
Table of Contents
๐ฆ Current Statusโจ Usage๐ Features๐ณ Docker-compose support๐ Contributingโญ๏ธ Show your support๐ Links๐ Community support๐โโ๏ธ Authors๐โโ๏ธ Contributors (Thank you๐ )๐ License
๐ฆ 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 new
--projectname=<projectname>
--dbtype=<dbclient>
--dbhost=<dbhost>
--dbport=<dbport>
--dbname=<dbname>
--dbusername=<dbusername>
--dbpassword=<dbpassword>
--projecttype=<projecttype>
--packagemanager=<packagemanager>
--usecompose=<usecompose>
--env=<env>
| ๐ป Command | ๐ฌ Value | ๐ฆ Type | ๐ฒ Default |
| -------------- | --------------------------------------- | ------- | ------------- |
| projectname | | String | `mystrapi` |
| dbclient | `postgres` \| `mysql` \| `mariadb` | String | `postgres` |
| dbhost | | String | `localhost` |
| dbport | `5432` \| `3306` | Number | `5432` |
| dbname | | String | `strapi` |
| dbusername | | String | `strapi` |
| dbpassword | | String | |
| projecttype | `ts` \| `js` | String | `js` |
| packagemanager | `yarn` \| `npm` | String | `yarn` |
| usecompose | `true` \| `false` | Boolean | `false` |
| env | `development` \| `production` \| `both` | String | `development` |
๐งน Resetting project
@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
ornpm
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: [email protected] or ping Cookie Monster#6725
on Discord.
โญ๏ธ Show your support
Give a star if this project helped you.
Feel free to buy [@Eventyret] a
๐ Links
๐ Community support
- For general help using Strapi, please refer to the official Strapi documentation.
- For support with this plugin you can DM me in the Strapi Discord channel.
๐โโ๏ธ Authors
๐โโ๏ธ Contributors (Thank you ๐ )
๐ License
See the LICENSE file for licensing information.