mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-04-28 18:30:24 +02:00
Implemented espocrm draft
This commit is contained in:
parent
79d6a68dc1
commit
edf2be504c
@ -10,6 +10,7 @@ defaults_domains:
|
|||||||
bluesky_web: "bskyweb.{{primary_domain}}"
|
bluesky_web: "bskyweb.{{primary_domain}}"
|
||||||
discourse: "forum.{{primary_domain}}"
|
discourse: "forum.{{primary_domain}}"
|
||||||
elk: "elk.{{primary_domain}}"
|
elk: "elk.{{primary_domain}}"
|
||||||
|
espocrm: "espocrm.{{primary_domain}}"
|
||||||
file_server: "files.{{primary_domain}}"
|
file_server: "files.{{primary_domain}}"
|
||||||
friendica: "friendica.{{primary_domain}}"
|
friendica: "friendica.{{primary_domain}}"
|
||||||
funkwhale: "music.{{primary_domain}}"
|
funkwhale: "music.{{primary_domain}}"
|
||||||
@ -55,6 +56,7 @@ defaults_redirect_domain_mappings:
|
|||||||
- { source: "akaunting.{{primary_domain}}", target: "{{domains.akaunting}}" }
|
- { source: "akaunting.{{primary_domain}}", target: "{{domains.akaunting}}" }
|
||||||
- { source: "bbb.{{primary_domain}}", target: "{{domains.bigbluebutton}}" }
|
- { source: "bbb.{{primary_domain}}", target: "{{domains.bigbluebutton}}" }
|
||||||
- { source: "discourse.{{primary_domain}}", target: "{{domains.discourse}}" }
|
- { source: "discourse.{{primary_domain}}", target: "{{domains.discourse}}" }
|
||||||
|
- { source: "crm.{{primary_domain}}", target: "{{domains.espocrm}}" }
|
||||||
- { source: "funkwhale.{{primary_domain}}", target: "{{domains.funkwhale}}" }
|
- { source: "funkwhale.{{primary_domain}}", target: "{{domains.funkwhale}}" }
|
||||||
- { source: "gitea.{{primary_domain}}", target: "{{domains.gitea}}" }
|
- { source: "gitea.{{primary_domain}}", target: "{{domains.gitea}}" }
|
||||||
- { source: "keycloak.{{primary_domain}}", target: "{{domains.keycloak}}" }
|
- { source: "keycloak.{{primary_domain}}", target: "{{domains.keycloak}}" }
|
||||||
|
@ -53,6 +53,7 @@ ports:
|
|||||||
phpldapadmin: 8037
|
phpldapadmin: 8037
|
||||||
fusiondirectory: 8038
|
fusiondirectory: 8038
|
||||||
presentation: 8039
|
presentation: 8039
|
||||||
|
espocrm: 8040
|
||||||
bigbluebutton: 48087 # This port is predefined by bbb. @todo Try to change this to a 8XXX port
|
bigbluebutton: 48087 # This port is predefined by bbb. @todo Try to change this to a 8XXX port
|
||||||
# Ports which are exposed to the World Wide Web
|
# Ports which are exposed to the World Wide Web
|
||||||
public:
|
public:
|
||||||
|
@ -80,6 +80,8 @@ defaults_networks:
|
|||||||
subnet: 192.168.103.32/28
|
subnet: 192.168.103.32/28
|
||||||
presentation:
|
presentation:
|
||||||
subnet: 192.168.103.48/28
|
subnet: 192.168.103.48/28
|
||||||
|
espocrm:
|
||||||
|
subnet: 192.168.103.64/28
|
||||||
|
|
||||||
# /24 Networks / 254 Usable Clients
|
# /24 Networks / 254 Usable Clients
|
||||||
bigbluebutton:
|
bigbluebutton:
|
||||||
|
32
roles/docker-espocrm/Administration.md
Normal file
32
roles/docker-espocrm/Administration.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Administration
|
||||||
|
|
||||||
|
## 🗑️ Cleanup (Remove instance & volumes)
|
||||||
|
```bash
|
||||||
|
cd {{path_docker_compose_instances}}espocrm/
|
||||||
|
docker compose down
|
||||||
|
# EspoCRM keeps all uploaded files in the *data* volume
|
||||||
|
docker volume rm espocrm_data espocrm_database
|
||||||
|
cd {{path_docker_compose_instances}} && rm -vR {{path_docker_compose_instances}}espocrm
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔍 Access EspoCRM container shell
|
||||||
|
```bash
|
||||||
|
docker compose exec -it web /bin/bash
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🛠️ Database migrations (after image upgrade)
|
||||||
|
EspoCRM applies migrations automatically on start‑up. To run them manually:
|
||||||
|
```bash
|
||||||
|
docker compose exec -it web php command.php upgrade
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🗄️ Backup database
|
||||||
|
```bash
|
||||||
|
# Dump the MySQL/MariaDB database
|
||||||
|
docker exec espocrm_database /usr/bin/mysqldump -u root -p$MYSQL_ROOT_PASSWORD espocrm > backup_$(date +%F).sql
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🧹 Clear cache
|
||||||
|
```bash
|
||||||
|
docker compose exec web php command.php clear cache
|
||||||
|
```
|
25
roles/docker-espocrm/Installation.md
Normal file
25
roles/docker-espocrm/Installation.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
# ⚙️ Configuration & Setup
|
||||||
|
|
||||||
|
## 🔧 Create credentials & pull image
|
||||||
|
```bash
|
||||||
|
# Pull the latest EspoCRM image
|
||||||
|
docker pull espocrm/espocrm:latest
|
||||||
|
|
||||||
|
# If you need to pre‑create a config file, copy the default
|
||||||
|
# (the container will generate one automatically on first start)
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🏗️ Initial deployment with Docker Compose
|
||||||
|
```bash
|
||||||
|
# Change into the instance directory created by the role
|
||||||
|
cd {{path_docker_compose_instances}}espocrm/
|
||||||
|
|
||||||
|
# Launch the stack
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
The first start can take a minute while EspoCRM initialises the database schema.
|
||||||
|
|
||||||
|
## 🔐 LDAP & OIDC authentication
|
||||||
|
Both mechanisms are supported out of the box:
|
||||||
|
- **LDAP:** Configure under *Administration → Authentication → LDAP* after the first login.
|
||||||
|
- **OIDC:** Configure under *Administration → Authentication → OpenID Connect* and paste the Issuer URL, Client ID and Client Secret from your IdP (Keycloak, Authentik, Entra ID, …).
|
16
roles/docker-espocrm/README.md
Normal file
16
roles/docker-espocrm/README.md
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
# EspoCRM
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
EspoCRM is a lightweight, open‑source Customer Relationship Management platform that helps you manage leads, accounts, opportunities and post‑sale support in a single, web‑based interface.
|
||||||
|
This Ansible role deploys EspoCRM with Docker, mirroring the structure of the Mastodon role for a consistent operations workflow.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
- **Sales Pipeline & Activities Stream** – track every interaction and schedule follow‑ups.
|
||||||
|
- **Workflow & BPM** – automate routine tasks and notifications.
|
||||||
|
- **Extensible Authentication** – native LDAP and OpenID Connect (OIDC) login support.
|
||||||
|
- **Containerised Architecture** – separate services for the web application, cron jobs and an upstream MySQL/MariaDB database.
|
||||||
|
|
||||||
|
For detailed instructions see:
|
||||||
|
- [Installation.md](./Installation.md)
|
||||||
|
- [Administration.md](./Administration.md)
|
2
roles/docker-espocrm/Todo.md
Normal file
2
roles/docker-espocrm/Todo.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Todos
|
||||||
|
- Finish draft implementation
|
22
roles/docker-espocrm/meta/main.yml
Normal file
22
roles/docker-espocrm/meta/main.yml
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
galaxy_info:
|
||||||
|
author: "Kevin Veen-Birkenbach"
|
||||||
|
description: "EspoCRM is an open‑source CRM with workflow automation, LDAP/OIDC SSO and a lightweight UI"
|
||||||
|
license: "CyMaIS NonCommercial License (CNCL)"
|
||||||
|
license_url: "https://s.veen.world/cncl"
|
||||||
|
company: |
|
||||||
|
Kevin Veen-Birkenbach
|
||||||
|
Consulting & Coaching Solutions
|
||||||
|
https://www.veen.world
|
||||||
|
galaxy_tags:
|
||||||
|
- espocrm
|
||||||
|
- crm
|
||||||
|
- docker
|
||||||
|
- sales
|
||||||
|
- ldap
|
||||||
|
- oidc
|
||||||
|
repository: "https://s.veen.world/cymais"
|
||||||
|
issue_tracker_url: "https://s.veen.world/cymaisissues"
|
||||||
|
documentation: "https://s.veen.world/cymais"
|
||||||
|
logo:
|
||||||
|
class: "fa-solid fa-briefcase"
|
||||||
|
dependencies: []
|
17
roles/docker-espocrm/tasks/main.yml
Normal file
17
roles/docker-espocrm/tasks/main.yml
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
- name: "include docker-central-database"
|
||||||
|
include_role:
|
||||||
|
name: docker-central-database
|
||||||
|
|
||||||
|
- name: "copy docker-compose.yml and env file"
|
||||||
|
include_tasks: copy-docker-compose-and-env.yml
|
||||||
|
|
||||||
|
- name: flush docker service
|
||||||
|
meta: flush_handlers
|
||||||
|
when: applications.espocrm.setup | bool
|
||||||
|
|
||||||
|
- name: "run database setup / upgrade"
|
||||||
|
command:
|
||||||
|
cmd: "docker compose run --rm web php command.php upgrade"
|
||||||
|
chdir: "{{ docker_compose.directories.instance }}"
|
||||||
|
when: applications.espocrm.setup | bool
|
39
roles/docker-espocrm/templates/docker-compose.yml.j2
Normal file
39
roles/docker-espocrm/templates/docker-compose.yml.j2
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
services:
|
||||||
|
|
||||||
|
{% include 'roles/docker-central-database/templates/services/' + database_type + '.yml.j2' %}
|
||||||
|
|
||||||
|
web:
|
||||||
|
image: espocrm/espocrm:{{ applications.espocrm.version }}
|
||||||
|
{% include 'roles/docker-compose/templates/services/base.yml.j2' %}
|
||||||
|
environment:
|
||||||
|
- DATABASE_HOST={{ database_host }}
|
||||||
|
- DATABASE_PORT={{ database_port }}
|
||||||
|
- DATABASE_NAME={{ database_name }}
|
||||||
|
- DATABASE_USER={{ database_username }}
|
||||||
|
- DATABASE_PASSWORD={{ database_password }}
|
||||||
|
- CRON=disable # cron handled by separate service
|
||||||
|
command: apache2-foreground
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "curl", "-f", "http://localhost/" ]
|
||||||
|
ports:
|
||||||
|
- "127.0.0.1:{{ ports.localhost.http[application_id] }}:80"
|
||||||
|
{% include 'templates/docker/container/depends-on-database.yml.j2' %}
|
||||||
|
{% include 'templates/docker/container/networks.yml.j2' %}
|
||||||
|
volumes:
|
||||||
|
- data:/var/www/html
|
||||||
|
|
||||||
|
cron:
|
||||||
|
image: espocrm/espocrm:{{ applications.espocrm.version }}
|
||||||
|
command: /usr/local/bin/cron.sh
|
||||||
|
restart: unless-stopped
|
||||||
|
{% include 'templates/docker/container/depends-on-database.yml.j2' %}
|
||||||
|
volumes:
|
||||||
|
- data:/var/www/html
|
||||||
|
{% include 'templates/docker/container/networks.yml.j2' %}
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "pgrep", "cron"]
|
||||||
|
|
||||||
|
{% include 'templates/docker/compose/volumes.yml.j2' %}
|
||||||
|
data:
|
||||||
|
|
||||||
|
{% include 'templates/docker/compose/networks.yml.j2' %}
|
38
roles/docker-espocrm/templates/env.j2
Normal file
38
roles/docker-espocrm/templates/env.j2
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
# EspoCRM environment
|
||||||
|
# Database connection
|
||||||
|
DATABASE_HOST={{ database_host }}
|
||||||
|
DATABASE_PORT={{ database_port }}
|
||||||
|
DATABASE_NAME={{ database_name }}
|
||||||
|
DATABASE_USER={{ database_username }}
|
||||||
|
DATABASE_PASSWORD={{ database_password }}
|
||||||
|
|
||||||
|
# SMTP settings (example)
|
||||||
|
SMTP_HOST={{ system_email.host }}
|
||||||
|
SMTP_PORT={{ system_email.port }}
|
||||||
|
SMTP_USER={{ users['no-reply'].email }}
|
||||||
|
SMTP_PASS={{ users['no-reply'].mailu_token }}
|
||||||
|
SMTP_SECURE=tls
|
||||||
|
|
||||||
|
###################################
|
||||||
|
# LDAP settings (optional)
|
||||||
|
###################################
|
||||||
|
{% if applications[application_id].features.ldap | bool %}
|
||||||
|
LDAP_ENABLED=true
|
||||||
|
LDAP_HOST={{ ldap.server.domain }}
|
||||||
|
LDAP_PORT={{ ldap.server.port }}
|
||||||
|
LDAP_BASE_DN={{ ldap.dn.users }}
|
||||||
|
LDAP_BIND_DN={{ ldap.dn.administrator }}
|
||||||
|
LDAP_BIND_PASSWORD={{ ldap.bind_credential }}
|
||||||
|
LDAP_UID_ATTRIBUTE={{ ldap.attributes.user_id }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
###################################
|
||||||
|
# OpenID Connect (OIDC) settings (optional)
|
||||||
|
###################################
|
||||||
|
{% if applications[application_id].features.oidc | bool %}
|
||||||
|
OIDC_ENABLED=true
|
||||||
|
OIDC_ISSUER_URL={{ oidc.client.issuer_url }}
|
||||||
|
OIDC_CLIENT_ID={{ oidc.client.id }}
|
||||||
|
OIDC_CLIENT_SECRET={{ oidc.client.secret }}
|
||||||
|
OIDC_REDIRECT_URI=https://{{ domains[application_id] }}/oidc/callback
|
||||||
|
{% endif %}
|
5
roles/docker-espocrm/vars/main.yml
Normal file
5
roles/docker-espocrm/vars/main.yml
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
application_id: "espocrm"
|
||||||
|
# Password for the espocrm DB user (taken from inventory applications dict)
|
||||||
|
database_password: "{{ applications[application_id].credentials.database.password }}"
|
||||||
|
# EspoCRM uses MySQL/MariaDB
|
||||||
|
database_type: "mysql"
|
Loading…
x
Reference in New Issue
Block a user