This guide will help you set up your Koha Library System after launching it on Amazon Web Services (AWS) Marketplace.

1. Retrieve the Koha Administrator Password

  • Log in to your AWS account and navigate to the EC2 dashboard.

  • In the EC2 console, select your new instance listed under “Instances”.

  • SSH into your instance:

    • Via the EC2 console: Click on the instance, then click “Connect” to view the SSH command. Choose “Connect using EC2 Instance Connect”. Use “ubuntu” as the username.
    • Via an SSH client: Use the public IP address or public DNS provided in the console. Use “ubuntu” as the username. You will also need to specify the private key file associated with the key pair you selected when launching the instance.
  • Retrieve the Koha administrator password and username by running the following commands:
# List the Koha instances
koha-list 

# Retrieve the password for the instance named "library"
sudo koha-passwd library
  • The default instance name is library.
  • The password will be displayed on the screen. Save it securely, you will need it in the next steps. Note that, for enhanced security, this is automatically changed whenever you reboot the server.

2. Access the Koha Web Installer

  • Open your browser and navigate to the Koha staff interface URL (you can find it in the EC2 instance description or use the public IP address).
  • The web installer will start automatically on first access
  • You’ll be presented with the web installer login screen

3. Complete the Web Installer

Web Installer Login

The web installer sets up the database tables that store all the data you work with in Koha, including library branches, patrons, and items.

Login credentials:

  • Username: koha_library (default database administrator)
  • Password: The password retrieved in step 1

Language Selection

Choose your preferred language for the Koha interface. Installing other languages (DE, FR, etc.) will allow those languages to be used throughout Koha.

Perl Modules Check

The installer verifies all required dependencies are installed. Click Continue to proceed.

Database Settings

Review and confirm the database settings. For AWS Marketplace installations, these are pre-configured correctly. Click Continue to establish the connection and create database tables.

Note: This step may take several minutes. Please be patient.

Select MARC Flavour

Choose your MARC format for storing bibliographic records:

  • MARC21: Most commonly used globally (default, recommended for US libraries)
  • UNIMARC: Frequently used in European countries (except UK)

Install Sample Data

The installer offers various optional data sets. Recommended selections for new installations:

Essential (highly recommended):

  • Default bibliographic framework (MARC21 or UNIMARC)
  • Default classification sources (Dewey Decimal, Library of Congress)
  • Sample notices (email templates for overdue, holds, etc.)
  • Default message transports (email and SMS)
  • CSV profiles (for data exports)
  • Z39.50 server access (for copy cataloging from Library of Congress, etc.)

Useful optional data:

  • Sample libraries (if you want demo data; skip if creating from scratch)
  • Sample patron categories (or create your own)
  • Sample item types (or create your own)
  • Sample circulation rules
  • Default currencies (for acquisitions module)
  • Sample news items

Developer Note: Installing sample libraries, patrons, and items is useful for testing but should be removed before going into production.

Click Import to install the selected data.

Installation Complete

After importing, you’ll see confirmation of successfully added data. Click Set up some of Koha’s basic requirements to proceed to the onboarding tool.

4. Complete the Onboarding Tool

The onboarding tool ensures you have the minimum requirements configured before using Koha:

Create a Library

If you didn’t install sample libraries, you’ll need to create at least one:

  • Library code: Up to 10 letters (e.g., “MAIN”)
  • Name: Official library name (e.g., “Main Library”)

More libraries can be added later via Administration → Libraries and groups

Create a Patron Category

Define at least one patron category (template for patron accounts):

  • Category code: Up to 10 letters (e.g., “STAFF”)
  • Description: Descriptive name
  • Overdue notice required: Yes/No
  • Category type: Staff, Adult, Child, etc.
  • Default privacy: Controls reading history retention
  • Enrolment period: Months or specific date

More categories can be added later via Administration → Patron categories

Create a Superlibrarian Patron

Create your administrator account to access the staff interface:

Required fields:

  • Surname: Your last name
  • First name: Your first name
  • Card number: Unique identifier
  • Library: Select your library
  • Patron category: Select your staff category
  • Username: Login username
  • Password: Strong password (min 8 characters)

Important: Save these credentials securely! This is your superlibrarian account with full administrative access.

Create an Item Type

If you didn’t install sample item types, create at least one:

  • Item type code: Up to 10 letters (e.g., “BOOK”)
  • Description: Item type description

More item types can be added later via Administration → Item types

Create a Circulation Rule

Define lending rules for your library:

  • Library branch: All or specific library
  • Patron categories: All or specific category
  • Item type: All or specific type
  • Current checkouts allowed: Maximum items (default: 50)
  • Loan period: Days or hours (default: 14 days)
  • Renewals allowed: Number of times (default: 10)
  • Renewals period: Days or hours (default: 14 days)
  • On shelf holds allowed: Yes/No/If any unavailable

More circulation rules can be configured via Administration → Circulation and fines rules

Onboarding Complete

After creating the circulation rule, you’ll see confirmation that installation is complete. Click Start using Koha to log in.

5. Login to the Staff Interface

Use your superlibrarian credentials created during onboarding:

  • Username: Your username
  • Password: Your password
  • Library: Select “My library” or your specific library

Note: The StaffLoginLibraryBasedOnIP system preference can restrict which library you can access.

6. Post-Installation Configuration

After logging in, configure these essential settings:

System Preferences

  • Administration → Global system preferences
  • Configure library name, contact info, and branding
  • Set circulation policies and fine amounts
  • Configure email settings for notices

Authorized Values

  • Administration → Authorized values
  • Customize dropdown lists for shelving locations, collection codes, etc.

Circulation Rules

  • Administration → Circulation and fines rules
  • Refine lending policies by patron category and item type
  • Set fine amounts and grace periods

Email Notifications

  • Administration → Notices & slips
  • Customize email templates for overdues, holds, and checkouts
  • Configure the KohaAdminEmailAddress system preference

Import Cataloging Data

  • Use Z39.50 to copy catalog from Library of Congress, OCLC, etc.
  • Administration → Z39.50/SRU servers
  • Or begin manual cataloging via Cataloging

Next Steps

Need Help?

If you encounter any issues during setup, contact our support team.