Installation & Deployment

Requirements

• Gmail / Outlook Email with App password 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

   • git clone https://github.com/gerobug/gerobug
     cd gerobug

2. Run the Startup Script

   • ./run.sh

3. Follow the setup instructions carefully

   

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

      

      If not applicable, enter 127.0.0.1 instead
   2. Provide a Domain so that Gerobug can implement HTTPS

      

      If you have no domain, you can still install Gerobug but without HTTPS [NOT RECOMMENDED FOR PRODUCTION]
   3. Choose YES if you already have a VPN Server and Private Subnet

      

      If YES, Gerobug Dashboard will only accept connection from Internal IP, so you need to connect to your VPN server if NO, Gerobug Dashboard will be accessible from public [NOT RECOMMENDED FOR PRODUCTION]

4. Gerobug will finish the installation process

   

   

   "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

The whole installation process will take around 5-15 minutes.

By default, Gerobug Dashboard will listen at port 6320