create-directus-docker 1.6.3 → 1.6.4

package/README.md

@@ -1,16 +1,16 @@
-# Docker with Directus + MySQL + Adminer + GraphiQL
+## Docker with Directus / MySQL / Adminer / GraphQL
 
-A quick-start installer and launcher for Docker compose, containing Directus with MySQL, an Adminer UI for managing the database, and a GraphiQL playground. Plus a helper app to walk you through initializing environment variables and launching all services. 
+A quick-start installer and launcher for Docker compose, containing Directus with MySQL, an Adminer UI for managing the database, and a GraphiQL playground. Plus a helper app to walk you through initializing environment variables and launching all services.
 
-## Requirements
-
-You need [Docker](https://www.docker.com) and [Node](https://nodejs.org) installed on your machine:
+**Requirements:** you need [Docker](https://www.docker.com) and [Node](https://nodejs.org) installed on your machine:
 
 - [Install Docker Desktop](https://www.docker.com/products/docker-desktop/)  
 - [Install Node](https://nodejs.org/en/download/)
 
 ## Installation & Usage
 
+**The easiest way to get up and running is to open a terminal session and run:**
+
 ```bash
 npx create-directus-docker@latest <my-project>
 ```
@@ -25,15 +25,61 @@ npm start
 
 The wizard will walk you through configuring your environment variables, and will launch all services for you.
 
+### Seeding MySQL data
+
+If you want to seed your database with data on first launch, place your .sql file(s) in the "init" directory at the root of this package. MySQL will run any files in this directory the first time it launches.
+
+### Starting/stopping with Docker Compose
+
+To **stop** your running containers, simply run `docker compose down` in your terminal from within the project directory. All containers will be stopped.
+
+To **restart** your stopped containers, you can let the helper app do it for you:
+
+`npm start`
+
+Or you can follow this sequence:
+
+`docker compose up mysql -d`
+
+Then wait 10-20 seconds (for MySQL to boot), then type:
+
+`docker compose up -d`
+
 **Boom!** You're done. Now you can access the URLS from here:
 
 Directus CMS: http://localhost:8055  
-Adminer (for MySQL): http://localhost:8080  
 Apollo GraphQL Sandbox: https://studio.apollographql.com/sandbox/explorer?endpoint=http://localhost:8055/graphql  
+Adminer (for MySQL): http://localhost:8080
+
+**Check on running containers:**
+
+Simply run `docker compose ps` to see the status of running containers. Or, run `docker compose ps -a` to see all containers, running or not.
+
+### NGINX Proxy example
+
+Included in this package is also a `docker-compose-nginx.yml` file that demonstrates how to run a reverse proxy on a Linux-based server so that you can use a custom domain with an auto-generated/renewed SSL certificate via Let's Encrypt.
 
-## Seeding MySQL data
+To use this, rename the existing `docker-compose.yml` file to something else, and rename the `docker-compose-nginx.yml` to `docker-compose.yml`.
 
-If you want to seed your database with data on first launch, place your .sql file(s) in the "init" directory at the root of this package, BEFORE you run all services. MySQL will run any files in this directory the first time it launches.
+Add the following env variables to your `.env` file:
+
+```bash
+VIRTUAL_HOST="your-domain.com"
+CERT_EMAIL="you@email"
+```
+
+and make sure your Directus .env variables look something like this:
+
+```bash
+DIRECTUS_DOMAIN="localhost"
+DIRECTUS_PORT="8055"
+PUBLIC_URL="https://your-domain.com"
+API_ENDPOINT="https://your-domain.com/graphql"
+```
+
+Lastly, before running `npm start`, make sure you have pointed to your domain's DNS to your server using the appropriate A records.
+
+Note: you may need to adjust or disable your firewall before running this, to ensure that the SSL certificate can be properly generated using the included `acme-companion` container for Let's Encrypt.
 
 ### Snapshot the Data Model
 
@@ -57,22 +103,8 @@ By applying the snapshot, Directus will auto-detect the changes required to make
 
 `npm run snapshot-test --snapshot=snapshot-file.yaml`
 
-## Starting/stopping with Docker Compose
-
-To **stop** your running containers, simply run either `npm run stop` or  `docker compose down` from within the project directory. All containers will be stopped.
-
-To **restart** your stopped containers, you can let the helper app do it for you:
-
-`npm start`
-
-The helper app waits for MySQL to be ready before starting the rest of the services (otherwise, you'd get errors).
-
-**Check on running containers:**
-
-Simply run `docker compose ps` to see the status of running containers. Or, run `docker compose ps -a` to see all containers, running or not.
-
 ### Examples of getting an auth token for Directus API:
 
 curl -X POST localhost:8055/auth/login -H 'Content-Type: application/json' -d '{"email":"you@email.com","password":"your-password"}'
 
-curl -X POST localhost:8055/auth/refresh -H 'Content-Type: application/json' -d '{"refresh_token": "W5L70MBXKElx5ZVZwxmQVG8qdVjukiRVIwD5FYG7tCPyyuCM_I3IyCsYnFhMUrRi", "mode": "json"}'
+curl -X POST localhost:8055/auth/refresh -H 'Content-Type: application/json' -d '{"refresh_token": "W5L70MBXKElx5ZVZwxmQVG8qdVjukiRVIwD5FYG7tCPyyuCM_I3IyCsYnFhMUrRi", "mode": "json"}'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-directus-docker",
   "description": "An installer for Dockerized Directus + MySQL + Adminer + GraphQL Sandbox with a helper Node app",
-  "version": "1.6.3",
+  "version": "1.6.4",
   "type": "module",
   "author": {
     "name": "Dave Kobrenski",
@@ -25,7 +25,9 @@
   "scripts": {
     "init": "npm-run-all -p copy:*",
     "copy:package": "copy-file ../directus-mysql-template/package.json ./templates/default/package.json",
+    "copy:env-sample": "copy-file ../directus-mysql-template/env-sample.txt ./templates/default/env-sample.txt",
     "copy:compose": "copy-file ../directus-mysql-template/docker-compose.yml ./templates/default/docker-compose.yml",
+    "copy:compose-nginx": "copy-file ../directus-mysql-template/docker-compose-nginx.yml ./templates/default/docker-compose-nginx.yml",
     "copy:readme": "copy-file ../directus-mysql-template/README.md ./templates/default/README.md",
     "copy:lib": "copyfiles --flat ../directus-mysql-template/lib/*.js ./templates/default/lib"
   },

package/templates/default/README.md

@@ -41,28 +41,6 @@ As an alternative, you can install this package by following these steps. Once y
 
 If you want to seed your database with data on first launch, place your .sql file(s) in the "init" directory at the root of this package. MySQL will run any files in this directory the first time it launches.
 
-### Snapshot the Data Model
-
-Directus can automatically generate a snapshot of your current data model in YAML format. This includes all collections, fields, and relations, and their configuration. This snapshot can be checked in version control and shared with your team. To generate the snapshot, run:
-
-`npm run snapshot`
-
-The 'directus' container **must be running** in order to take a snapshot.
-
-### Apply a Snapshot
-
-To overwrite the current Directus instance with the data model specified in that snapshot, you can apply a snapshot by running:
-
-`npm run snapshot-apply --snapshot=snapshot-file.yaml`
-
-Change the name of the file in the command to match an actual snapshot file in your 'snapshots' directory.
-
-By applying the snapshot, Directus will auto-detect the changes required to make the current instance up to date with the proposed data model in the snapshot file, and will run the required migrations to the database to make it match the snapshot. This is useful when migrating to/from another directus instance.
-
-**It is recommended that you test this first by doing a dry-run like this:**
-
-`npm run snapshot-test --snapshot=snapshot-file.yaml`
-
 ### Starting/stopping with Docker Compose
 
 To **stop** your running containers, simply run `docker compose down` in your terminal from within the project directory. All containers will be stopped.
@@ -89,6 +67,54 @@ Adminer (for MySQL): http://localhost:8080
 
 Simply run `docker compose ps` to see the status of running containers. Or, run `docker compose ps -a` to see all containers, running or not.
 
+### NGINX Proxy example
+
+Included in this package is also a `docker-compose-nginx.yml` file that demonstrates how to run a reverse proxy on a Linux-based server so that you can use a custom domain with an auto-generated/renewed SSL certificate via Let's Encrypt.
+
+To use this, rename the existing `docker-compose.yml` file to something else, and rename the `docker-compose-nginx.yml` to `docker-compose.yml`.
+
+Add the following env variables to your `.env` file:
+
+```bash
+VIRTUAL_HOST="your-domain.com"
+CERT_EMAIL="you@email"
+```
+
+and make sure your Directus .env variables look something like this:
+
+```bash
+DIRECTUS_DOMAIN="localhost"
+DIRECTUS_PORT="8055"
+PUBLIC_URL="https://your-domain.com"
+API_ENDPOINT="https://your-domain.com/graphql"
+```
+
+Lastly, before running `npm start`, make sure you have pointed to your domain's DNS to your server using the appropriate A records.
+
+Note: you may need to adjust or disable your firewall before running this, to ensure that the SSL certificate can be properly generated using the included `acme-companion` container for Let's Encrypt.
+
+### Snapshot the Data Model
+
+Directus can automatically generate a snapshot of your current data model in YAML format. This includes all collections, fields, and relations, and their configuration. This snapshot can be checked in version control and shared with your team. To generate the snapshot, run:
+
+`npm run snapshot`
+
+The 'directus' container **must be running** in order to take a snapshot.
+
+### Apply a Snapshot
+
+To overwrite the current Directus instance with the data model specified in that snapshot, you can apply a snapshot by running:
+
+`npm run snapshot-apply --snapshot=snapshot-file.yaml`
+
+Change the name of the file in the command to match an actual snapshot file in your 'snapshots' directory.
+
+By applying the snapshot, Directus will auto-detect the changes required to make the current instance up to date with the proposed data model in the snapshot file, and will run the required migrations to the database to make it match the snapshot. This is useful when migrating to/from another directus instance.
+
+**It is recommended that you test this first by doing a dry-run like this:**
+
+`npm run snapshot-test --snapshot=snapshot-file.yaml`
+
 ### Examples of getting an auth token for Directus API:
 
 curl -X POST localhost:8055/auth/login -H 'Content-Type: application/json' -d '{"email":"you@email.com","password":"your-password"}'

package/templates/default/docker-compose-nginx.yml

@@ -0,0 +1,152 @@
+services:
+  nginx-proxy:
+    image: nginxproxy/nginx-proxy
+    container_name: nginx-proxy
+    restart: always
+    labels:
+      - com.github.nginx-proxy.nginx
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - /var/run/docker.sock:/tmp/docker.sock:ro
+      - conf:/etc/nginx/conf.d
+      - vhost:/etc/nginx/vhost.d
+      - html:/usr/share/nginx/html
+      - certs:/etc/nginx/certs:ro
+    networks: 
+      - directus
+    
+  acme-companion:
+    image: nginxproxy/acme-companion
+    container_name: nginx-proxy-acme
+    restart: always
+    depends_on:
+      - nginx-proxy
+    environment:
+      DEFAULT_EMAIL: ${ADMIN_EMAIL}
+      NGINX_PROXY_CONTAINER: nginx-proxy
+    volumes:
+      - conf:/etc/nginx/conf.d
+      - vhost:/etc/nginx/vhost.d
+      - html:/usr/share/nginx/html
+      - certs:/etc/nginx/certs:rw
+      - acme:/etc/acme.sh
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    networks: 
+      - directus
+
+  mysql:
+    container_name: mysql
+    image: mysql:9.0.1
+    restart: always
+    healthcheck: 
+      test: ['CMD', 'mysqladmin', 'ping', '--silent']
+      interval: 5s
+      timeout: 20s
+      retries: 3
+      start_period: 5s
+    networks: 
+      - directus
+    ports:
+      - 3306:3306
+    volumes:
+      - ./mysql:/var/lib/mysql
+      - ./init:/docker-entrypoint-initdb.d
+    # command: --mysql-native-password=ON
+    environment:
+      MYSQL_USER: ${MYSQL_USER}
+      MYSQL_PASSWORD: ${MYSQL_PASS}
+      MYSQL_DATABASE: ${MYSQL_DB}
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASS}
+
+  adminer:
+    container_name: adminer
+    image: adminer:latest
+    restart: always
+    depends_on:
+      mysql:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
+    networks: 
+      - directus
+    environment:
+      ADMINER_DEFAULT_SERVER: mysql
+    ports:
+      - 8080:8080
+
+  cache:
+    container_name: cache
+    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
+
+  directus:
+    container_name: directus
+    image: directus/directus:11.1.1
+    restart: always
+    ports:
+      - ${DIRECTUS_PORT}:8055
+    expose:
+      - 8055
+    volumes:
+      - ./directus/uploads:/directus/uploads
+      - ./snapshots:/directus/snapshots
+    networks:
+      - directus
+    depends_on:
+      mysql:
+        condition: service_healthy
+      cache:
+        condition: service_healthy
+    environment:
+      KEY: '255d861b-5ea1-5996-9aa3-922530ec40b1'
+      SECRET: '6116487b-cda1-52c2-b5b5-c8022c45e263'
+      DB_CLIENT: 'mysql'
+      DB_HOST: 'mysql'
+      DB_USER: ${MYSQL_USER}
+      DB_PASSWORD: ${MYSQL_PASS}
+      DB_DATABASE: ${MYSQL_DB}
+      DB_PORT: '3306'
+
+      VIRTUAL_HOST: ${VIRTUAL_HOST}
+      VIRTUAL_PORT: ${DIRECTUS_PORT}
+      LETSENCRYPT_HOST: ${VIRTUAL_HOST}
+      LETSENCRYPT_EMAIL: ${CERT_EMAIL}
+
+      CACHE_ENABLED: 'true'
+      CACHE_STORE: 'redis'
+      REDIS: 'redis://cache:6379'
+      CACHE_AUTO_PURGE: 'true'
+      CACHE_SYSTEM_TTL: '2m'
+      CACHE_SCHEMA: 'false'
+      ADMIN_EMAIL: ${ADMIN_EMAIL}
+      ADMIN_PASSWORD: ${ADMIN_PASSWORD}
+      CORS_ENABLED: 'true'
+      CORS_ORIGIN: 'true'
+
+      # 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}
+
+      PUBLIC_URL: ${PUBLIC_URL}
+
+networks:
+  directus:
+    driver: bridge
+volumes:
+    conf:
+    vhost:
+    html:
+    certs:
+    acme:

package/templates/default/env-sample.txt

@@ -0,0 +1,31 @@
+# This is a sample .env file with all possible options
+
+# Email and password to login to Directus:
+ADMIN_EMAIL="you@email"
+ADMIN_PASSWORD="s0mEpa55w0rd"
+
+# Define the mysql user name and password:
+MYSQL_USER="admin"
+MYSQL_PASS="s0mEpa55w0rd"
+
+# Give your database a name:
+MYSQL_DB="directus"
+
+# Set a root password for MySQL to something secure:
+MYSQL_ROOT_PASS="s0mEpa55w0rd"
+
+# Set the domain for directus to use:
+# eg, https://mydomain.com
+# in local dev environments, just leave it set to localhost:port
+DIRECTUS_DOMAIN="localhost"
+DIRECTUS_PORT="8055"
+PUBLIC_URL="https://your-domain.com"
+API_ENDPOINT="https://your-domain.com/graphql"
+
+EMAIL_TRANSPORT="sendgrid"
+EMAIL_SENDGRID_API_KEY="your-send-grid-api-key"
+EMAIL_FROM="you@email"
+
+# for use with the nginx proxy version:
+VIRTUAL_HOST="your-domain.com"
+CERT_EMAIL="you@email"