alextselegidis/clientverse repository overview

⁠
⁠
Clientverse Docker

⁠ A powerful Open Source CRM application that can be installed on your server.

About⁠ • Features⁠ • Setup⁠ • Environment Variables⁠ • License⁠

⁠About

Clientverse is a CRM (Customer Relationship Management) application, designed for simplicity and efficiency. It lets you manage your clients, contacts, and deals, track interactions, and organize your sales pipeline. You can also add notes to your records and view reports of your business activities.

This Docker image is built on PHP 8.2 with Apache and is designed to run the Laravel-based Clientverse application. On container startup, the entrypoint script automatically generates the Laravel .env file from Docker environment variables, runs database migrations, and caches the configuration for optimal performance.

⁠Features

The application allows you to manage and organize your client relationships.

• Clean & minimal interface
• Tagging & search
• Self-hosted (Docker support)
• Multi-user capable (future/planned)
• No tracking / no ads

⁠Setup

To clone and run this application, you'll need Docker⁠ installed on your computer. From your command line:

# Start a MySQL instance
docker run -d --name clientverse-db \
  -e MYSQL_ROOT_PASSWORD=secret \
  -e MYSQL_DATABASE=clientverse \
  mysql:8.0

# Pull and run the app
docker run -d --name clientverse-app \
  --link clientverse-db:db \
  -p 80:80 \
  -e APP_URL=http://localhost \
  -e DB_HOST=db \
  -e DB_DATABASE=clientverse \
  -e DB_USERNAME=root \
  -e DB_PASSWORD=secret \
  alextselegidis/clientverse:latest

⁠Docker Compose

You can use the following docker-compose.yml file to locally set up Clientverse with a MySQL database:

services:

  clientverse:
    image: alextselegidis/clientverse:latest
    restart: always
    ports:
      - '80:80'
    environment:
      - APP_NAME=Clientverse
      - APP_ENV=production
      - APP_DEBUG=false
      - APP_URL=http://localhost
      - DB_CONNECTION=mysql
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_DATABASE=clientverse
      - DB_USERNAME=root
      - DB_PASSWORD=secret
      - MAIL_MAILER=smtp
      - MAIL_HOST=smtp.example.org
      - MAIL_PORT=587
      - MAIL_USERNAME=
      - MAIL_PASSWORD=
      - MAIL_ENCRYPTION=tls
      - [email protected]
      - MAIL_FROM_NAME=Clientverse
    volumes:
      - clientverse-storage:/var/www/html/storage

  mysql:
    image: mysql:8.0
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=secret
      - MYSQL_DATABASE=clientverse
    volumes:
      - mysql:/var/lib/mysql

volumes:
  clientverse-storage:
  mysql:

⁠Environment Variables

The Docker image uses standard Laravel environment variables. All variables are passed through to the .env file that is generated on container startup.

⁠Application

⁠Logging

⁠Database

⁠Cache & Session

⁠Redis

⁠Mail

⁠Startup Behavior

On every container start the entrypoint script will:

1. Generate the Laravel .env file from the Docker environment variables.
2. Set correct permissions on storage/ and bootstrap/cache/.
3. Auto-generate an APP_KEY if one was not provided.
4. Run php artisan migrate --force to apply pending database migrations.
5. Create the storage:link symbolic link.
6. Cache configuration, routes, and views for performance.
7. Start the Apache web server.

⁠License

Code Licensed Under GPL v3.0⁠ | Content Under CC BY 3.0⁠

Website alextselegidis.com⁠  ·  GitHub alextselegidis⁠  ·  Twitter @alextselegidis⁠