|
1 | 1 | <p>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 <a href="https://www.docker.com/products/docker-desktop" target="_blank" rel="noopener">Docker CLI</a>. Self-hosted Appwrite instances can be configured flexibly with access to the same features found on Appwrite Cloud.</p> |
2 | 2 |
|
3 | | -<h2><a href="/docs/installation#systemRequirements" id="systemRequirements">System Requirements</a></h2> |
| 3 | +<h2><a href="#systemRequirements" id="systemRequirements">System Requirements</a></h2> |
4 | 4 |
|
5 | 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 |
|
|
11 | 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 | 12 | </div> |
13 | 13 |
|
14 | | -<h2><a href="/docs/installation#installWithDocker" id="installWithDocker">Install with Docker</a></h2> |
| 14 | +<h2><a href="#installWithDocker" id="installWithDocker">Install with Docker</a></h2> |
15 | 15 |
|
16 | 16 | <p>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 <a href="https://www.docker.com/products/docker-desktop" target="_blank" rel="noopener">Docker CLI</a> installed on your host machine.</p> |
17 | 17 |
|
|
23 | 23 | <li>Your Appwrite instance's DNS A record hostname. Typically set to the same value as your Appwrite instance's hostname.</li> |
24 | 24 | </ol> |
25 | 25 |
|
26 | | -<h3><a href="/docs/installation#unix" id="unix">Unix</a></h3> |
| 26 | +<h3><a href="#unix" id="unix">Unix</a></h3> |
27 | 27 |
|
28 | 28 | <div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash"> |
29 | 29 | <pre class="line-numbers"><code class="prism language-bash" data-prism>docker run -it --rm \ |
|
33 | 33 | appwrite/appwrite:<?php echo APP_VERSION_STABLE; ?></code></pre> |
34 | 34 | </div> |
35 | 35 |
|
36 | | -<h3><a href="/docs/installation#windows" id="windows">Windows</a></h3> |
| 36 | +<h3><a href="#windows" id="windows">Windows</a></h3> |
37 | 37 |
|
38 | 38 | <p>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 <a href="https://docs.docker.com/desktop/windows/install/" target="_blank" rel="noopener">Docker Desktop</a> which uses Virtualbox to run Appwrite on a Virtual Machine.</p> |
39 | 39 |
|
|
63 | 63 | </li> |
64 | 64 | </ul> |
65 | 65 |
|
66 | | -<h2><a href="/docs/installation#one-click-setups" id="one-click-setups">One-Click Setups</a></h2> |
| 66 | +<h2><a href="#one-click-setups" id="one-click-setups">One-Click Setups</a></h2> |
67 | 67 |
|
68 | 68 | <p> |
69 | 69 | In addition to running Appwrite locally, you can also launch Appwrite using a pre-configured setup. |
|
108 | 108 | </tbody> |
109 | 109 | </table> |
110 | 110 |
|
111 | | -<h2><a href="/docs/installation#next-steps" id="next-steps">Next Steps</a></h2> |
| 111 | +<h2><a href="#next-steps" id="next-steps">Next Steps</a></h2> |
112 | 112 | <p>Self-hosting Appwrite gives you more configurable options. You can customize Appwrite with your choice of S3 compatible storage adaptors, email and SMS providers, functions runtimes, and more.</p> |
113 | 113 | <p><a href="/docs/configuration">Learn about configuring Appwrite</a></p> |
114 | 114 |
|
115 | 115 | <p>Self-hosted Appwrite instances can be made production ready. To run Appwrite successfully in a production environment, you should follow a few basic concepts and best practices.</p> |
116 | 116 | <p><a href="/docs/production">Learn about Appwrite in production</a></p> |
117 | 117 |
|
118 | | -<h2><a href="/docs/installation#manual" id="manual">Manual (using docker-compose.yml)</a></h2> |
| 118 | +<h2><a href="#manual" id="manual">Manual (using docker-compose.yml)</a></h2> |
119 | 119 |
|
120 | 120 | <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> |
121 | 121 |
|
|
125 | 125 |
|
126 | 126 | <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> |
127 | 127 |
|
128 | | -<h2><a href="/docs/installation#stop" id="stop">Stop</a></h2> |
| 128 | +<h2><a href="#stop" id="stop">Stop</a></h2> |
129 | 129 |
|
130 | 130 | <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> |
131 | 131 |
|
132 | 132 | <div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash"> |
133 | 133 | <pre class="line-numbers"><code class="prism language-bash" data-prism>docker compose stop</code></pre> |
134 | 134 | </div> |
135 | 135 |
|
136 | | -<h2><a href="/docs/installation#uninstall" id="uninstall">Uninstall</a></h2> |
| 136 | +<h2><a href="#uninstall" id="uninstall">Uninstall</a></h2> |
137 | 137 |
|
138 | 138 | <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> |
139 | 139 |
|
|
0 commit comments