# Installation

# Manual Installation

# Requirements

PHP >= 7.4.0
BCMath PHP Extension
Ctype PHP Extension
JSON PHP Extension
Mbstring PHP Extension
OpenSSL PHP Extension
PDO PHP Extension
Tokenizer PHP Extension
XML PHP Extension

# Step 1 : Download

Download (opens new window) the latest Crater package.

Alternatively, If you are a developer, follow the installation steps for your project on this Link

# Step 2 : Upload to Server

Upload the downloaded zip file to your Server and unzip it, you should see the Crater folder.

# Step 3 : Point the domain to the uploaded folder

Point your domain or subdomain to the public directory inside the Crater folder.

Please note that, Crater must be installed on a primary domain or subdomain. Installing on a sub-folder will not work, for example:

  • example.com/craterapp (Invalid)
  • localhost/crater (Invalid)
  • example.com (Valid)
  • crater.example.com (Valid)
  • crater.test (Valid)

# Step 3: Fix File Permissions

In your crater root folder, run command: chmod -R 775 ./

# Step 4 : Complete installation wizard

Open the link to the domain in the browser (Example: https://demo.craterapp.com) and complete the installation wizard as directed.

# Docker Installation

# Step 1 : Install Docker

Install Docker on your host: https://docs.docker.com/install/ (opens new window)

# Step 2 : Install Docker Compose

Install docker-compose by using this guide: https://docs.docker.com/compose/install/ (opens new window)

# Step 3 : Clone repository

Clone the repository by running this command: git clone https://github.com/bytefury/crater

# Step 4 : Run below commands

Change your current working directory and run your app using below commands:

$ cd crater
$ cp .env.example .env
$ docker-compose up -d
$ ./docker-compose/setup.sh

# Step 5 : Complete installation wizard

Open your web browser and go to your given domain (default: http://localhost (opens new window)) and follow the installation wizard.

On Installation wizard - Database setup, use below credentials:

  • Database Host: db
  • Database Name: crater
  • Database Username: crater
  • Database Password: crater

# Digital Ocean (Docker)

# Prerequisites

# Installation

# Step 1 : Clone repository

Clone the repository by running these commands:

cd ~
git clone https://github.com/bytefury/crater

# Step 2 : Setup docker containers

Change your current working directory and start containers using the given commands below:

$ cd crater
$ cp .env.example .env
$ docker-compose up -d

# Step 3 : Setup docker containers

Now wait for a few minutes until the containers are built and started. After that run the below script command to install composer dependencies & generate unique application key:

$ ./docker-compose/setup.sh

# Step 4 : Complete installation wizard

Open your web browser and go to your given domain and follow the installation wizard.

On Installation wizard - Database setup, use below credentials:

  • Database Host: db
  • Database Name: crater
  • Database Username: crater
  • Database Password: crater