From 69ca10a34736db53947ad6effa7be67c6cf876b0 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Wed, 15 Jun 2022 14:50:26 +0000 Subject: [PATCH 1/3] updates installation doc to mention dependency on v2 --- app/views/docs/installation.phtml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/app/views/docs/installation.phtml b/app/views/docs/installation.phtml index 6ae4cf1fe..5b1ffdec2 100644 --- a/app/views/docs/installation.phtml +++ b/app/views/docs/installation.phtml @@ -4,6 +4,8 @@

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.

+

As of version 0.14, Appwrite requires Docker Compose Version 2. To install Appwrite, make sure your Docker installation is updated to support Composer V2.

+

Upgrading From Older Versions

If you are migrating from an older version of Appwrite, you need to follow the migration instructions

From 9f66cf23b367e72c838a7e04e4e982c1e9770ae3 Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Thu, 16 Jun 2022 14:16:40 +0000 Subject: [PATCH 2/3] update docker compose commands --- app/views/docs/certificates.phtml | 6 +++--- app/views/docs/debugging.phtml | 2 +- app/views/docs/email-delivery.phtml | 8 ++++---- app/views/docs/environment-variables.phtml | 2 +- app/views/docs/installation.phtml | 8 ++++---- app/views/docs/upgrade.phtml | 8 +++----- 6 files changed, 16 insertions(+), 18 deletions(-) diff --git a/app/views/docs/certificates.phtml b/app/views/docs/certificates.phtml index 15247b889..e4cba15f5 100644 --- a/app/views/docs/certificates.phtml +++ b/app/views/docs/certificates.phtml @@ -12,7 +12,7 @@

If you're still struggling with your certificates, check the Appwrite certificates worker log. You can do that with the following command:

- 
docker-compose logs appwrite-worker-certificates
+ 
docker compose logs appwrite-worker-certificates

Generation Cycle

@@ -28,13 +28,13 @@

Since Appwrite generates and renews certificates automatically, a manual generation is seldom required. A manual generation can be useful when you hit the API limit and don't want to wait for the next maintenance cycle to renew the certificate. Use the following command to generate a certificate for your main domain:

- 
docker-compose exec appwrite ssl
+ 
docker compose exec appwrite ssl

If you want to generate a certificate for a specific domain, pass it as a parameter into the command:

- 
docker-compose exec appwrite ssl domain="api.myapp.com"
+ 
docker compose exec appwrite ssl domain="api.myapp.com"

Dev Environment and Localhosts

diff --git a/app/views/docs/debugging.phtml b/app/views/docs/debugging.phtml index a089b1ae0..fa1ea1e7c 100644 --- a/app/views/docs/debugging.phtml +++ b/app/views/docs/debugging.phtml @@ -53,5 +53,5 @@ environment:

After you completed the change in the docker-compose.yml file, save it and run the following command to restart Appwrite with your new settings:

- 
docker-compose up -d
+ 
docker compose up -d
diff --git a/app/views/docs/email-delivery.phtml b/app/views/docs/email-delivery.phtml index 46cdf37a0..8290c416d 100644 --- a/app/views/docs/email-delivery.phtml +++ b/app/views/docs/email-delivery.phtml @@ -35,7 +35,7 @@ _APP_SMTP_PASSWORD=YOUR-SMTP-PASSWORD

Once you've updated your .env file, you need to restart your Appwrite stack using the following command from your terminal:

- 
docker-compose up -d
+ 
docker compose up -d

Debugging

@@ -43,7 +43,7 @@ _APP_SMTP_PASSWORD=YOUR-SMTP-PASSWORD

If you are unable to send emails, there is most likely an issue with your integration. The first place to look for possible errors is the Appwrite Emails Worker. You can access the logs of this container using:

- 
docker-compose logs -f appwrite-worker-mails
+ 
docker compose logs -f appwrite-worker-mails

@@ -56,13 +56,13 @@ The next possible source of error is the configuration in your .env file. Make s

Another source of error could be that the environment variables have not been set in the appwrite container. You can check this using

- 
docker-compose exec appwrite-worker-mails vars
+ 
docker compose exec appwrite-worker-mails vars

If this is the case, you can try rebuilding your appwrite stack using:

- 
docker-compose up -d --build --force-recreate
+ 
docker compose up -d --build --force-recreate

Now you can head over to your Appwrite console, logout from your account and try to recover your password or send invites to other team members from your Appwrite console using your newly configured SMTP provider.

