maze
  • Introduction
  • Getting Started
    • Quick Start
  • Guides
    • Overview
    • Installation
    • Create New App
    • Directory Structure
    • Configuration
    • Docker
    • Controllers
      • Sessions
      • Request & Response Objects
      • Halt!
      • Respond With
      • Params Validation
      • Cookies
      • Filters
      • Flash
      • Redirection
    • Views
      • View Helpers
    • Models
      • Granite
        • Granite's README
        • Migrations
        • Validations
        • Callbacks
        • Associations
        • Querying
        • Bulk Insertions
      • Crecto
        • Crecto's README
      • Jennifer
        • Jennifer Docs
        • Migrations
        • Models
    • Routing
      • Pipelines
      • Routes
    • Websockets
      • Channels
      • Sockets
      • JavaScript Client
    • Mailers
      • Deliver a new Email
  • Testing
    • System Tests
  • Deployment
    • Digital Ocean
    • Heroku
  • CLI
    • New
    • Recipes
    • Generate
    • Database
    • Watch
    • Routes
    • Exec
    • Encrypt
    • Deploy
  • Examples
    • Maze Auth
    • Crystal Debug
    • Minimal Configuration
  • Troubleshooting
  • Contributing
  • Code of Conduct
  • HAVE A QUESTION?
    • Ask on Gitter
    • Ask on StackOverflow
    • Follow on Twitter
    • Submit an issue
Powered by GitBook
On this page
  • Dockerfile
  • docker-compose.yml
  • The database container
  • The mailcatcher container
  • The migrate container
  • The app container
  • The web container
  • Usage
  1. Guides

Docker

PreviousConfigurationNextControllers

Last updated 6 years ago

When you generate a new Maze project, we include Docker and docker-compose.yml files to simplify development. This is an alternative way of getting an Maze project up and running quickly and doesn't require installing a database.

Dockerfile

The Docker file will have everything you need to build and run your maze project. This includes all needed the libraries, Nodejs, Crystal and Maze command line tools. It starts from the official crystallang/crystal:{version} docker image.

It will also add the project to the /app folder on the image so you can use this in production as well.

docker-compose.yml

The docker-compose.yml file will allow you to easily get up and running. It includes the database, mailcatcher, migrate, app, and web containers.

The database container

This container is using an image based on the -d option you chose when you created the project. Right now, we support pg, mysql, sqlite

A db volume is also created so you can start and stop the containers but the data will still be available.

The mailcatcher container

Mail Catcher is a simple smtp server that will allow you to see the email that gets generated. You can access the user interface by hitting . If you generate mailers, it will configure the SMTP_URL to point to the mail catcher container.

The migrate container

This container will run the migrations using maze db migrate seed. It will wait for the database port to be available before running the migrations. This container will exit after completing the migrations.

The app container

The web container

This container will run npm install && npm run watch. This will compile your front-end assets and will watch for changes. You can see the webpack configuration in the config/webpack directory to see what assets are compiled.

Usage

You can launch the docker-compose environment by running:

docker-compose up

Once all the docker containers are launched, you can access the site using:

open http://localhost:3000

And you can access the mailcatcher at:

open http://localhost:1080

This container will run maze watch on port 3000. You can access the application at . The external project directory is mapped to /app/local so as you make changes to your project and maze will watch for changes, recompile and re-launch the application.

http://localhost:1080
http://localhost:3000