Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

Commit

Permalink
Merge pull request #275 from appwrite/install-style-update
Browse files Browse the repository at this point in the history
Update Install guide to conform to guidelines proposed in PR #229.
  • Loading branch information
christyjacob4 authored Nov 14, 2022
2 parents 3b0f164 + e9bec47 commit a3ccf6d
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions app/views/docs/installation.phtml
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
<p>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 <a href="https://www.docker.com/products/docker-desktop" target="_blank" rel="noopener">Docker CLI</a>. You can use Appwrite on your local desktop or a cloud provider of your choice.</p>
<p>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 <a href="https://www.docker.com/products/docker-desktop" target="_blank" rel="noopener">Docker CLI</a>. You can use Appwrite on your local machine or a cloud provider of your choice.</p>

<h2><a href="/docs/installation#systemRequirements" id="systemRequirements">System Requirements</a></h2>

<p>Appwrite is designed to run well in both small and large deployments. The minimum requirements to run Appwrite is as little as <b>1 CPU core</b>, <b>2GB of RAM</b>, and an operating system that supports Docker.</p>
<p>Appwrite is designed to run well on both small and large deployments. The minimum requirements to run Appwrite are as little as <b>1 CPU core</b> and <b>2GB of RAM</b>, and an operating system that supports Docker.</p>


<p>Appwrite requires <a href="https://docs.docker.com/compose/install/" target="_blank" rel="noopener">Docker Compose Version 2</a>. To install Appwrite, make sure your Docker installation is updated to support Composer V2.</p>

<div class="notice margin-bottom">
<h3>Upgrading From Older Versions</h3>
<p>If you are migrating from an older version of Appwrite, you need to follow the <a href="/docs/upgrade">migration instructions</a></p>
<p>If you are migrating from an older version of Appwrite, you need to follow the <a href="/docs/upgrade">migration instructions</a>.</p>
</div>

<h2><a href="/docs/installation#installWithDocker" id="installWithDocker">Install with Docker</a></h2>
Expand Down Expand Up @@ -102,33 +103,33 @@

<h3><a href="/docs/installation#manual" id="manual">Manual (using docker-compose.yml)</a></h3>

<p>For advanced Docker users, the manual installation might seem more familiar. To setup Appwrite manually, download the Appwrite base <a href="/install/compose" target="_blank">docker-compose.yml</a> and <a href="/install/env" target="_blank">.env</a> 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:</p>
<p>For advanced Docker users, the manual installation might seem more familiar. To set up Appwrite manually, download the Appwrite base <a href="/install/compose" target="_blank">docker-compose.yml</a> and <a href="/install/env" target="_blank">.env</a> files, then move them inside a directory named <code>appwrite</code>. After the download completes, update the different environment variables as you wish in the <code>.env</code> file and start the Appwrite stack using the following Docker command:</p>

<div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
<pre class="line-numbers"><code class="prism language-bash" data-prism>docker compose up -d --remove-orphans</code></pre>
</div>

<p>Once the Docker installation completes, go to your machine's hostname or IP address in your browser to access the Appwrite console. Please note that on non-linux native hosts the server might take a few minutes to start after the installation is complete.</p>
<p>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.</p>

<h3><a href="/docs/installation#stop" id="stop">Stop</a></h3>

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

<div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
<pre class="line-numbers"><code class="prism language-bash" data-prism>docker compose stop</code></pre>
</div>

<h3><a href="/docs/installation#uninstall" id="uninstall">Uninstall</a></h3>

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

<div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
<pre class="line-numbers"><code class="prism language-bash" data-prism>docker compose down -v</code></pre>
</div>

<h2><a href="/docs/installation#learnMore" id="learnMore">Learn More</a></h2>

<ul>
<ul class="margin-top margin-bottom-large text-size-normal">
<li class="margin-bottom-tiny"><a href="/docs/production" rel="noopener"><i class="icon-angle-circled-right margin-start-negative-tiny margin-end-tiny"></i> Running Appwrite in production</a></li>
<li class="margin-bottom-tiny"><a href="/docs/environment-variables" rel="noopener"><i class="icon-angle-circled-right margin-start-negative-tiny margin-end-tiny"></i> Appwrite server environment variables</a></li>
<li class="margin-bottom-tiny"><a href="/docs/email-delivery" rel="noopener"><i class="icon-angle-circled-right margin-start-negative-tiny margin-end-tiny"></i> Appwrite setting a custom SMTP server</a></li>
Expand Down

0 comments on commit a3ccf6d

Please sign in to comment.