Skip to main content

Appwrite

Appwrite is an end-to-end backend server that aims to abstract the complexities of common, complicated, and repetitive processes involved in developing modern apps.

Appwrite provides a set of APIs, tools, and a management panel UI to assist you in building apps much faster and more securely. User authentication and account administration, user preferences, database and storage persistence, cloud functions, localization, image manipulation, scheduled background tasks, and more are all available through Appwrite's various services.

Appwrite is technology agnostic and cross-platform, meaning it can run on any operating system, programming language, framework, or platform. Although Appwrite fits the definition of a serverless technology, it's built to work in a variety of environments. Appwrite can be integrated directly into your client app, used behind your custom backend, or used in conjunction with your custom backend server.

Installation

The Appwrite backend server is built to work in a container environment. It's as simple as typing one command into your console to start your server. You can use docker-compose to execute Appwrite locally, or any other container orchestration technology such as Kubernetes, Docker Swarm, or Rancher.

Our docker-compose file is the simplest method to get your Appwrite server up and running. Make sure Docker is installed on your machine before performing the installation command:

UNIX

docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:0.10.4

Windows

CMD

docker run -it --rm ^
    --volume //var/run/docker.sock:/var/run/docker.sock ^
    --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
    --entrypoint="install" ^
    appwrite/appwrite:0.10.4

Powershell

docker run -it --rm ,
    --volume /var/run/docker.sock:/var/run/docker.sock ,
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ,
    --entrypoint="install" ,
    appwrite/appwrite:0.10.4

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.

Services

  • Account - Manage current user authentication and account. Track and manage the user sessions, devices, sign-in methods, and security logs.
  • Users - Manage and list all project users when in admin mode.
  • Teams - Manage and group users in teams. Manage memberships, invites, and user roles within a team.
  • Database - Manage database collections and documents. Read, create, update, and delete documents and filter lists of document collections using advanced filters.
  • Storage - Manage storage files. Read, create, delete, and preview files. Manipulate the preview of your files to fit your app perfectly. All files are scanned by ClamAV and stored in a secure and encrypted way.
  • Functions - Customize your Appwrite server by executing your custom code in a secure, isolated environment. You can trigger your code on any Appwrite system event, manually or using a CRON schedule.
  • Locale - Track your user's location, and manage your app locale-based data.
  • Avatars - Manage your users' avatars, countries' flags, browser icons, credit card symbols, and generate QR codes.

SDKs

Below is a list of currently supported platforms and languages.

  • Maintained by the Appwrite Team

    1. Client

    • Web
    • Flutter
    • Android

    2. Server

    • NodeJS
    • PHP
    • Dart
    • Deno
    • Ruby
    • Python
    • Kotlin
    • .NET

  • Maintained by Michael Gangolf

    1. Community

    • Appcelerator Titanium