diff --git a/app/views/docs/installation.phtml b/app/views/docs/installation.phtml index dd8a3b9a5..3bcd8c567 100644 --- a/app/views/docs/installation.phtml +++ b/app/views/docs/installation.phtml @@ -1,8 +1,8 @@ -

Appwrite is a self-hosted backend server packaged as a set of Docker containers. You can install and run Appwrite on any operating system that can run a Docker CLI. You can use Appwrite on your local desktop or cloud provider of your choice.

+

Appwrite is a self-hosted backend server packaged as a set of Docker containers. You can install and run Appwrite on any operating system that can run a Docker CLI. You can use Appwrite on your local desktop or the cloud provider of your choice.

System Requirements

-

Appwrite was designed to run well on both small and large deployment. The minimum requirements to run Appwrite is as little as 1 CPU core and 2GB of RAM, and an operating system that supports Docker.

+

Appwrite was 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. To install Appwrite, make sure your Docker installation is updated to support Composer V2.

@@ -27,7 +27,7 @@

Windows

-

Hyper-V and Containers Windows features must be enabled to run Appwrite on Windows with Docker. If you don't have these features available, you can install Docker Desktop that uses Virtualbox to run Appwrite on a Virtual Machine.

+

Hyper-V and Containers Windows features must be enabled to run Appwrite on Windows with Docker. If you don't have these features available, you can install Docker Desktop which uses Virtualbox to run Appwrite on a Virtual Machine.

+ \ No newline at end of file diff --git a/app/views/docs/production.phtml b/app/views/docs/production.phtml index fc4e85744..9bd7ddff1 100644 --- a/app/views/docs/production.phtml +++ b/app/views/docs/production.phtml @@ -8,7 +8,7 @@

Best Practice

-

You should always prefer https over http in production environments. This keeps your APIs secure and prevents any redirects from interfering with your requests.

+

You should always prefer HTTPS over HTTP in production environments. This keeps your APIs secure and prevents any redirects from interfering with your requests.

Limit Console Access

@@ -31,20 +31,20 @@

Sending emails is hard. There are a lot of SPAM rules and configurations to master in order to set a functional SMTP server. The SMTP server that comes packaged with Appwrite is great for development but needs some work done to function well against SPAM filters.

-

Another easier option is to use an ‘SMTP as a service’ product like Sendgrid or Mailgun. You can change Appwrite SMTP settings and credentials to any 3rd party provider you like who support SMTP integration using our Docker environment variables. Most SMTP providers offer a decent free tier to get started with.

+

Another easier option is to use an ‘SMTP as a service’ product like Sendgrid or Mailgun. You can change Appwrite SMTP settings and credentials to any 3rd party provider you like who supports SMTP integration using our Docker environment variables. Most SMTP providers offer a decent free tier to get started with.

Backups

Backups are highly recommended for any production environment. Currently, there is no built-in script we provide to do this automatically. To be able to backup your Appwrite server data, stats, and files, you will need to do the following.

    -
  1. Create a script to backups and restore your MariaDB Appwrite schema. Note that trying to backup MariaDB using a docker volume backup can result in a corrupted copy of your data. It is recommended to use MariaDB or MySQL built-in tools for this.
    2. -
  2. Create a script to backups and restore your InfluxDB stats. If you don’t care much about your server stats, you can skip this.
    3. -
  3. Create a script to backup Appwrite storage volume. There are many online resources explaining different ways to backup a docker volume. When running on multiple servers, it is very recommended to use an attachable storage point. Some cloud providers offer integrated backups to such attachable mount like GCP, AWS, DigitalOcean, and the list continues.
    4. +
  4. Create a script to backups and restore your MariaDB Appwrite schema. Note that trying to backup MariaDB using a docker volume backup can result in a corrupted copy of your data. It is recommended to use MariaDB or MySQL built-in tools for this.
    5. +
  5. Create a script to backups and restore your InfluxDB stats. If you don’t care much about your server stats, you can skip this.
    6. +
  6. Create a script to backup Appwrite storage volume. There are many online resources explaining different ways to backup a docker volume. When running on multiple servers, it is very recommended to use an attachable storage point. Some cloud providers offer integrated backups to such attachable mount like GCP, AWS, DigitalOcean, and the list continues.

Error Reporting

By default, your Appwrite installation comes with error reporting turned off. You can turn it on in dev mode to try and debug issues or report problems.

-

In production, it is highly recommended to turn error reporting off. To do so, make sure the Appwrite container environment variable _APP_ENV value from is set to production and not development.

+

In production, it is highly recommended to turn error reporting off. To do so, make sure the Appwrite container environment variable _APP_ENV value from is set to production and not development.

\ No newline at end of file