From 5372706c95d2128be690a05edfebce39e53fb0dc Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 29 Sep 2023 03:30:33 +0000 Subject: [PATCH 1/3] Use the correct self-hosting page --- .../docs/advanced/self-hosting/+page.markdoc | 30 +++- .../self-hosting/installation/+page.markdoc | 129 ------------------ 2 files changed, 23 insertions(+), 136 deletions(-) delete mode 100644 src/routes/docs/advanced/self-hosting/installation/+page.markdoc diff --git a/src/routes/docs/advanced/self-hosting/+page.markdoc b/src/routes/docs/advanced/self-hosting/+page.markdoc index 0f52e75e62..2edaa45be2 100644 --- a/src/routes/docs/advanced/self-hosting/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/+page.markdoc @@ -1,7 +1,7 @@ --- layout: article -title: Installation -description: Explore advanced self-hosting options with Appwrite. Learn how to gain full control of your Appwrite deployment, customize settings, and enhance your infrastructure. +title: Self-hosting +description: Set up your self-hosted Appwrite instance with ease. Follow the installation guide to configure and deploy Appwrite on your infrastructure for complete control. --- Appwrite was designed from the ground up with self-hosting in mind. You can install and run Appwrite on any operating system that can run a [Docker CLI](https://www.docker.com/products/docker-desktop). Self-hosted Appwrite instances can be configured flexibly with access to the same features found on Appwrite Cloud. @@ -65,11 +65,27 @@ In addition to running Appwrite locally, you can also launch Appwrite using a pr Choose from one of the providers below: -  |Provider | Installation Link ---- | --- | --- - {% icon icon="do" /%}| DigitalOcean | [Click to install](https://marketplace.digitalocean.com/apps/appwrite) - {% icon icon="gitpod" /%}| Gitpod | [Click to install](https://gitpod.io/#https://github.com/appwrite/integration-for-gitpod) - {% icon icon="akamai" /%}| Akamai Compute | [Click to install](https://www.linode.com/marketplace/apps/appwrite/appwrite/) +{% table %} +*   +* Provider +* Installation Link +--- +* {% only_dark %}{% icon_image src="/images/one-click/dark/digitalocean.svg" alt="DigitalOcean logo" size="m" /%}{% /only_dark %} +{% only_light %}{% icon_image src="/images/one-click/digitalocean.svg" alt="DigitalOcean logo" size="m" /%}{% /only_light %} +* DigitalOcean +* [Click to install](https://marketplace.digitalocean.com/apps/appwrite) +--- +* {% only_dark %}{% icon_image src="/images/one-click/dark/gitpod.svg" alt="Gitpod logo" size="m" /%}{% /only_dark %} +{% only_light %}{% icon_image src="/images/one-click/gitpod.svg" alt="Gitpod logo" size="m" /%}{% /only_light %} +* Gitpod +* [Click to install](https://gitpod.io/#https://github.com/appwrite/integration-for-gitpod) +--- +* {% only_dark %}{% icon_image src="/images/one-click/dark/akamai.svg" alt="Akamai logo" size="m" /%}{% /only_dark %} +{% only_light %}{% icon_image src="/images/one-click/akamai.svg" alt="Akamai logo" size="m" /%}{% /only_light %} +* Akamai Compute +* [Click to install](https://www.linode.com/marketplace/apps/appwrite/appwrite/) +{% /table %} + # Next steps {% #next-steps %} diff --git a/src/routes/docs/advanced/self-hosting/installation/+page.markdoc b/src/routes/docs/advanced/self-hosting/installation/+page.markdoc deleted file mode 100644 index 963cbb65a1..0000000000 --- a/src/routes/docs/advanced/self-hosting/installation/+page.markdoc +++ /dev/null @@ -1,129 +0,0 @@ ---- -layout: article -title: Installation -description: Set up your self-hosted Appwrite instance with ease. Follow the installation guide to configure and deploy Appwrite on your infrastructure for complete control. ---- - -Appwrite was designed from the ground up with self-hosting in mind. You can install and run Appwrite on any operating system that can run a [Docker CLI](https://www.docker.com/products/docker-desktop). Self-hosted Appwrite instances can be configured flexibly with access to the same features found on Appwrite Cloud. - -# System requirements {% #system-requirements %} - -Appwrite is designed to run well on both small and large deployments. The minimum requirements to run Appwrite are as little as **1 CPU core** and **2GB of RAM**, and an operating system that supports Docker. - -Appwrite requires [Docker Compose Version 2](https://docs.docker.com/compose/install/). To install Appwrite, make sure your Docker installation is updated to support Composer V2. - -{% info title="Upgrading From Older Versions" %} -If you are migrating from an older version of Appwrite, you need to follow the [migration instructions](/docs/advanced/self-hosting/update) -{% /info %} - -# Install with Docker {% #install-with-docker %} - -The easiest way to start running your Appwrite server is by running our Docker installer tool from your terminal. Before running the installation command, make sure you have [Docker CLI](https://www.docker.com/products/docker-desktop) installed on your host machine. - -You will be prompted to configure the following during the setup command: - -1. Your Appwrite instance's HTTP and HTTPS ports. -2. Your Appwrite instance's secret key used to encrypt sensitive data. -3. Your Appwrite instance's main hostname. Appwrite will generate a certificate using this hostname. -4. Your Appwrite instance's DNS A record hostname. Typically set to the same value as your Appwrite instance's hostname. - -{% tabs %} -{% tabsitem #unix title="macOS and Linux" %} -## Bash -```sh -docker run -it --rm \ - --volume /var/run/docker.sock:/var/run/docker.sock \ - --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \ - --entrypoint="install" \ - appwrite/appwrite:1.4.3 -``` -{% /tabsitem %} - -{% tabsitem #windows title="Windows" %} -## CMD -```cmd -docker run -it --rm ^ - --volume //var/run/docker.sock:/var/run/docker.sock ^ - --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^ - --entrypoint="install" ^ - appwrite/appwrite:1.4.3 -``` -## Powershell -```powershell -docker run -it --rm ` - --volume /var/run/docker.sock:/var/run/docker.sock ` - --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ` - --entrypoint="install" ` - appwrite/appwrite:1.4.3 -``` -{% /tabsitem %} -{% /tabs %} - -# One-click setups {% #one-click-setups %} - -In addition to running Appwrite locally, you can also launch Appwrite using a pre-configured setup. This allows you to get up and running with Appwrite quickly without installing Docker on your local machine. - -Choose from one of the providers below: - -{% table %} -*   -* Provider -* Installation Link ---- -* {% only_dark %}{% icon_image src="/images/one-click/dark/digitalocean.svg" alt="DigitalOcean logo" size="m" /%}{% /only_dark %} -{% only_light %}{% icon_image src="/images/one-click/digitalocean.svg" alt="DigitalOcean logo" size="m" /%}{% /only_light %} -* DigitalOcean -* [Click to install](https://marketplace.digitalocean.com/apps/appwrite) ---- -* {% only_dark %}{% icon_image src="/images/one-click/dark/gitpod.svg" alt="Gitpod logo" size="m" /%}{% /only_dark %} -{% only_light %}{% icon_image src="/images/one-click/gitpod.svg" alt="Gitpod logo" size="m" /%}{% /only_light %} -* Gitpod -* [Click to install](https://gitpod.io/#https://github.com/appwrite/integration-for-gitpod) ---- -* {% only_dark %}{% icon_image src="/images/one-click/dark/akamai.svg" alt="Akamai logo" size="m" /%}{% /only_dark %} -{% only_light %}{% icon_image src="/images/one-click/akamai.svg" alt="Akamai logo" size="m" /%}{% /only_light %} -* Akamai Compute -* [Click to install](https://www.linode.com/marketplace/apps/appwrite/appwrite/) -{% /table %} - - -# Next steps {% #next-steps %} - -Self-hosting Appwrite gives you more configurable options. -Make these configurations to unlock the full power of Appwrite. - -[Configure Appwrite Functions](/docs/advanced/self-hosting/functions) - -[Configure email delivery](/docs/advanced/self-hosting/email) - -[Configure SMS delivery](/docs/advanced/self-hosting/sms) - -[Configure Appwrite Storage](/docs/advanced/self-hosting/storage) - -[Configure TLS Certificates](/docs/advanced/self-hosting/tls-certificates) - -# Manual (Docker Compose) {% #manual %} - -For advanced Docker users, the manual installation might seem more familiar. To set up Appwrite manually, download the Appwrite base `docker-compose.yml` and `.env` files, then move them inside a directory named `appwrite`. After the download completes, update the different environment variables as you wish in the `.env` file and start the Appwrite stack using the following Docker command: - -```bash -docker compose up -d --remove-orphans -``` - -Once the Docker installation completes, go to your machine's hostname or IP address on your browser to access the Appwrite Console. Please note that on hosts that are not Linux-native, the server might take a few minutes to start after installation completes. - -# Stop {% #stop %} - -You can stop your Appwrite containers by using the following command executed from the same directory as your `docker-compose.yml` file. - -```bash -docker compose stop -``` - -# Uninstall {% #uninstall %} - -To stop and remove your Appwrite containers, you can use the following command executed from the same directory as your `docker-compose.yml` file. - -```bash -docker compose down -v -``` \ No newline at end of file From 7f033dca88de26be4a9d08e5e4ce963e9c99c4f8 Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Fri, 29 Sep 2023 12:28:32 +0200 Subject: [PATCH 2/3] fix: icon size --- src/routes/docs/advanced/self-hosting/+page.markdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/routes/docs/advanced/self-hosting/+page.markdoc b/src/routes/docs/advanced/self-hosting/+page.markdoc index 2edaa45be2..a0433453cb 100644 --- a/src/routes/docs/advanced/self-hosting/+page.markdoc +++ b/src/routes/docs/advanced/self-hosting/+page.markdoc @@ -66,7 +66,7 @@ In addition to running Appwrite locally, you can also launch Appwrite using a pr Choose from one of the providers below: {% table %} -*   +*   {% width=48 %} * Provider * Installation Link --- From 7e54e11901eb85dbdc1cddac76331edb09df2cfb Mon Sep 17 00:00:00 2001 From: Torsten Dittmann Date: Fri, 29 Sep 2023 12:28:37 +0200 Subject: [PATCH 3/3] fix: typo on landing page --- src/lib/animations/Products/Products.svelte | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/animations/Products/Products.svelte b/src/lib/animations/Products/Products.svelte index 0305360529..2f00e28c12 100644 --- a/src/lib/animations/Products/Products.svelte +++ b/src/lib/animations/Products/Products.svelte @@ -33,7 +33,7 @@ '30+ login methods', 'Support for teams, roles and user labels', 'Rate-limits and advanced user protection', - 'Custome SMTP and email templates' + 'Custom SMTP and email templates' ], shot: './images/products/auth.png' },