Skip to content

[READONLY] A default elasticms local setup using docker-compose

License

Notifications You must be signed in to change notification settings

ems-project/elasticms-demo

Repository files navigation

Elasticms demo

A demo elasticms local setup with docker compose.

TL;DR

Open a terminal and run the following commands:

make start
make status ## wait about a minute until elasticms_demo-web-local-1 is healthy
make init

Links

  • Traefik : An HTTP reverse proxy
  • mailhog : A Mail catcher
  • kibana : A dev tools to query elasticsearch
  • elasticsearch : The search engine, Verify that the status is green
  • minio : A S3 like storage service
  • elasticms admin : elasticms
  • Test the website:
    • preview : skeleton with preview's contents
    • live : skeleton with live's contents
  • Debug issue with varnish:
    • preview nocache : skeleton with preview's contents without cache (varnish is bypassed)
    • live nocache : skeleton with live's contents without cache (varnish is bypassed)

MakeFile

Run make for retrieving information about all make targets.

  • Create a new user cli
    make admin/"emsco:user:create"
  • Show all available commands for web and/or admin
    make admin/"list"
    make web/"list"
  • Run npm command
    make npm/"list"
    make npm/"install <package_name>"

Troubleshooting

  • The labels are not translated in the skeleton:

    clear the cache for the corresponding skeleton i.e. make cache-clear

  • Form submissions are not visible in the elasticms mini-CRM:

    Generate a .env.local and this EMSF_AUTHKEY=AUTH_KEY with a authkey that you can generate in the user datatable view and run make restart

  • I want to use a different ELK stack version

    If you want to use elasticsearch 8 instead of elasticsearch 7, define this variable first:

    export ELK_VERSION=elk8

    Available stacks:

    • elk7: elasticsearch 7.17.7
    • elk8: elasticsearch 8.5.3
    • os2: OpenSearch 2.4.1

Requirements

You need docker compose (or an alternative as Podman) on a running Linux system (or WSL if you are under Windows). It should also work with Docker Desktop, tell us if you face issues with it.

It's recommended to allow at least 6GB of memory to docker.

The following ports must be available:

  • 8888: Traefik UI
  • 80: Web HTTP
  • 443: Web HTTPS

Resources