# Installation

Install Using Composer
Installation with Docker
Install Using GUI Installer
- Method 1: Direct Installation
- Method 2: Using Downloaded Package
Mac OS Installation
- Prerequisites
- Installation Steps
Start Using UnoPim
- On a Production Server
- On Your Local Server
Configuring the Virtual Host

# 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:
```
composer create-project
```
Otherwise, to directly install UnoPim, run the following command in your terminal:
```
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 :

# Installation with Docker

If you have Docker/Docker Compose installed, follow these steps:

Clone the repository:
- HTTPS: git clone https://github.com/unopim/unopim.git
- SSH: git clone git@github.com:unopim/unopim.git
Enter the directory:
```
cd unopim
```
Start the Docker containers:
```
docker-compose up -d
```
This will pull the necessary images and set up the environment. Once running, access the application at:
- Application: http://localhost:8000
- MySQL: http://localhost:3306

Note: If MySQL is already running on your system, change the MySQL port in the docker-compose.yml and .env files. Run docker-compose up -d again to apply 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:
```
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 (opens new window) 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:
```
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

# Mac OS Installation

Follow these steps to install UnoPim on macOS:

# Prerequisites

Update Homebrew: To ensure you have the latest version of Homebrew, run the following command:
```
brew update
```
Install PHP: To install PHP, run the following command:
```
brew install php
```
Install Node.js: To install Node.js, run the following command:
```
brew install node
```
Install Composer: To install Composer, run the following command:
```
brew install composer
```
Install MySQL: To install MySQL, run the following command:
```
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:
```
composer create-project unopim/unopim
```
Chnage directory to project root directory
```
 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:
```
php artisan unopim:install
```
Start the development server:
```
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.

# 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:
```
php artisan serve
```
Open your browser and access the provided local server URL.

# Configuring the Virtual Host

# Creating the Virtual Host File

This guide explains how to create and configure a virtual host for Apache to point to the installation folder of UnoPIM, Create the file /etc/apache2/sites-available/unopim.local.conf:

<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. Update this value if it differs.

# Enabling the Virtual Host

Run the following commands to enable the virtual host:

$ sudo apache2ctl configtest
 # This will return 'Syntax OK'

$ sudo a2ensite unopim.local
$ sudo service apache2 reload

# Adding the Virtual Host Name

Add the following entry to your /etc/hosts file:

 127.0.0.1    unopim.local

Your virtual host configuration for UnoPIM is now complete. Visit http://unopim.local in your browser to access the application.

← Requirements Creating a New User →