Docker

You can install ClientXCMS via Docker by following the steps below.

Prerequisites

Before you begin, make sure you have the following:

• A server with Docker and Docker Compose installed. You can follow the installation instructions for:
  • Docker
  • Docker Compose
• A domain name pointing to your server.

Run the following commands to install Docker and Docker Compose on an Ubuntu server:

docker compose build

docker compose up -d

Installation

1. Create a directory for ClientXCMS and navigate to it:

mkdir /var/www
cd /var/www

2. Clone the ClientXCMS Git repository:

git clone https://github.com/ClientXCMS/clientxcms.git
cd clientxcms

3. Copy the example Docker Compose configuration file:

cp docker-compose.example.yml docker-compose.yml

4. Edit the environment file to configure the necessary variables, including the database connection and domain name:

cp .env.example .env
nano .env

You can modify variables such as the domain:

APP_URL=https://your-domain.com
OAUTH_CLIENT_ID="XX"
OAUTH_CLIENT_SECRET="XX"

As well as your API keys, database connection, etc.

Docker will generate the SSL certificate via Let's Encrypt automatically by adding the email in the docker-compose.yml file:

- [email protected]

5. Launch the Docker containers:

docker-compose up --build -d

6. Add an administrator account:

docker exec -it clientxcms_app-1 php artisan clientxcms:install-admin

7. Access your domain name in a web browser to complete the installation by confirming license access.