home Explore Documentation & Help
Register Sign In

Navigation

Getting Started

User Guide

Team Collaboration

Advanced

FAQ & Help

Quick Start Guide

After Installation

Once gityar is installed and running, follow these steps to get started quickly.

Step 1: Access gityar

Open your browser and navigate to:

http://localhost:3000

Or your configured domain.

Step 2: Create Admin Account

If this is a fresh installation:

  1. The installation wizard will appear
  2. Fill in admin account details:
    • Username
    • Email
    • Password
  3. Complete the setup

Step 3: Configure Basic Settings

Application Settings

Go to Admin Panel → Application Settings:

  • Site Name: Your gityar instance name
  • Repository Root Path: Where repositories are stored
  • Run User: System user running gityar
  • Domain: Your domain name
  • External URL: Public URL for your instance

Email Configuration (Optional)

Enable email notifications:

[mailer]
ENABLED = true
HOST = smtp.example.com:587
FROM = gityar@example.com
USER = gityar@example.com
PASSWD = password

Step 4: Create Your First Repository

  1. Click "+" → "New Repository"
  2. Fill in:
    • Repository name: my-first-project
    • Description: "My first gityar repository"
    • Visibility: Public or Private
  3. Click "Create Repository"

Step 5: Clone and Push Code

Clone Repository

git clone http://localhost:3000/username/my-first-project.git
cd my-first-project

Add Your Code

# Create files
echo "# My Project" > README.md
echo "print('Hello World')" > main.py

# Stage and commit
git add .
git commit -m "Initial commit"

# Push to gityar
git push origin main

Step 6: Explore Features

Issues

Create your first issue:

  1. Go to Issues tab
  2. Click "New Issue"
  3. Title: "Setup project structure"
  4. Description: Add details
  5. Submit

Wiki

Add project documentation:

  1. Go to Wiki tab
  2. Click "Create first page"
  3. Write your documentation in Markdown
  4. Save

Webhooks

Automate workflows:

  1. Go to Settings → Webhooks
  2. Click "Add Webhook"
  3. Configure URL and events
  4. Save

Step 7: Invite Collaborators

Add Collaborators

  1. Go to Settings → Collaboration
  2. Search for users
  3. Set permission level
  4. Add

Create Organization

For team projects:

  1. Click "+" → "New Organization"
  2. Fill in organization details
  3. Invite team members
  4. Create teams with different permissions

Best Practices

  • ✅ Use descriptive repository names
  • ✅ Always include a README file
  • ✅ Add appropriate .gitignore
  • ✅ Choose a license for open-source projects
  • ✅ Enable branch protection for main branches
  • ✅ Use issues to track work
  • ✅ Use pull requests for code review

Next Steps