Update README.md

This commit is contained in:
Eldad A. Fux
2020-05-23 22:39:10 +03:00
committed by GitHub
parent af5e0fbef6
commit aad45c7d74
+26 -5
View File
@@ -30,7 +30,8 @@ Appwrite can also integrate really well with your backend. Appwrite can work beh
Table of Contents:
- [Installation](#installation)
- [Changing Port Number](#changing-port-number)
- [Unix](#unix)
- [Windows](#windows)
- [Getting Started](#getting-started)
- [Services](#services)
- [SDKs](#sdks)
@@ -45,6 +46,8 @@ Appwrite backend server is designed to run in a container environment. Running y
The easiest way to start running your Appwrite server is by running our docker-compose file. Before running the installation command make sure you have [Docker](https://www.docker.com/products/docker-desktop) installed on your machine:
### Unix
```bash
docker run -it --rm \
--volume /var/run/docker.sock:/var/run/docker.sock \
@@ -53,15 +56,33 @@ docker run -it --rm \
appwrite/install
```
### Windows
#### CMD
```cmd
docker run -it --rm ^
--volume //var/run/docker.sock:/var/run/docker.sock ^
--volume "%cd%"/appwrite:/install/appwrite:rw ^
-e version=<?php echo APP_VERSION_STABLE; ?> ^
appwrite/install
```
#### PowerShell
```powershell
docker run -it --rm ,
--volume /var/run/docker.sock:/var/run/docker.sock ,
--volume ${pwd}/appwrite:/install/appwrite:rw ,
-e version=0.6.1 ,
appwrite/install
```
Once the Docker installation completes, go to http://localhost to access the Appwrite console from your browser. Please note that on non-linux native hosts, the server might take a few minutes to start after installation completes.
For advanced production and custom installation, check out our Docker [environment variables](docs/tutorials/environment-variables.md) docs.
### Changing Port Number
In case your port 80 is already taken, change the port number in the command above. Make sure to set the correct endpoint in your selected SDK, including your new port number.
## Getting Started
Getting started with Appwrite is as easy as creating a new project, choosing your platform and integrating its SDK in your code. You can easily get started with your platform of choice by reading one of our Getting Started tutorials.