← Back to Help

Table of Contents

Getting Started with Isurus

Welcome to Isurus, a self-hosted Mercurial forge by Leafscale, LLC. This guide covers everything you need to get productive.

Account Setup

First Login

  1. Navigate to your Isurus instance and click Sign in.
  2. Log in with your credentials or use Google OAuth if your administrator has enabled it.
  3. After your first login, visit Settings to configure your profile.

Profile Settings

Go to Settings (click your username in the top-right menu) to:

  • Set your display name shown on commits, issues, and pull requests.
  • Update your email address.
  • Change your password (local accounts only).
  • Set your timezone to control how dates and times are displayed throughout the application. If not set, the server's default timezone is used. This is especially relevant for features like scheduled release publication, where the displayed times will reflect your chosen timezone.

Licensing

Isurus requires a valid license to operate. Your administrator configures the license during initial setup. If you see an "Unlicensed" page, contact your administrator. Resource limits (repositories, users, storage, CI minutes) are determined by your organization's license plan.

Organizations

Organizations group repositories and team members together.

Creating an Organization

  1. Click + New in the navigation bar and select New Organization.
  2. Enter an organization name (lowercase, letters, numbers, and hyphens only).
  3. Optionally add a description.
  4. Click Create Organization.

Organization Roles

Role Permissions
Owner Full access: manage members, settings, and all repositories
Member Read/write access to organization repositories

Managing Members

  1. Navigate to your organization page.
  2. Click Members in the sidebar.
  3. Use Add Member to invite users by username.
  4. Owners can remove members or change roles.

Repositories

Creating a Repository

  1. Navigate to the organization where you want to create the repository.
  2. Click New Repository.
  3. Enter a name (lowercase, letters, numbers, hyphens, and dots).
  4. Add an optional description.
  5. Choose Public (visible to everyone) or Private (visible to org members only).
  6. Click Create Repository.

Repository Settings

Repository owners can access settings from the Settings tab:

  • Description: Update the repository description.
  • Visibility: Toggle between public and private.
  • Labels: Manage repository-level issue labels.
  • Issue Templates: Create templates for bug reports, features, and more.
  • Webhooks: Configure event notifications for external services.
  • CI/CD: Manage pipeline secrets and settings.
  • Danger Zone: Delete the repository (irreversible).

SSH Keys

SSH keys provide secure, password-free authentication for pushing and pulling.

Generating an ED25519 Key

ssh-keygen -t ed25519 -C "your@email.com"

When prompted, accept the default file location (~/.ssh/id_ed25519) and optionally set a passphrase.

Adding Your Key to Isurus

  1. Copy your public key: 
    cat ~/.ssh/id_ed25519.pub
  2. Go to Settings > SSH Keys.
  3. Paste the key into the Key field.
  4. Give it a descriptive name (e.g., "Work Laptop").
  5. Click Add SSH Key.

Testing Your Connection

ssh -T your-isurus-host

You should see a message confirming successful authentication.

Cloning Repositories

HTTP Clone

hg clone https://your-isurus-instance/org/repo

You will be prompted for your username and password (or API token).

SSH Clone

hg clone ssh://your-isurus-instance/org/repo

Requires an SSH key added to your account.

Which Method to Choose?

Method Pros Cons
SSH No password prompts, secure Requires SSH key setup
HTTP Works everywhere, simple setup Requires credential storage or repeated entry

What's Next?

Now that you're set up, explore these guides: