> For the complete documentation index, see [llms.txt](https://docs.avocado.vc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avocado.vc/installation-quick-guide.md).

# Installation - Quick Guide

## Preparation

If you already have a server - be it running on Apache or Nginx - and you know some basics of adding one more website to the existing server, you can read this quick guide to set up an instance in 3 mins.

What you need to run an instance properly include:

* PHP 7.X (extensions required: `php-curl`, `fileinfo`, `imagemagick`, `exif`)
* MySQL
* SSL (you can easily get it from Cloudflare for free)
* A domain (recommend you use a subdomain such as `app.yourcompany.vc`) 

You only need to do 3 steps to finish the installation process.

## Step 1: Configure the website

**Redirect**: The website will try to hide the ".php" extension for all the links. Therefore, you need to link `https://yoursite.name/abc` to `https://yoursite.name/abc.php`.

On a Nginx server, you can add the following lines to your new website configuration block.

```
server
{
    ...
    
    location / {
        try_files $uri $uri/ $uri.html $uri.php$is_args$query_string;
    }
}
```

**Most importantly, we use `.env` to save all your configurations. Please make sure `.env` file is not accessible by the public.**

On a **Nginx** server, you can add the following line to your new website configuration block.

```
server
{
    ...
    
    location ~ /\. {
        deny all;
    }
}
```

Using **Apache**, you can add the following to your `.htaccess` file:

```
<FilesMatch "^\.">
    Order allow,deny
    Deny from all
</FilesMatch>
```

**PHP**: The scripts use short tag \<? instead of \<?php to start. Therefore, you will need to turn`short_open_tag = On` for your PHP. You also want to increase the upload size limit to allow large attachments uploading. In your `php.ini` file, change the settings as shown below.

```
# Edit this in your php.ini file
short_open_tag = on
upload_max_filesize = 200M;
post_max_size = 200M;
```

To allow large attachments uploading (>2M), you also want to update the settings for you Nginx server.

```
$ sudo nano /etc/nginx/nginx.conf

# Change or add the following value in this document to a large value such as 200M
client_max_body_size 200M;

$ sudo systemctl reload nginx
```

## Step 2: Clone the project to your server

To get a copy of this, please contact `hello@avocado.vc` to get your API Key/Secret first. Clone the project to your server. Go to your web server root folder (e.g. `/var/www`) and run the following command to clone a copy. Replace `DOMAIN`, `API_KEY` , `API_SECRET` with your own ones.

```
$ curl "https://api.avocado.vc/install?domain=DOMAIN&key=API_KEY&secret=API_SECRET" --output install.sh && bash install.sh
```

## Step 3: Finish installation

Go to your website, and you will be redirected to the installation page automatically if everything works properly. For example, in this case, we can open `https://demo.avocado.vc`

You will need to set up your super admin account and provide the MySQL database connection information.

![Installation page](/files/-MURg8jduKYaIUagwOE_)

Once you have successfully installed, you will be redirected to the login page. You can now login with the super admin account that you just set up. You can also change any setting or customize the site under "Settings" once you log into the platform.

![](/files/-MUXa0MGUyNJJEMczB2m)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.avocado.vc/installation-quick-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.