# Installation & Deployment

## Requirements

* Gmail / Outlook Email with [App password](https://support.google.com/accounts/answer/185833) implemented
* VPN Server and Private Subnet (Recommended for Production)
* Domain for HTTPS (Recommended for Production)

\[You don't need to install anything else, Gerobug will do it for you]

*In this current version, Gerobug only support GMAIL and OUTLOOK*

## (Minimum) Recommended Specification

* Ubuntu 20.04
* vCPU 2 Core
* RAM 2 GB
* HDD 16 GB

\[Depends on your company / organization size]

## Deployment

1. Clone the repository
   * <pre><code><strong>git clone https://github.com/gerobug/gerobug
     </strong>cd gerobug
     </code></pre>

2. Run the Startup Script
   * ```
     ./run.sh
     ```

3. Follow the setup instructions carefully<br>

   <figure><img src="https://85781584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVa4mPzYShiyS695uKo1D%2Fuploads%2FsveLtKj3n0Suf5H6RiPD%2FScreenshot%202024-04-14%20at%2002.31.25.png?alt=media&#x26;token=75bc605b-b8b8-4147-bbf6-0e05c4c699fb" alt=""><figcaption></figcaption></figure>

   1. Provide the correct Public and Private IP of the Server

      <figure><img src="https://85781584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVa4mPzYShiyS695uKo1D%2Fuploads%2FK9zdNxDJUPWyNrbWoMTg%2FScreen%20Shot%202023-08-12%20at%2011.23.56%20PM.png?alt=media&#x26;token=0cacf0cd-ecfa-4652-86b4-e682fb36ca94" alt=""><figcaption><p><strong>If not applicable, enter 127.0.0.1 instead</strong></p></figcaption></figure>
   2. Provide a Domain so that Gerobug can implement HTTPS

      <figure><img src="https://85781584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVa4mPzYShiyS695uKo1D%2Fuploads%2FPjnlDQ23gN20HgX7BRfP%2FScreen%20Shot%202023-08-12%20at%2011.25.49%20PM.png?alt=media&#x26;token=0aa0a23e-4d51-4f68-a2d2-d80ec4561ee2" alt=""><figcaption><p><strong>If you have no domain, you can still install Gerobug but without HTTPS [NOT RECOMMENDED FOR PRODUCTION]</strong></p></figcaption></figure>
   3. Choose YES if you already have a VPN Server and Private Subnet

      <figure><img src="https://85781584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVa4mPzYShiyS695uKo1D%2Fuploads%2FjSmxXvqiYfc8ZnaHoKo7%2FScreen%20Shot%202023-08-12%20at%2011.29.00%20PM.png?alt=media&#x26;token=3238a539-7bd4-4d44-8e26-bcb17887777a" alt=""><figcaption><p><strong>If YES, Gerobug Dashboard will only accept connection from Internal IP, so you need to connect to your VPN server</strong><br><strong>if NO, Gerobug Dashboard will be accessible from public [NOT RECOMMENDED FOR PRODUCTION]</strong></p></figcaption></figure>

4. Gerobug will finish the installation process

   <figure><img src="https://85781584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVa4mPzYShiyS695uKo1D%2Fuploads%2FzUFjE07frbdbNOv5qeCv%2FScreen%20Shot%202023-08-12%20at%2011.32.42%20PM.png?alt=media&#x26;token=216ae440-5879-4a76-9871-35490ab44a35" alt=""><figcaption></figcaption></figure>

   <figure><img src="https://85781584-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVa4mPzYShiyS695uKo1D%2Fuploads%2FFLLv8YViu5SUtn2aJiCA%2FScreen%20Shot%202023-08-12%20at%2011.38.54%20PM.png?alt=media&#x26;token=168f6d6c-9e85-47b5-8e0f-bece3d2efac2" alt=""><figcaption></figcaption></figure>

   "VIEWING GEROBUG LOG" is the last part of the installation process, just wait until you see **`web_1`** container are running. Here you can see the container logs, and you can exit anytime.\
   \- If you want to exit, just press `ctrl+c` \
   \- If you want to access the container logs again, just enter `docker-compose logs -f` on the Gerobug installation folder

{% hint style="info" %}
The whole installation process will take around 5-15 minutes.

By default, Gerobug Dashboard will listen at port **6320**
{% endhint %}


---

# Agent Instructions: 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://gerobug.gitbook.io/documentation/installation-and-deployment.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.