continuwuity/docs/deploying.mdx

import { OverviewGroup } from '@rspress/core/theme';

# Deploying

This chapter describes various ways to deploy Continuwuity. Start reading on this page for useful general information, and then proceed to one of the deployment methods.

:::tip Getting help
If you run into any problems while setting up Continuwuity, ask us in [`#continuwuity:continuwuity.org`][support-room] or [open an issue on Forgejo][forgejo-new-issue].
:::

[support-room]: https://matrix.to/#/%23continuwuity:continuwuity.org
[forgejo-new-issue]: https://forgejo.ellis.link/continuwuation/continuwuity/issues/new

## Release tracks

Continuwuity offers two release tracks to accommodate different needs: tracking the **main branch** of the [repository], and following the regular **release schedule**.

### Main branch

As Continuwuity is rapidly evolving software, we encourage deployments to follow the main branch to receive the latest fixes and features. Commits in main are stable and have been thoroughly tested by the maintainers before merging.

To be notified of updates to main, it is best to [**track the `/changelog.d` directory**][changelog-d] in the repository, which contains changelog snippets from merged pull requests. These may contain breaking changes. Then, proceed to update or build Continuwuity according to your deployment method.

[repository]: https://forgejo.ellis.link/continuwuation/continuwuity
[changelog-d]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/changelog.d

### Regular releases

Regular releases are periodic, versioned cutoffs from the main branch from time to time, and can be found on the [Releases] page. They are suitable in cases where updating more frequently is not viable, such as when using third-party packaging.

For regular releases, **always read the release notes before upgrading to a new version**, as they may contain breaking changes that affect your deployment.

[Releases]: https://forgejo.ellis.link/continuwuation/continuwuity/releases

## Installation

:::info Mind the name!
The binary for Continuwuity is called `conduwuit`, and the configuration file `conduwuit.toml`.
:::

To have Continuwuity working, you will generally need to:

1. Have a domain name pointing to your server's IP address - we will be using `example.com` in our guides.
2. Download or build Continuwuity from your preferred source.
3. Configure Continuwuity via the config file or environment variables. See the [Configuration](./configuration.mdx) page for more.
4. Employ a reverse proxy in front of Continuwuity - we will mainly provide examples for Caddy in our guides.
5. And finally, start the Continuwuity service.

Navigate to your preferred method of deploying Continuwuity as listed below, and follow the instructions there.

<OverviewGroup
    group={{
        items: [
            {
                "link": "deploying/generic",
                "text": "Generic"
            },
            {
                "link": "deploying/docker",
                "text": "Docker"
            },
            {
                "link": "deploying/debian",
                "text": "Debian"
            },
            {
                "link": "deploying/rpm",
                "text": "RPM"
            },
            {
                "link": "deploying/nixos",
                "text": "NixOS"
            },
            {
                "link": "deploying/arch-linux",
                "text": "Arch Linux"
            },
            {
                "link": "deploying/freebsd",
                "text": "FreeBSD"
            },
            {
                "link": "deploying/kubernetes",
                "text": "Kubernetes"
            },
            {
                "link": "deploying/nomad",
                "text": "Nomad"
            }
        ],
    }}
/>

## Post-installation

After Continuwuity is up and running, consider the following:

- For smooth federation, set up a caching resolver according to the [**DNS tuning guide**](./guides/dns.mdx) (strongly recommended).

- To set up Audio/Video communication, see the [**Calls**](./calls.mdx) page.

- See the [**Authentication chapter**] for various ways to access to your homeserver, such as logging in with an external OIDC provider.

- Consult the [**Maintenance**](./maintenance.mdx) page for guidance on maintaining your homeserver.

- If you want to set up an appservice, take a look at the [**Appservice Guide**](./appservices.mdx).

- See the [**Troubleshooting**](./troubleshooting.mdx) page for commonly diagnosed issues.