|
1 |
| -<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> |
| 1 | +<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> |
2 | 2 |
|
3 | 3 | <h2><a href="/docs/installation#systemRequirements" id="systemRequirements">System Requirements</a></h2>
|
4 | 4 |
|
5 |
| -<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> |
| 5 | +<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> |
| 6 | + |
6 | 7 |
|
7 | 8 | <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>
|
8 | 9 |
|
9 | 10 | <div class="notice margin-bottom">
|
10 | 11 | <h3>Upgrading From Older Versions</h3>
|
11 |
| - <p>If you are migrating from an older version of Appwrite, you need to follow the <a href="/docs/upgrade">migration instructions</a></p> |
| 12 | + <p>If you are migrating from an older version of Appwrite, you need to follow the <a href="/docs/upgrade">migration instructions</a>.</p> |
12 | 13 | </div>
|
13 | 14 |
|
14 | 15 | <h2><a href="/docs/installation#installWithDocker" id="installWithDocker">Install with Docker</a></h2>
|
|
102 | 103 |
|
103 | 104 | <h3><a href="/docs/installation#manual" id="manual">Manual (using docker-compose.yml)</a></h3>
|
104 | 105 |
|
105 |
| -<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> |
| 106 | +<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> |
106 | 107 |
|
107 | 108 | <div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
|
108 | 109 | <pre class="line-numbers"><code class="prism language-bash" data-prism>docker compose up -d --remove-orphans</code></pre>
|
109 | 110 | </div>
|
110 | 111 |
|
111 |
| -<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> |
| 112 | +<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> |
112 | 113 |
|
113 | 114 | <h3><a href="/docs/installation#stop" id="stop">Stop</a></h3>
|
114 | 115 |
|
115 |
| -<p>You can stop your Appwrite containers by using the following command executed from the same directory as your docker-compose.yml file.</p> |
| 116 | +<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> |
116 | 117 |
|
117 | 118 | <div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
|
118 | 119 | <pre class="line-numbers"><code class="prism language-bash" data-prism>docker compose stop</code></pre>
|
119 | 120 | </div>
|
120 | 121 |
|
121 | 122 | <h3><a href="/docs/installation#uninstall" id="uninstall">Uninstall</a></h3>
|
122 | 123 |
|
123 |
| -<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> |
| 124 | +<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> |
124 | 125 |
|
125 | 126 | <div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
|
126 | 127 | <pre class="line-numbers"><code class="prism language-bash" data-prism>docker compose down -v</code></pre>
|
127 | 128 | </div>
|
128 | 129 |
|
129 | 130 | <h2><a href="/docs/installation#learnMore" id="learnMore">Learn More</a></h2>
|
130 | 131 |
|
131 |
| -<ul> |
| 132 | +<ul class="margin-top margin-bottom-large text-size-normal"> |
132 | 133 | <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>
|
133 | 134 | <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>
|
134 | 135 | <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>
|
|
0 commit comments