Installation & Self-Hosting

GAuth is a fully client-side application, which makes it incredibly easy to host on your own server or even run locally from your filesystem (though some browser security policies may restrict functionality when run directly from file://).

Prerequisites

  • A simple web server.
  • git for cloning the repository.

Hosting Instructions

Follow these steps to get your own instance of GAuth running.

1. Clone the Repository

Open your terminal and clone the official GAuth GitHub repository:

git clone https://github.com/gbraad/gauth.git

2. Navigate to the Directory

Change into the newly created directory:

cd gauth

3. Serve the Files

The repository contains all the necessary static files (index.html, JavaScript, CSS). There is no build step required. You just need to serve these files using any static web server.

Here are a few simple examples:

Using Python 3:

If you have Python 3 installed, you can use its built-in web server.

# This will serve the files on http://localhost:8000
python -m http.server

Using Node.js:

If you have Node.js, you can use the serve package.

# Install the serve package globally
npm install -g serve

# Serve the current directory
serve .

Using other methods:

You can also simply upload the contents of the gauth directory to any static web hosting provider, such as GitHub Pages, Netlify, or your own Apache/Nginx server.

Once the server is running, you can access your personal GAuth instance from your browser. All data will be stored locally on that machine.