Installation

Install Using Composer

To install UnoPim using Composer, use the following steps:

Choose the directory where you want to install UnoPim. Open your terminal and navigate to this directory.
If you have downloaded the zip file from the Git repository, extract the files into your desired directory and run the following command to set up the project:
sh
```
composer create-project
```
Otherwise, to directly install UnoPim, run the following command in your terminal:
sh
```
composer create-project unopim/unopim
```

Run the following command to complete the installation:

php artisan unopim:install

WARNING

During the installation process, if the .env file doesn't exist, the installer will prompt you to provide the necessary information.

Follow the prompts during the installation process to provide the following details:

- Please Enter the APP URL :
- Please Enter the Application Name :
- Please select the default locale :
- Please enter the default currency :
- Please choose the Allowed Locales for your channels :
- Please choose the Allowed Currencies for your channels :
- Please select the Database Connection :
- Please enter the Database Host :
- Please enter the Database Port Number :
- Please enter the Database Name :
- Please enter the Database Prefix :
- Please enter the Database Username :
- Please enter the Database Password :

For Create your admin credentials:

- Enter the Name of Admin User :
- Enter the Email address of the Admin User :
- Configure the Password for admin user :

Install Using Docker

Prerequisites

Make sure the following are installed on your system:

Docker (latest version)
Docker Compose (for Method 2)

Verify installation:

bash

docker --version
docker-compose --version

Method 1: Using Docker Hub (Quick Setup - Recommended)

This is the fastest way to get UnoPim running.

Step 1: Pull UnoPim Docker Image

bash

docker pull webkul/unopim:v0.3.2

Step 2: Run the Container

bash

docker run -it -d --name unopim_container -p 80:80 webkul/unopim:v0.3.2

If port 80 is already in use, you can map to another port (e.g. 8082):

bash

# Stop the container if it is already running
docker stop unopim_container

# Remove the container so you can recreate it cleanly
docker rm unopim_container

# Run a new container on port 8082 instead of 80
docker run -it -d --name unopim_container -p 8082:80 webkul/unopim:v0.3.2

Then access UnoPim at: http://localhost:8082

Step 3: Access UnoPim

Open your browser and visit: http://localhost

Default Admin Credentials (for UnoPim v0.3.2 and newer):

Version Range	Username	Password
v0.3.2 (Latest)	`admin@example.com`	admin123
v0.3.0 – v0.3.1	`admin@example.com`	admin@123
v0.2.x and below	`johndoe@example.com`	JohnDoe@123

Database Connection (Optional)

Key	Value
Database Name	`unopim_db`
Username	`root`
Password	`root`

Method 2: Using Docker Compose (For Customization)

This method is ideal if you want more control over your UnoPim environment (custom ports, volumes, etc.).

Step 1: Clone Repository

Clone the official UnoPim repository:

HTTPS:

bash

git clone https://github.com/unopim/unopim.git

SSH:

bash

git clone git@github.com:unopim/unopim.git

Step 2: Enter the Project Directory

bash

cd unopim

Step 3: Configure `.env` (before starting containers)

Create a .env file by copying the provided example:

bash

cp .env.example .env

Then, open .env in your editor and update the database configuration for Docker:

dotenv

DB_CONNECTION=mysql
DB_HOST=unopim-mysql
DB_PORT=3306
DB_DATABASE=unopim
DB_USERNAME=root
DB_PASSWORD=password
DB_PREFIX=

💡 These values match the services defined in docker-compose.yml. You can adjust them if you change container names, ports, or credentials.

Once you’ve saved the file, proceed to Step 4 to start the containers.

Step 4: Start Docker Containers

bash

docker-compose up -d

This will pull the required images, build containers, and set up the environment.

Step 5: Access Services

Service	URL
UnoPim App	`http://localhost:8000`
MySQL	localhost:3306

Verify running containers:

bash

docker ps

Managing Services

Stop containers:

bash

docker-compose down

Restart containers:

bash

docker-compose up -d

Rebuild containers (if configuration changes):

bash

docker-compose up --build -d

💡 Notes & Tips

If MySQL is already running locally, change the MySQL container port in docker-compose.yml and .env file.
For production, you can configure persistent volumes for MySQL data.
Always restart containers after making .env or docker-compose.yml changes.

Install Using GUI Installer

To install UnoPim using our GUI installer, you can follow any of the following methods:

Method 1: Direct Installation

Choose the directory where you want to install UnoPim. Open your terminal and navigate to this directory.
Run the following command in your terminal to install UnoPim:
sh
```
composer create-project unopim/unopim
```
Configure your HTTP server to point to the public/ directory of the project.
Open your browser and access:
```
http://localhost/unopim/public/
```
This will launch the UnoPim installer.

Method 2: Using Downloaded Package

