Portainer Templates logo

Portainer Templates

Easy!Appointments Easy!Appointments

Stack

ProductivityTools

Online booking site for appointments: customers pick a service, a provider and a free slot, and you manage it all from a calendar with working hours, breaks and holidays per provider. Syncs with Google or CalDAV calendars. Source: https://github.com/alextselegidis/easyappointments

Source details

Stars: 4k
Forks: 2k
Language: PHP
License: GPL-3.0
Updated: 2 days ago

Configuration

Type
Compose
Platform
linux
Env vars
EASYAPPOINTMENTS_URL=''EASYAPPOINTMENTS_DB_PASSWORD=''EASYAPPOINTMENTS_PORT=8580
Restart
unless-stopped
Source

Notes

Fill in the address and database password before you deploy, since the stack won't start without them. The address has to be exactly what you'll type in the browser, like http://192.168.1.20:8580: the port you're using, and no slash at the end. Easy!Appointments builds every page and link from it, so if it's wrong the front page sends you off to that address instead, and any page you do reach has no styling and buttons that do nothing. To fix it, change the address in the stack's environment variables and redeploy. Then open /index.php/installation on that address straight away, as whoever fills in that form first becomes the admin. Go there directly: once it's been opened, the front page says Database Migration Required until the install's done. It adds a sample service, provider and customer, so rename or delete those first. Customers book at the address itself, and you log in at /index.php/login. Nothing gets emailed until you add EASYAPPOINTMENTS_SMTP_HOST, EASYAPPOINTMENTS_SMTP_USER and EASYAPPOINTMENTS_SMTP_PASSWORD to the stack's environment variables and update the stack (plus EASYAPPOINTMENTS_SMTP_PORT if it isn't 587, and EASYAPPOINTMENTS_SMTP_SECURITY = ssl for port 465). Emails come from the company email you set at install. Everything lives in MariaDB, in the db-data volume, with logins and backups in easyappointments-storage. Docs: github.com/alextselegidis/easyappointments

Services

easyappointments

Configuration

Image
alextselegidis/easyappointments:latest
Ports
${EASYAPPOINTMENTS_PORT:-8580}:80
Volumes
/var/www/html/storage : easyappointments-storage
Env vars
BASE_URL=${EASYAPPOINTMENTS_URL:?Set the address you'll open it on}DB_HOST=dbDB_NAME=easyappointmentsDB_USERNAME=easyappointmentsDB_PASSWORD=${EASYAPPOINTMENTS_DB_PASSWORD:?Set a database password}MAIL_PROTOCOL=${EASYAPPOINTMENTS_SMTP_HOST:+smtp}MAIL_SMTP_HOST=${EASYAPPOINTMENTS_SMTP_HOST:-}MAIL_SMTP_PORT=${EASYAPPOINTMENTS_SMTP_PORT:-587}MAIL_SMTP_USER=${EASYAPPOINTMENTS_SMTP_USER:-}MAIL_SMTP_PASS=${EASYAPPOINTMENTS_SMTP_PASSWORD:-}MAIL_SMTP_AUTH=1MAIL_SMTP_CRYPTO=${EASYAPPOINTMENTS_SMTP_SECURITY:-}
Restart
unless-stopped

Image details

Pulls: 139k
User: alextselegidis
Created: Nov 22, 2021
Updated: 2 days ago
Status: active

db

Configuration

Image
mariadb:11.4
Volumes
/var/lib/mysql : db-data
Env vars
MARIADB_DATABASE=easyappointmentsMARIADB_USER=easyappointmentsMARIADB_PASSWORD=${EASYAPPOINTMENTS_DB_PASSWORD:?Set a database password}MARIADB_RANDOM_ROOT_PASSWORD=1
Restart
unless-stopped

Image details

Pulls: 3.2B
User: stackbrew
Created: Nov 25, 2014
Updated: 3 hours ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Easy!Appointments

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Easy!Appointments, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  easyappointments:
    image: alextselegidis/easyappointments:latest
    restart: unless-stopped
    ports:
      - "${EASYAPPOINTMENTS_PORT:-8580}:80"
    environment:
      BASE_URL: ${EASYAPPOINTMENTS_URL:?Set the address you'll open it on}
      DB_HOST: db
      DB_NAME: easyappointments
      DB_USERNAME: easyappointments
      DB_PASSWORD: ${EASYAPPOINTMENTS_DB_PASSWORD:?Set a database password}
      MAIL_PROTOCOL: ${EASYAPPOINTMENTS_SMTP_HOST:+smtp}
      MAIL_SMTP_HOST: ${EASYAPPOINTMENTS_SMTP_HOST:-}
      MAIL_SMTP_PORT: ${EASYAPPOINTMENTS_SMTP_PORT:-587}
      MAIL_SMTP_USER: ${EASYAPPOINTMENTS_SMTP_USER:-}
      MAIL_SMTP_PASS: ${EASYAPPOINTMENTS_SMTP_PASSWORD:-}
      MAIL_SMTP_AUTH: "1"
      MAIL_SMTP_CRYPTO: ${EASYAPPOINTMENTS_SMTP_SECURITY:-}
    volumes:
      - easyappointments-storage:/var/www/html/storage
    depends_on:
      db:
        condition: service_healthy

  db:
    image: mariadb:11.4
    restart: unless-stopped
    environment:
      MARIADB_DATABASE: easyappointments
      MARIADB_USER: easyappointments
      MARIADB_PASSWORD: ${EASYAPPOINTMENTS_DB_PASSWORD:?Set a database password}
      MARIADB_RANDOM_ROOT_PASSWORD: "1"
    volumes:
      - db-data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
      interval: 5s
      timeout: 5s
      retries: 20

volumes:
  easyappointments-storage:
  db-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/easy-appointments/compose.yml up -d

More install options in our documentation, or see alextselegidis/easyappointments for app-specific guidance.

Container Documentation

easyappointments Documentation

Easy!Appointments is a widely used, open source, online appointment scheduler application.

db Documentation

MariaDB Server is a high performing open source relational database, forked from MySQL.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Image won't pull

Test the pull directly on the host: docker pull alextselegidis/easyappointments:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Easy!Appointments is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • easyappointments runs alextselegidis/easyappointments:latest, starts after db
  • db runs mariadb:11.4

Volumes

A volume is where Easy!Appointments keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/www/html/storage kept in the easyappointments-storage volume Docker manages
  • /var/lib/mysql kept in the db-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Easy!Appointments takes 16 of them, and 3 need a value before it'll start properly:

  • BASE_URL, needs a value
  • DB_HOST, defaults to db
  • DB_NAME, defaults to easyappointments
  • DB_USERNAME, defaults to easyappointments
  • DB_PASSWORD, needs a value
  • MAIL_PROTOCOL, pulled from your own environment
  • MAIL_SMTP_HOST, pulled from your own environment
  • MAIL_SMTP_PORT, defaults to 587
  • MAIL_SMTP_USER, pulled from your own environment
  • MAIL_SMTP_PASS, pulled from your own environment
  • MAIL_SMTP_AUTH, defaults to 1
  • MAIL_SMTP_CRYPTO, pulled from your own environment
  • MARIADB_DATABASE, defaults to easyappointments
  • MARIADB_USER, defaults to easyappointments
  • MARIADB_PASSWORD, needs a value
  • MARIADB_RANDOM_ROOT_PASSWORD, defaults to 1

Restart policy

The restart policy here is unless-stopped, so Docker restarts Easy!Appointments after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like easyappointments) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Easy!Appointments is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Easy!Appointments up. Add the template list to Portainer once, then deploying Easy!Appointments is a click rather than a wall of config.