From 25f59e3e2c8c9df3452c5b29da9c0131b2f09206 Mon Sep 17 00:00:00 2001 From: stratself Date: Wed, 23 Sep 2026 10:01:15 +0000 Subject: [PATCH] docs(deploying): Add baseline instructions and buttons for installation The OverviewGroup thingy is hardcoded for now because figuring out rspress hooks to read from _meta.json is a pain. --- docs/deploying.mdx | 66 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 62 insertions(+), 4 deletions(-) diff --git a/docs/deploying.mdx b/docs/deploying.mdx index 76c610a5b..996c36b6e 100644 --- a/docs/deploying.mdx +++ b/docs/deploying.mdx @@ -1,6 +1,8 @@ +import { OverviewGroup } from '@rspress/core/theme'; + # Deploying -This chapter describes various ways to deploy Continuwuity. Read more on this page for useful general information, and then proceed to one of the deployment methods. +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]. @@ -32,15 +34,71 @@ For regular releases, **always read the release notes before upgrading to a new ## Installation +To have Continuwuity working, you'll 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 be using Caddy for our guides. +5. And finally, start the Continuwuity service. + Navigate to the pages in this section that corresponds to your desired method of deploying Continuwuity, and follow the instructions there. + + ## Post-installation After successfully deploying Continuwuity, these next steps can be done: - 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 configure 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. + +- See the [**Authentication chapter**] for various ways to configure 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. + +- See the [**Troubleshooting**](./troubleshooting.mdx) page for commonly diagnosed issues.