home Explore Documentation & Help
Register Sign In

Navigation

Getting Started

User Guide

Team Collaboration

Advanced

FAQ & Help

Installation Guide

System Requirements

  • RAM: 64 MiB minimum (256 MiB recommended)
  • CPU: 0.25 vCPU minimum
  • Storage: 1 GB minimum
  • OS: Linux, macOS, Windows, or ARM-based systems

Method 1: Binary Installation (Recommended)

Download

Visit gityar releases and download the appropriate binary for your platform.

Linux/macOS

# Download
wget https://github.com/gityar/gityar/releases/latest/download/gityar-linux-amd64

# Make executable
chmod +x gityar-linux-amd64

# Run
./gityar-linux-amd64 web

Windows

  1. Download gityar-windows-amd64.exe
  2. Double-click to run

Method 2: Docker Installation

Pull Image

docker pull gityar/gityar:latest

Run Container

docker run -d \
  --name gityar \
  -p 3000:3000 \
  -v /path/to/gityar-data:/data \
  gityar/gityar:latest

Docker Compose

Create docker-compose.yml:

version: '3'
services:
  gityar:
    image: gityar/gityar:latest
    container_name: gityar
    ports:
      - "3000:3000"
    volumes:
      - ./gityar-data:/data
    restart: always

Run:

docker-compose up -d

Method 3: Build from Source

Prerequisites

  • Go 1.21 or higher
  • Git

Build

# Clone repository
git clone https://github.com/gityar/gityar.git
cd gityar

# Build
go build -o gityar ./cmd/gityar

# Run
./gityar web

First-Time Setup

  1. Start gityar:

    ./gityar web

  2. Open browser: Navigate to http://localhost:3000

  3. Complete installation wizard:

    • Database settings (SQLite, MySQL, PostgreSQL)
    • Application settings
    • Admin account

  4. Start using gityar!

Database Configuration

SQLite (Default)

No additional configuration needed.

MySQL

[database]
DB_TYPE = mysql
HOST = 127.0.0.1:3306
NAME = gityar
USER = gityar
PASSWD = password

PostgreSQL

[database]
DB_TYPE = postgres
HOST = 127.0.0.1:5432
NAME = gityar
USER = gityar
PASSWD = password
SSL_MODE = disable

Reverse Proxy

Nginx

server {
    listen 80;
    server_name gityar.example.com;

    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Apache

<VirtualHost *:80>
    ServerName gityar.example.com
    
    ProxyPass / http://localhost:3000/
    ProxyPassReverse / http://localhost:3000/
</VirtualHost>

Next Steps