Download UnoPim from our official repository.
Extract the contents of the downloaded package to your desired directory.
Navigate to the project root directory.
Run the following command:
sh
```
composer create
```
Configure your HTTP server to point to the public/ directory of the project.
Open your browser and access:
```
http://localhost/unopim/public/
```
This will launch the UnoPim installer.

Important Prerequisites

Make sure your system meets these requirements:

Composer is installed on your system
PHP >= 8.2
Required PHP extensions are enabled
Proper directory permissions are set

Install on macOS

Follow these steps to install UnoPim on macOS:

Prerequisites

Update Homebrew: To ensure you have the latest version of Homebrew, run the following command:
sh
```
brew update
```
Install PHP: To install PHP, run the following command:
sh
```
brew install php
```
Install Node.js: To install Node.js, run the following command:
sh
```
brew install node
```
Install Composer: To install Composer, run the following command:
sh
```
brew install composer
```
Install MySQL: To install MySQL, run the following command:
sh
```
brew install mysql
```

Installation Steps

Choose the directory where you want to install UnoPim. Open your terminal and navigate to this directory.
Install UnoPim :

Run the following command in your terminal to install UnoPim:
sh
```
composer create-project unopim/unopim
```
Chnage directory to project root directory
sh
```
 cd unopim
```

Configure Environment(optional) :

Copy the .env.example file to .env

cp .env.example .env

Update the following configurations in .env:

APP_URL=http://localhost:8000
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=unopim
DB_USERNAME=root
DB_PASSWORD=

Run the installation command:
sh
```
php artisan unopim:install
```
Start the development server:
sh
```
php artisan serve
```

Your UnoPim installation should now be accessible at http://localhost:8000.

TIP

For a more production-like environment on macOS, you can use tools like Laravel Valet or Docker.

Note

Make sure your PHP version is 8.1 or higher and all required PHP extensions are installed.
Make sure your Composer version is 2.0 or higher and mysql is installed.

Install Using Amazon Cloud AMI

Follow these steps to install UnoPim on Amazon Web Services (AWS) using an Amazon Machine Image (AMI):

Installation Steps

Step 1: Launch the EC2 Instance

Launch an EC2 instance from the Unopim AMI via AWS Marketplace.
Wait until the instance status is “running”.

Step 2: Access Your EC2 Instance

Set your PEM file permission:
sh
```
chmod 400 your-key-file.pem
```
Connect to your instance:
sh
```
ssh -i your-key-file.pem ubuntu@your-instance-ip
```
Replace your-key-file.pem and your-instance-ip with your actual key and public IP.

Step 3: Run SSL Script

Make sure your domain’s A record points to your EC2 Elastic IP.
(If using Cloudflare or a similar proxy, disable proxy before running the script.)
Run the SSL configuration:
sh
```
sudo bash /root/ssl_configuration.sh
```
This sets up Let's Encrypt SSL and configures Apache for HTTPS.

Step 4: Complete Unopim Installation Through the Web Interface

Visit https://yourdomain.com/ in your browser.
Click “Continue” on the setup screen.
Follow the on-screen steps:
- System Requirements: Review and continue.
- Database Setup: Use credentials found on your server:
  sh