diff --git a/app/views/docs/environment-variables.phtml b/app/views/docs/environment-variables.phtml index 7c5cac537..65eb9fe9a 100644 --- a/app/views/docs/environment-variables.phtml +++ b/app/views/docs/environment-variables.phtml @@ -12,7 +12,7 @@ $markdown->setSafeMode(true);

After editing your docker-compose.yml or .env files, you will need to restart your Appwrite stack by running the following compose command in your terminal:

- 
docker-compose up -d
+ 
docker compose up -d

All Options:

diff --git a/app/views/docs/installation.phtml b/app/views/docs/installation.phtml index 5b1ffdec2..e6c5f3d87 100644 --- a/app/views/docs/installation.phtml +++ b/app/views/docs/installation.phtml @@ -4,7 +4,7 @@

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.

-

As of version 0.14, Appwrite requires Docker Compose Version 2. To install Appwrite, make sure your Docker installation is updated to support Composer V2.

+

Appwrite requires Docker Compose Version 2. To install Appwrite, make sure your Docker installation is updated to support Composer V2.

Upgrading From Older Versions

@@ -105,7 +105,7 @@

For advanced Docker users, the manual installation might seem more familiar. To setup Appwrite manually, download the Appwrite base docker-compose.yml and .env files. 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:

- 
docker-compose up -d --remove-orphans
+ 
docker compose up -d --remove-orphans

Once the Docker installation completes, go to your machine hostname or IP address on your browser to access the Appwrite console. Please notice that on non-linux native hosts the server might take a few minutes to start after installation completes.

@@ -115,7 +115,7 @@

You can stop your Appwrite containers by using the following command executed from the same directory as your docker-compose.yml file.

- 
docker-compose stop
+ 
docker compose stop

Uninstall

@@ -123,7 +123,7 @@

To stop and remove your Appwrite containers you can use the following command executed from the same directory as your docker-compose.yml file.

- 
docker-compose down -v
+ 
docker compose down -v

Learn More

diff --git a/app/views/docs/upgrade.phtml b/app/views/docs/upgrade.phtml index 0b2f656c2..da16a4c24 100644 --- a/app/views/docs/upgrade.phtml +++ b/app/views/docs/upgrade.phtml @@ -1,5 +1,7 @@

To upgrade your Appwrite server from an older version, you should use the Appwrite migration tool after you have installed the new version. The migration tool will adjust your Appwrite data to the new version's structure to make sure your Appwrite data is compatible with any internal changes.

+

As of version 0.14, Appwrite requires Docker Compose Version 2. To install Appwrite, make sure your Docker installation is updated to support Composer V2.

+

A Note About Migration

@@ -10,10 +12,6 @@

It is highly recommended to backup your server data before running the migration. It is recommended to run the migration process on a dev instance and make sure your application is working well and that you have checked for any breaking changes in the new version changelog.

- - - -

The first step is to install the latest version of Appwrite. Head to the directory where you ran your previous Appwrite install command.

@@ -76,7 +74,7 @@ 
cd appwrite/
-docker-compose exec appwrite migrate
+docker compose exec appwrite migrate

The data migration can take longer depending on the amount of data your Appwrite instance contains. The Appwrite migration command uses multi-threading to speed up the process, meaning that adding more CPU cores can help speed up the process.

From 53a78d49679c5d2f8026ed7921bc5b555aa23684 Mon Sep 17 00:00:00 2001 From: Wen Yu Ge Date: Mon, 27 Jun 2022 11:11:00 -0400 Subject: [PATCH 3/3] update link for install in upgrade.phtml --- app/views/docs/upgrade.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/upgrade.phtml b/app/views/docs/upgrade.phtml index da16a4c24..de9d1c32f 100644 --- a/app/views/docs/upgrade.phtml +++ b/app/views/docs/upgrade.phtml @@ -1,6 +1,6 @@

To upgrade your Appwrite server from an older version, you should use the Appwrite migration tool after you have installed the new version. The migration tool will adjust your Appwrite data to the new version's structure to make sure your Appwrite data is compatible with any internal changes.

-

As of version 0.14, Appwrite requires Docker Compose Version 2. To install Appwrite, make sure your Docker installation is updated to support Composer V2.

+

As of version 0.14, Appwrite requires Docker Compose Version 2. To upgrade Appwrite, make sure your Docker installation is updated to support Composer V2.

A Note About Migration