> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryhamsa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up a web reader site

> Add a site with its domain and voice, follow the Getting this live checklist, choose readings, voices and dictionaries, and turn a site on, off or delete it.

> [!NOTE]
>
> Web reader is in beta and switched on for selected accounts.

A site is one website that uses the web reader: its domain, the readings it offers with a voice for each, its pronunciation dictionaries and the player's look. This page covers adding a site, the **Getting this live** checklist, the reading and voice settings, and turning a site off or deleting it.

## Before you start

* Open **Web reader** in the sidebar. If you don't see it, web reader isn't switched on for your account.
* Generating audio needs a Pro, Business or Enterprise plan and credits. See [Web reader](https://docs.tryhamsa.com/media/web-reader/overview.md#before-you-start).

## Add a site

**1. Open the form**

In **Web reader**, click **Add site**. With no sites yet, the page shows three steps to get started, and **Add your site** is the first.

![Web reader with no sites yet: a player preview and three steps, with Add site next to Add your site](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/empty-state-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=06922e3215cc6d982acb6bf6b541a791)

**2. Enter the domain**

In **Domain**, enter your site's address, for example `https://example.com`. Hamsa adds `https://` if you leave it out. Articles on this domain and its subdomains can use the player: `blog.example.com` is covered by `example.com`, and `www.` is ignored.

**3. Choose a voice**

Click **Choose a voice** and pick a voice from the voices browser.

**4. Create it**

Click **Create**. The site opens on its **Setup** tab.

A new site offers one reading, the one its voice speaks: an English voice gives an English reading, an Egyptian voice an Egyptian reading. It starts with the **Dark** theme, the lime accent colour, no dictionaries, and is active. You add more readings on the **Settings** tab.

![The New site dialog with the domain https://example.com and the voice Emma chosen](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/new-site-dialog-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=ce1397ea3c82c8c1ac47ece3542fed4f)

## The site page

The site page shows the domain, an **Active** or **Inactive** badge, the site ID and **Copy embed code**. Four figures sit above every tab: **Articles converted**, **Total plays**, **Average completion** and **Audio generated** (see [Analytics](https://docs.tryhamsa.com/media/web-reader/analytics.md)).

| Tab | What it's for |
| - | - |
| **Setup** | What readers will see, the **Getting this live** checklist and the snippet |
| **Conversions** | Every article converted so far, its readings, chunks and logs |
| **Analytics** | Plays per day and devices |
| **Settings** | Readings, voices, dictionaries, appearance, launcher wording and domain |

A site with conversions opens on **Conversions**; a new one opens on **Setup**. Press 1, 2, 3 or 4 to switch tabs (not while you type). Press Cmd+K (Ctrl+K on Windows) to copy the embed code or switch tab from the command palette.

## Getting this live

The **Setup** tab starts with a preview, **What your readers will see**, in the site's own theme. Below it, the **Getting this live** checklist shows **Not live yet** until the first article is converted, then **Live**.

![A new site on its Setup tab: the player preview, the Getting this live checklist with the first step ticked, and the embed snippet beside it](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/setup-checklist-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=12d87b0aadf49baf96c2dfbf3140e61e)

| Step | How it gets ticked |
| - | - |
| **Copy the embed snippet** | When you click **Copy snippet** (or copy the snippet below it) in this browser. Copy it again after changing appearance or readings. |
| **Add it to your site** | Tick **I added it** yourself. It is confirmed for good once the first article comes through. |
| **First article converted** | When the first article is converted. Open an article with the snippet on it and press play. |

If any reading has no voice, the checklist shows "Every language you offer needs a voice assigned to it." with **Configure**, which opens **Settings**.

Beside the checklist, **How it is installed** switches the snippet between **Floating** and **Inline**. See [Add the player to your site](https://docs.tryhamsa.com/media/web-reader/add-to-your-site.md).

## Readings and voices

On **Settings**, the **Readings & voices** card decides which versions of your articles readers can listen to.

![The Readings & voices card with English and Egyptian offered, English played first, and a voice for each reading](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/readings-voices-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=94db47ba36fe31cd12ae94ff0d310dbb)

**1. Choose the readings**

Under **Readings offered**, click a chip to offer it or stop offering it. English is in one group, Modern Standard Arabic and the Arabic dialects in another. The list comes from the dialects Hamsa's voices cover. At least one reading must stay on.

**2. Check the voice for each**

When you add a reading, the first voice in that dialect is filled in ("Choosing a voice…"). Under **Voice for each reading**, click **Change** to pick another. The voices browser opens filtered to that reading's language and dialect.

**3. Choose what plays first**

With two or more readings, **Played first** sets the reading a listener gets before choosing one. It is also the only reading made until someone picks another.

**4. Save**

Click **Save changes**, then copy the snippet again from **Setup**: readings and **Played first** travel in the snippet.

Each reading is made and charged separately the first time someone plays it, so offer the ones your readers will use.

### Arabic dialects

Hamsa assumes Arabic articles are written in Modern Standard Arabic. A dialect reading translates the article into that dialect before the voice reads it, so it costs speech and translation. A Modern Standard Arabic reading of an Arabic article costs speech only.

Pick a voice that speaks the reading's dialect. Each voice is saved under its own dialect, so two readings can't use voices of the same dialect, and saving fails if they do.

## Pronunciation

The **Pronunciation** card adds [dictionaries](https://docs.tryhamsa.com/media/voices/dictionaries.md) that teach the voice how to say names, brands and acronyms. Click **Choose dictionaries**, search, and pick one or more of this project's dictionaries. Each entry replaces its word wherever it appears, also inside a longer word, before the article is spoken (see [how a dictionary changes the audio](https://docs.tryhamsa.com/media/voices/dictionaries.md#how-a-dictionary-changes-the-audio)). Dictionaries apply to articles converted after you save; clear an article's cached audio to apply them to it.

![The Pronunciation card with the dictionary list open and Newsroom names ticked](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/choose-dictionaries-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=69872ec9208aaa08ced352d4df5ff247)

## Save, discard and reset

Changes on **Settings** show in the previews at once but reach your site only when you save.

* The bar at the bottom says **Unsaved changes**, with **Discard** and **Save changes**. When a change travels in the snippet, it adds "Copy the embed snippet again after saving."

![The bar at the bottom of Settings: Unsaved changes, with Discard and Save changes](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/unsaved-changes-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=cfdba4d07d6ced251bcdf12a33e5aaa7)

* **Save changes** stays disabled with a reason when a reading has no voice ("Assign a voice to … before saving.") or no reading is offered.
* Leaving **Settings** with unsaved changes asks "Discard unsaved settings?" Choose **Discard changes** or **Keep editing**.
* **Reset** on **Appearance**, **Layout**, **Custom CSS** and **Floating launcher** puts that section back to the defaults a new site starts with. It asks first if you have unsaved edits there. Nothing changes on your site until you save.

## Change the domain

The **Site** card at the end of **Settings** holds the **Domain**. Change it and save. Only pages on the new domain (and its subdomains) can play audio after that.

![The Site card with the Domain field](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/site-domain-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=cd07aa4bd80627fccaa12acb9fbec46d)

## Turn a site off or on

In the **Web reader** list, use the switch on a site's row ("Turn the player off for this site"). The badge changes to **Inactive** and "Player turned off" confirms it.

While a site is inactive, no article plays on it, including articles already converted, nothing is converted and nothing is charged. Chunk edits are refused. Conversions and settings stay. Turn the switch back on to restore it.

## Delete a site

In the **Web reader** list, open the row's menu and click **Delete**, then confirm "Delete this site?". The site and all its conversion data are removed, and the snippet stops working on your pages. This can't be undone.

![The Delete this site? confirmation with Cancel and Delete](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/delete-site-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=b716461469d3ead102719d1ef0270219)

## Find a site

The **Web reader** list shows each site's domain, conversions and plays. Filter by **All**, **Active** or **Inactive**, search domains, and sort by **Newest**, **Most conversions**, **Most plays** or **Domain, A to Z**. Click a row or **View** to open it. The row's **More actions** menu has **View details** (which opens the site too), **Copy embed code**, **Settings** and **Delete**.

![A site's row menu open: View details, Copy embed code, Settings and Delete](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/site-row-menu-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=ebea0ff5b2dec3528c6b66e14ba5750e)

## Related

> [card] [Player appearance](https://docs.tryhamsa.com/media/web-reader/appearance.md)
>
> Theme, colours, layouts, sizes and custom CSS.

> [card] [Add the player to your site](https://docs.tryhamsa.com/media/web-reader/add-to-your-site.md)
>
> Where the snippet goes and what it carries.

> [card] [Dictionaries](https://docs.tryhamsa.com/media/voices/dictionaries.md)
>
> Fix how names and terms are said.

> [card] [Conversions and chunks](https://docs.tryhamsa.com/media/web-reader/conversions.md)
>
> See what readers have played.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.