```
cat /var/www/html/unopim/mysql_password.txt
```
- Start Installation: Click the button to install Unopim.
- Domain URL: Enter your domain (e.g., https://yourdomain.com).
- Set Defaults: Timezone, locale, currency, and allowed options.
- Admin Setup: Create admin credentials and set timezone/locale.
After setup, log in to the Unopim Admin Panel.

Security Step: Delete the credentials file after setup:

sudo rm /var/www/html/unopim/mysql_password.txt

Cloud Installation via Amazon AMI

You can quickly launch UnoPim on the cloud using our official Amazon Machine Image (AMI): Launch on Cloud

Start Using UnoPim

On a Production Server

To access UnoPim on a production server, open your domain in a web browser. For example:

https://example.com/

On Your Local Server

To access UnoPim on your local server, follow these steps:

Configure your HTTP server to point to the public/ directory of the project.
Run the following command:
sh
```
php artisan serve
```
Open your browser and access the provided local server URL.

Configure the Virtual Host

Depending on your web server, you can configure UnoPim with either Apache 2 or NGINX.

Configure Using Apache 2

Creating the Virtual Host File

Create the file /etc/apache2/sites-available/unopim.local.conf:

apache

<VirtualHost *:80>
    ServerName unopim.local

    DocumentRoot /path/to/installation/unopim/public
    <Directory /path/to/installation/unopim/public>
        Options FollowSymLinks MultiViews
        AllowOverride All
        Require all granted
    </Directory>

    ReWriteEngine On

    <FilesMatch \.php$>
        SetHandler "proxy:unix:/run/php/php8.2-fpm.sock|fcgi://localhost/"
    </FilesMatch>

    ErrorLog ${APACHE_LOG_DIR}/unopim_error.log
    LogLevel warn
    CustomLog ${APACHE_LOG_DIR}/unopim_access.log combined
</VirtualHost>

Notes:

Replace /path/to/installation with the actual path where UnoPim is installed.
Ensure that /run/php/php8.2-fpm.sock matches the socket path defined in /etc/php/8.2/fpm/pool.d/www.conf.

Enabling the Virtual Host

bash

sudo apache2ctl configtest   # should return "Syntax OK"
sudo a2ensite unopim.local
sudo service apache2 reload

Adding the Virtual Host Name

Edit your /etc/hosts file:

127.0.0.1    unopim.local

Now open http://unopim.local in your browser to access UnoPim.

Configure Using NGINX

Creating the Virtual Host File

Create the file /etc/nginx/sites-available/unopim.local.conf:

nginx

server {
    listen 80;
    server_name unopim.local;   # Replace with your dev domain or server IP

    root /home/unopim/html/unopim/public;   # UnoPim document root
    index index.php index.html index.htm;

    # Handle static files (CSS, JS, images)
    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    # Handle PHP requests
    location ~ \.php$ {
        include snippets/fastcgi-php.conf;
        fastcgi_pass unix:/run/php/php8.2-fpm.sock;   # Adjust PHP-FPM socket if needed
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }

    # Deny access to hidden files like .htaccess
    location ~ /\.ht {
        deny all;
    }

    error_log /var/log/nginx/unopim_error.log;
    access_log /var/log/nginx/unopim_access.log;
}

Notes:

Replace /home/unopim/html/unopim/public with your actual UnoPim installation path if different.
Make sure PHP-FPM is running (php8.2-fpm by default).

Enabling the Virtual Host

bash

sudo ln -s /etc/nginx/sites-available/unopim.local.conf /etc/nginx/sites-enabled/
sudo rm -f /etc/nginx/sites-enabled/default   # remove default config
sudo nginx -t   # test config
sudo systemctl reload nginx

Adding the Virtual Host Name

Add this entry to your /etc/hosts file on your server (and local machine if testing from there):

127.0.0.1    unopim.local

Now open http://unopim.local in your browser to access UnoPim.

Installation ​

Install Using Composer ​

Install Using Docker ​

Prerequisites ​

Method 1: Using Docker Hub (Quick Setup - Recommended) ​

Step 1: Pull UnoPim Docker Image ​

Step 2: Run the Container ​

Step 3: Access UnoPim ​

Database Connection (Optional) ​

Method 2: Using Docker Compose (For Customization) ​

Step 1: Clone Repository ​

Step 2: Enter the Project Directory ​

Step 3: Configure .env (before starting containers) ​

Step 4: Start Docker Containers ​

Step 5: Access Services ​

Managing Services ​

💡 Notes & Tips ​

Install Using GUI Installer ​

Method 1: Direct Installation ​

Method 2: Using Downloaded Package ​

Install on macOS ​

Prerequisites ​

Installation Steps ​

Install Using Amazon Cloud AMI ​

Installation Steps ​

Cloud Installation via Amazon AMI ​

Start Using UnoPim ​

On a Production Server ​

On Your Local Server ​

Configure the Virtual Host ​

Configure Using Apache 2 ​

Creating the Virtual Host File ​

Enabling the Virtual Host ​

Adding the Virtual Host Name ​

Configure Using NGINX ​

Creating the Virtual Host File ​

Enabling the Virtual Host ​

Adding the Virtual Host Name ​

Installation

Install Using Composer

Install Using Docker

Prerequisites

Method 1: Using Docker Hub (Quick Setup - Recommended)

Step 1: Pull UnoPim Docker Image

Step 2: Run the Container

Step 3: Access UnoPim

Database Connection (Optional)

Method 2: Using Docker Compose (For Customization)

Step 1: Clone Repository

Step 2: Enter the Project Directory

Step 3: Configure `.env` (before starting containers)

Step 4: Start Docker Containers

Step 5: Access Services

Managing Services

💡 Notes & Tips

Install Using GUI Installer

Method 1: Direct Installation

Method 2: Using Downloaded Package

Install on macOS

Prerequisites

Installation Steps

Install Using Amazon Cloud AMI

Installation Steps

Cloud Installation via Amazon AMI

Start Using UnoPim

On a Production Server

On Your Local Server

Configure the Virtual Host

Configure Using Apache 2

Creating the Virtual Host File

Enabling the Virtual Host

Adding the Virtual Host Name

Configure Using NGINX

Creating the Virtual Host File

Enabling the Virtual Host

Adding the Virtual Host Name