One-Click Installation

Zammad Initialization:

Overview:

This guide will walk you through initializing Zammad on your AWS instance in just one click. The setup process is streamlined using our custom script, designed for ease of use and efficiency. Before starting the script, ensure the minimum requirement is met.

Pro Tip: We recommend associating an AWS Elastic IP with your instance before running the setup. This prevents your IP address from changing when the instance is stopped and restarted.

Step 1: Access Your AWS Instance

1. Launch Your AWS EC2 Instance:

• Choose your desired AWS EC2 instance type. (Minimum: t3a.small / t3.small)
• Open ports 22, 80 and 443 in the security group.
• Once the instance is running, connect to it via SSH.

2. Connect to the Instance:

• Open your terminal (Mac/Linux) or use an SSH client (e.g., PuTTY for Windows).
• Run the following SSH command:

3. Run the Initialization Script:

• To initiate the installation, run the following command:

• Note: This script automates the entire installation process. It typically takes 10 to 15 minutes: the application is downloaded, then Zammad prepares its database, builds its search index and creates your administrator account before the site is served. Keep your terminal open and do not close the session until the summary appears. The script generates new credentials for this instance.

Step 2: Instance Set Up and Installation

1. Completion Confirmation:

• Once the installation is finished, you will see a summary on the screen with your address and your administrator sign-in.
• Write the password down. It is generated for this instance and is not stored anywhere you can read it back.

2. Sign in

• Open http://<your-public-ip>/ in your browser. The first load can take up to 30 seconds while Zammad prepares its interface. That is normal, and it is quick after that.
• Enter the administrator email address and the password from the summary.
• You will arrive at your dashboard. There is no setup wizard: your helpdesk is already set up.

3. Change the administrator email address

Do this before you go any further. The address the installer creates cannot receive mail. It is on a placeholder domain, so if you lose the password there is no way to reset it. Open the admin settings with the gear icon, then Manage, then Users. Open the administrator account, set your own email address, and save.

Before you add agents

• Your email channel. In the admin settings, open Channels, then Email, and add the mailbox your customers write to. Zammad fetches incoming mail from it and sends replies through it. This image does not include a mail server, so no ticket arrives by email and no notification is sent until you set this up.
• Your groups. Under Manage, then Groups, set up the groups your tickets are sorted into, such as Sales or Support, before you invite agents to them.
• Then invite your agents under Manage, then Users, and give each one access to the groups they work in.

Step 3: Add Your Own Domain and SSL

• Your helpdesk is served over plain HTTP until you associate a domain. To use your own domain name with a free SSL certificate, run:

• Full instructions are in Associating Your Domain.
• Do this before your agents and customers start using it. Tickets carry names, email addresses and conversations, and they should not travel over plain HTTP.

Important Notes:

• Mail Sending Restrictions:
  AWS restricts outbound email on port 25 from EC2 instances by default. Zammad sends through the mail provider you configure, usually on port 587 or 465, which is not affected.
• The database and search engine are not reachable from the internet.
  PostgreSQL and Elasticsearch run on a private network inside the instance with no published port. Ports 5432 and 9200 do not need to be open and must not be opened.
• Do not run the installer a second time.
  Each run generates new passwords, while an existing installation keeps the ones it was created with. If you think something went wrong, email [email protected] rather than running it again.