create-directus-docker 1.5.7 → 1.6.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-directus-docker",
-  "description": "An installer for Dockerized Directus + MySQL + Adminer + GraphiQL with a helper Node app",
-  "version": "1.5.7",
+  "description": "An installer for Dockerized Directus + MySQL + Adminer + GraphQL Sandbox with a helper Node app",
+  "version": "1.6.0",
   "type": "module",
   "author": {
     "name": "Dave Kobrenski",

package/templates/default/docker-compose.yml

@@ -1,10 +1,8 @@
-version: '3'
-
 services:
 
   mysql:
     container_name: mysql
-    image: mysql:8
+    image: mysql:8.4.2
     restart: always
     healthcheck: 
       test: ['CMD', 'mysqladmin', 'ping', '--silent']
@@ -19,7 +17,7 @@ services:
     volumes:
       - ./mysql:/var/lib/mysql
       - ./init:/docker-entrypoint-initdb.d
-    command: --default-authentication-plugin=mysql_native_password
+    command: --mysql-native-password=ON
     environment:
       MYSQL_USER: ${MYSQL_USER}
       MYSQL_PASSWORD: ${MYSQL_PASS}
@@ -31,7 +29,10 @@ services:
     image: adminer:latest
     restart: always
     depends_on:
-      - mysql
+      mysql:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
     networks: 
       - directus
     environment:
@@ -41,7 +42,14 @@ services:
 
   cache:
     container_name: cache
-    image: redis:6
+    image: redis:6.2.6
+    healthcheck:
+      test: ["CMD-SHELL", "[ $$(redis-cli ping) = 'PONG' ]"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_interval: 5s
+      start_period: 30s
     networks:
       - directus
 
@@ -57,8 +65,10 @@ services:
     networks:
       - directus
     depends_on:
-      - cache
-      - mysql
+      mysql:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
     environment:
       KEY: '255d861b-5ea1-5996-9aa3-922530ec40b1'
       SECRET: '6116487b-cda1-52c2-b5b5-c8022c45e263'
@@ -80,19 +90,13 @@ services:
       CORS_ENABLED: 'true'
       CORS_ORIGIN: 'true'
 
-      PUBLIC_URL: ${PUBLIC_URL}
+      # uncomment the following lines to enable email verification
+      # EMAIL_VERIFY_SETUP: 'true'
+      # EMAIL_TRANSPORT: ${EMAIL_TRANSPORT}
+      # EMAIL_SENDGRID_API_KEY: ${EMAIL_SENDGRID_API_KEY}
+      # EMAIL_FROM: ${EMAIL_FROM}
 
-  graphiql:
-    container_name: graphiql
-    image: plutoz/graphiql
-    depends_on:
-      - directus
-    ports:
-      - 4000:4000
-    environment:
-      API_ENDPOINT: ${API_ENDPOINT}
-    networks:
-      - directus
+      PUBLIC_URL: ${PUBLIC_URL}
 
 networks:
   directus:

package/templates/default/lib/index.js

@@ -58,13 +58,13 @@ try {
 
         if (fs.existsSync(path.join(rootPath, 'init')) === false) {
             fs.mkdir(path.join(rootPath, 'init'), () => {
-                //console.log(`'init' directory created. If you want to seed your database on first lanch, place your .sql file(s) in this directory BEFORE running services.`);
+                //console.log(`'init' directory created.`);
             });
         }
 
         if (fs.existsSync(path.join(rootPath, 'snapshots')) === false) {
             fs.mkdir(path.join(rootPath, 'snapshots'), () => {
-                //console.log(`'snapshots' directory created. If you want to seed your database on first lanch, place your .sql file(s) in this directory BEFORE running services.`);
+                //console.log(`'snapshots' directory created.`);
             });
         }
 
@@ -179,6 +179,10 @@ try {
                 }        
             }
 
+            writeStream.write(`\n\n# EMAIL_TRANSPORT="sendgrid"\n`);
+            writeStream.write(`# EMAIL_SENDGRID_API_KEY="your-sendgrid-key"\n`);
+            writeStream.write(`# EMAIL_FROM="sender@email"\n`);
+
             writeStream.end();
 
             console.log("\nYou can always edit the variables that we've just set in the .env file manually.\n\n");

package/templates/default/lib/launch-services.js

@@ -10,19 +10,27 @@ import jq from 'node-jq';
 dotenv.config();
 
 function outputDone() {
+    dotenv.config();
     if (process.env.DIRECTUS_DOMAIN === 'localhost') {
         var appURL = 'http://localhost';
     } else {
         var appURL = process.env.DIRECTUS_DOMAIN;
     }
 
+    const sandboxURL = `https://studio.apollographql.com/sandbox/explorer?endpoint=${process.env.API_ENDPOINT}`;
+
     console.log(chalk.green("\nAll services should be ready. You can access them at the following URLs:\n"));
     console.log(`Directus CMS: ${chalk.cyan(process.env.PUBLIC_URL)}`);
     console.log(`Adminer: ${chalk.cyan(appURL + ":8080")}`);
-    console.log(`GraphiQL Playground: ${chalk.cyan(appURL + ":4000/graphql")}`);
+    console.log(`GraphQL Playground: ${chalk.cyan(sandboxURL)}`);
+
+    /**
+     * Safari does not support network requests from Studio on HTTPS to your local HTTP endpoint, so we cannot reach your endpoint.
+     * Solution: use Chrome or Firefox to access the Studio.
+     */
 
-    console.log(`\n${chalk.redBright("Note: learn how to avoid CORS errors in the GraphiQL Playground when running on localhost:")}`);
-    console.log(`https://github.com/rollmug/directus-mysql-template#cors-problems-on-localhost`)
+    // console.log(`\n${chalk.redBright("Note: learn how to avoid CORS errors in the GraphQL Playground when running on localhost:")}`);
+    // console.log(`https://github.com/rollmug/directus-mysql-template#cors-problems-on-localhost`)
 
     console.log(`\n${chalk.green("When you're finished, you can stop all running containers with:")}\n`);
     console.log(`npm run stop\n`);
@@ -31,7 +39,8 @@ function outputDone() {
 }
 
 export default function launchServices() {
-    const launch = spawn('docker-compose', ['up', '-d', 'mysql']);
+    dotenv.config();
+    const launch = spawn('docker', ['compose', 'up', '-d', 'mysql']);
 
     const opts = {
         resources: [
@@ -68,7 +77,7 @@ export default function launchServices() {
             logUpdate("Building and launching containers:\n");
             logUpdate.done();
 
-            const launch2 = spawn('docker-compose', ['up', '-d']);
+            const launch2 = spawn('docker', ['compose', 'up', '-d']);
 
             launch2.stderr.on('data', (data) => {
                 logUpdate(`${data}`);
@@ -78,9 +87,11 @@ export default function launchServices() {
                 logUpdate('Done.');
                 logUpdate.done();
 
+                const publicURL = process.env.PUBLIC_URL;
+
                 const pingOpts = {
                     resources: [
-                        `${process.env.PUBLIC_URL}`
+                        `${publicURL}`
                     ],
                     delay: 1000,
                     interval: 300,
@@ -88,7 +99,12 @@ export default function launchServices() {
                     tcpTimeout: 40000
                 }
 
-                logUpdate(`Pinging directus at: ${process.env.PUBLIC_URL}`);
+                if(!publicURL) {
+                    logUpdate(`${chalk.redBright("Error: PUBLIC_URL is not set in the .env file.")}`);
+                    process.exit(1);
+                }
+
+                logUpdate(`Pinging directus at: ${publicURL}`);
                 const loader2 = ora('Waiting for Directus to be ready').start();    
 
                 waitOn(pingOpts).then(() => {
@@ -111,10 +127,13 @@ export default function launchServices() {
                             } else {
                                 var appURL = process.env.DIRECTUS_DOMAIN;
                             }
+
+                            const sandboxURL = `https://studio.apollographql.com/sandbox/explorer?endpoint=${process.env.API_ENDPOINT}`;
                             
                             open(process.env.PUBLIC_URL);
                             open(`${appURL}:8080`);
-                            open(`${appURL}:4000/graphql`);
+                            // open(`${appURL}:4000/graphql`);
+                            open(sandboxURL);
                         } else {
                             process.exit(1);
                         }
@@ -125,7 +144,7 @@ export default function launchServices() {
                     //It may be that it's running, so let's be sure.
                     logUpdate('Directus taking a long time to respond...');
 
-                    const check = spawn('docker-compose', ['ps', '-a', '--format', 'json']);
+                    const check = spawn('docker', ['compose', 'ps', '-a', '--format', 'json']);
 
                     check.stdout.on('data', (data) => {
                         const q = 'map(select(.Name == "directus")) | .[0] | {Name: .Name, Service: .Service, State: .State}';
@@ -146,12 +165,12 @@ export default function launchServices() {
                         if (code !== 0) {
                             var line1 = `${chalk.redBright("Directus taking too long to respond. You may need to manually start it.")}`;
                             var line2 = `Just run ${chalk.greenBright("npm run launch")} and you should be good to go.`;
-                            var line3 = `You can also check if it is running with ${chalk.greenBright("docker-compose ps")}`;
+                            var line3 = `You can also check if it is running with ${chalk.greenBright("docker compose ps")}`;
                             logUpdate(`${line1} \n${line2} \n${line3}`);
                         } else {
                             var line1 = `${chalk.yellowBright("Directus appears to be running, but took a while to respond.")}`;
                             var line2 = `Just run ${chalk.greenBright("npm run launch")} to verify, and you should be good to go.`;
-                            var line3 = `You can also check if it is running with ${chalk.greenBright("docker-compose ps")}`;
+                            var line3 = `You can also check if it is running with ${chalk.greenBright("docker compose ps")}`;
                             logUpdate(`${line1} \n${line2} \n${line3}`);
                         }
                     });

package/templates/default/package.json

@@ -1,16 +1,16 @@
 {
   "name": "directus-mysql-docker",
-  "version": "1.2.5",
-  "description": "A helper app to configure Directus on Docker with MySQL, Adminer, and GraphQL",
+  "version": "1.2.7",
+  "description": "A helper app to configure Directus on Docker with MySQL, Adminer, and Apollo GraphQL Sandbox",
   "main": "./lib/index.js",
   "type": "module",
   "scripts": {
     "start": "node ./lib/index.js",
     "launch": "node ./lib/index.js",
-    "stop": "docker-compose down",
-    "snapshot": "docker-compose exec directus npx directus schema snapshot /directus/snapshots/\"$(date \"+%F\")\"-snapshot-\"$(date \"+%s\")\".yaml",
-    "snapshot-apply": "docker-compose exec directus npx directus schema apply /directus/snapshots/$npm_config_snapshot",
-    "snapshot-test": "docker-compose exec directus npx directus schema apply --dry-run /directus/snapshots/$npm_config_snapshot"
+    "stop": "docker compose down",
+    "snapshot": "docker compose exec directus npx directus schema snapshot /directus/snapshots/\"$(date \"+%F\")\"-snapshot-\"$(date \"+%s\")\".yaml",
+    "snapshot-apply": "docker compose exec directus npx directus schema apply /directus/snapshots/$npm_config_snapshot",
+    "snapshot-test": "docker compose exec directus npx directus schema apply --dry-run /directus/snapshots/$npm_config_snapshot"
   },
   "bin": {
     "create-directus-docker": "./lib/index.js",