Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.
TypeScript i18nextnext-authnextjspostgresqlprismareact-emailt3-stacktailwindcsstrpcturborepotypescriptzod
π Update docs to use Rallly CLI
Luke Vellad7c0dffa9d43
diff --git a/apps/docs/self-hosting/installation/docker.mdx b/apps/docs/self-hosting/installation/docker.mdxindex 93ec7f11b..5088cb64d 100644--- a/apps/docs/self-hosting/installation/docker.mdx+++ b/apps/docs/self-hosting/installation/docker.mdx@@ -4,7 +4,7 @@ title: Installationdescription: Install Rallly on your own server.----This guide installs Rallly using the Docker Compose stack published in the [rallly-selfhosted](https://github.com/lukevella/rallly-selfhosted) repository. The stack includes the app, a bundled PostgreSQL database, bundled S3-compatible object storage, and an HTTPS reverse proxy β everything runs on one machine with no extra setup. If you'd rather use a managed database or object store, see [External services](#external-services).+This guide installs Rallly using the **Rallly CLI**. It bundles the app, a PostgreSQL database, S3-compatible object storage, and an HTTPS reverse proxy β everything runs on one machine with no extra setup. If you'd rather use a managed database or object store, see [External services](#external-services).<Note>Already running Rallly from a hand-edited `docker-compose.yml` or `config.env`? Follow the [upgrade guide](/self-hosting/migration) to move onto the new stack without losing data.@@ -40,23 +40,6 @@ The installer will:On first boot, Traefik will request a Let's Encrypt certificate for your domain. This can take up to a minute. Once it's ready, your instance is available at `https://<your-domain>`.-## Manual install--If you prefer to review the stack before starting it:--```sh-git clone https://github.com/lukevella/rallly-selfhosted.git-cd rallly-selfhosted-./rallly.sh setup-./rallly.sh start-```--`./rallly.sh setup` runs the same interactive configuration as the quick installer and writes a `.env` file. You can also copy `.env.example` to `.env` and fill it in by hand.--<Note>- Only edit `.env` when configuring your instance. Modifying `docker-compose.yml`, `rallly.sh`, or other stack files may cause conflicts when you run `./rallly.sh update`.-</Note>-## Claim the admin accountAfter the stack is running, the first user whose email matches `INITIAL_ADMIN_EMAIL` can navigate to `/control-panel` and claim the admin role. See the [Control Panel guide](/self-hosting/control-panel) for details.diff --git a/apps/docs/self-hosting/management.mdx b/apps/docs/self-hosting/management.mdxindex 809178b6f..e487b0fe4 100644--- a/apps/docs/self-hosting/management.mdx+++ b/apps/docs/self-hosting/management.mdx@@ -1,10 +1,10 @@---icon: terminaltitle: Management-description: Operate a self-hosted Rallly instance with the rallly.sh CLI.+description: Operate a self-hosted Rallly instance with the Rallly CLI.----The `rallly.sh` script bundled with the [self-hosted stack](https://github.com/lukevella/rallly-selfhosted) is the single entry point for day-to-day operations. Run it from the stack directory (e.g. `/opt/rallly` for installer-based setups).+The **Rallly CLI** (`rallly.sh`) is the single entry point for day-to-day operations on a self-hosted instance. It ships with the [self-hosted stack](https://github.com/lukevella/rallly-selfhosted) and should be run from the stack directory (e.g. `/opt/rallly` for installer-based setups).## Commandsdiff --git a/apps/docs/self-hosting/migration.mdx b/apps/docs/self-hosting/migration.mdxindex 7538bc3e3..919bd6a8a 100644--- a/apps/docs/self-hosting/migration.mdx+++ b/apps/docs/self-hosting/migration.mdx@@ -3,7 +3,7 @@ title: Migrate to the new Docker stackdescription: Move an existing self-hosted instance onto the new Docker stack.----Starting with **v4.10**, Rallly Self-Hosted ships as a managed Docker Compose stack with an installer, `rallly.sh` CLI, bundled reverse proxy (Traefik), and bundled object storage (Garage). If you set up Rallly before v4.10 β with a hand-edited `docker-compose.yml`, your own reverse proxy, or a `config.env` file β this guide walks you through the upgrade.+Starting with **v4.10**, Rallly Self-Hosted ships as a managed Docker Compose stack with an installer, the **Rallly CLI** (`rallly.sh`), bundled reverse proxy (Traefik), and bundled object storage (Garage). If you set up Rallly before v4.10 β with a hand-edited `docker-compose.yml`, your own reverse proxy, or a `config.env` file β this guide walks you through the upgrade.<Warning>This guide assumes you will tear down the old stack and run the new stack on the same server. Read every step before starting. A database backup is mandatory.