/SuiteCRM8-docker

Unofficial and unaffiliated SuiteCRM 8 container. Highly experimental and occasionally broken. If you break it, please raise an issue and keep all the pieces by yourself.

Primary LanguageShellOtherNOASSERTION

SuiteCRM 8 image

General information

This is an unnaffiliated project without links or input from SalesAgility Inc, which holds trademarked rights to the SuiteCRM brand.

This repository contains source code of the SuiteCRM 8's unofficial container image. The image is built from the official upstream source code. There are minor replacements to the official source code to make it more container-friendly (see below).

There is no guaranteed support. If you don't know how to run this or break it while running, you get to keep the pieces. I'm only running this since an official SuiteCRM container doesn't exist.

This is still very much experimental, and might break at any point. Contributions are welcome, but might ultimately not get included. I'm trying to keep the application as close to upstream source as possible and only replace or add to the codebase at container level if necessary for configuring the container. If you want to make more invasive changes, I suggest using this as parent image.

This image does nothing alone. You'll need to provide a database and possibly reverse proxy or web server. If you want a more complete solution, use the Helm chart (see below) or the included docker composer file (work-in-progress).

Changes to vanilla source code

Nothing yet.

Installation and usage

This image only builds the SuiteCRM application and servers it, depending on your target stage, either with php-fpm or apache2.

For apache2 images, you must provide a database and port forwarding. The image only exposes port 80, so it is highly recommended to run a reverse proxy with TLS termination in front of it.

For php-fpm images, this image will provide php-fpm and the app filesystem. In addition to external database, you need to configure a web server with pass-through of php to the fpm of this container.

You must provide the image with the following environment variables:

DATABASE_NAME: The name of database in the external db server.
DATABASE_USER: The username on the external db server.
DATABASE_PASSWORD: The password for the external db server.
DATABASE_SERVER: The hostname for the external db server.
SUITECRM_SITEURL: The URL to access the application.

In addition to the mandatory environment variables there are some optional ones: ADMIN_USER: SuiteCRM administrator username (only relevant when installing) ADMIN_PASSWORD: SuiteCRM administrator password (only relevant when installing)

If you don't set optional values, the values will be randomized and printed to container log.

Helm chart?!

There is an automatically updated Helm chart deploying this container (as php-fpm) with necessary friends.

License

Both SuiteCRM 8 and this image are licensed under AGPL3:

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.