OUR STORY FEATURES EDITIONS CONTACT KIKO

GWS
Backup

By KIKO
Solutions

Getting Started

Welcome to GWS Backup Support. This documentation will guide you through setting up your backup server and connecting your first Google Workspace client.

If you have questions about API limits, backup speeds, or "Stopped" statuses, please review our Frequently Asked Questions.

System Specifications

What are the recommended server specs?

GWS Backup is designed to be incredibly lightweight and efficient. Because we use Differential SQLite Tracing instead of bulky database engines, you do not need an expensive dedicated server.

  • Memory: We recommend allocating approximately 50MB of RAM per client workspace.
  • CPU: 1-2 vCPU cores is sufficient for the base engine and parallel workers.
  • Hosting: You can comfortably run this on a standard VPS (Virtual Private Server).
  • Storage: Minimal local storage is required for the application itself. Your backup destination (S3, Google Cloud, etc.) will handle the heavy lifting.

Installation Guides

GWS Backup can be deployed across multiple operating systems. Choose your environment below.

Linux Server (Recommended)

Deploying to a Linux server is our recommended approach for 24/7 reliability and minimal overhead. GWS Backup is tested heavily on Ubuntu/Debian.

# 1. Download the latest release
wget https://download.gwsbackup.com/latest/linux-x64.tar.gz

# 2. Extract and run the installer
tar -xzf linux-x64.tar.gz
cd gwsbackup
sudo ./install.sh

Windows Server

GWS Backup runs as a background service on Windows Server 2019/2022. The installation is fully automated via our MSI package.

  • Download the Windows Installer `.msi` from your dashboard.
  • Run the installer with Administrator privileges.
  • The service will automatically start and can be managed via `services.msc`.

MacOS

While MacOS is typically used for development or testing, GWS Backup is fully supported natively on Apple Silicon (M1/M2/M3) and Intel chips.

# Use Homebrew to install dependencies
brew install node

# Install GWS Backup globally
npm install -g gws-backup-cli
gws-backup start

App Usage in Detail

1. Adding a Client

Navigate to the Client Management tab. Enter the client's contact details and authenticate via OAuth to their Google Workspace. Ensure you have Super Admin privileges to authorize the backup scopes.

2. Configuring the Destination

In Settings, define where the data will land. You can input your AWS S3 bucket credentials, Google Cloud Storage keys, or a local network mount. All credentials are AES-256 encrypted at rest.

3. Setting the Schedule & Retention

Use the Scheduler to define how often backups occur. If you set it to run multiple times a day, the differential engine ensures only new files are transferred. In the Data Retention tab, define how long deleted items are kept in your storage before being purged.

4. Running Audits and Investigations

If a client requests proof of backup, use the Global Reporting tool to generate a PDF. If you need to recover a specific file, use the Investigations tab to deep-search the indexed backups without having to download the entire archive.