Appwrite

Using Appwrite, you can easily integrate your app with user authentication and multiple sign-in methods, a database for storing and querying users and team data, storage and file management, image manipulation, Cloud Functions, and more services.

Find out more at: https://appwrite.io.

Table of Contents:

• Getting Started
• Self-Hosting
  • Unix
  • Windows
    • CMD
    • PowerShell
  • Upgrade from an Older Version
• One-Click Setups
• Getting Started
  • Services
  • SDKs
    • Client
    • Server
    • Community
• Architecture
• Contributing
• Security
• Follow Us
• License

Getting Started

The easiest way to get started with Appwrite is by signing up for Appwrite Cloud. While Appwrite Cloud is in public beta, you can build with Appwrite completely free, and we won't collect you credit card information.

Self-Hosting

Appwrite is designed to run in a containerized environment. Running your server is as easy as running one command from your terminal. You can either run Appwrite on your localhost using docker-compose or on any other container orchestration tool, such as Kubernetes, Docker Swarm, or Rancher.

Before running the installation command, make sure you have Docker installed on your machine:

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:1.6.0

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:1.6.0

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:1.6.0

Once the Docker installation is complete, 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 completing the installation.

For advanced production and custom installation, check out our Docker environment variables docs. You can also use our public docker-compose.yml and .env files to manually set up an environment.

Upgrade from an Older Version

If you are upgrading your Appwrite server from an older version, you should use the Appwrite migration tool once your setup is completed. For more information regarding this, check out the Installation Docs.

One-Click Setups

In addition to running Appwrite locally, you can also launch Appwrite using a pre-configured setup. This allows you to get up and running quickly with Appwrite without installing Docker on your local machine.

Choose from one of the providers below:

DigitalOcean

Gitpod

Akamai Compute

AWS Marketplace

Getting Started

Getting started with Appwrite is as easy as creating a new project, choosing your platform, and integrating its SDK into your code. You can easily get started with your platform of choice by reading one of our Getting Started tutorials.

Products

• 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 building backend integrations with Server SDKs.
• Teams - Manage and group users in teams. Manage memberships, invites, and user roles within a team.
• Databases - Manage databases, 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 perfectly fit your app. All files are scanned by ClamAV and stored in a secure and encrypted way.
• Functions - Customize your Appwrite project by executing your custom code in a secure, isolated environment. You can trigger your code on any Appwrite system event either manually or using a CRON schedule.
• Messaging - Communicate with your users through push notifications, emails, and SMS text messages using Appwrite Messaging.
• Realtime - Listen to real-time events for any of your Appwrite services including users, storage, functions, databases, and more.
• Locale - Track your user's location and manage your app locale-based data.
• Avatars - Manage your users' avatars, countries' flags, browser icons, and credit card symbols. Generate QR codes from links or plaintext strings.

For the complete API documentation, visit https://appwrite.io/docs. For more tutorials, news and announcements check out our blog and Discord Server.

SDKs

Below is a list of currently supported platforms and languages. If you would like to help us add support to your platform of choice, you can go over to our SDK Generator project and view our contribution guide.

Client

• :white_check_mark:   Web (Maintained by the Appwrite Team)
• :white_check_mark:   Flutter (Maintained by the Appwrite Team)
• :white_check_mark:   Apple (Maintained by the Appwrite Team)
• :white_check_mark:   Android (Maintained by the Appwrite Team)
• :white_check_mark:   React Native - Beta (Maintained by the Appwrite Team)

Server

• :white_check_mark:   NodeJS (Maintained by the Appwrite Team)
• :white_check_mark:   PHP (Maintained by the Appwrite Team)
• :white_check_mark:   Dart (Maintained by the Appwrite Team)
• :white_check_mark:   Deno (Maintained by the Appwrite Team)
• :white_check_mark:   Ruby (Maintained by the Appwrite Team)
• :white_check_mark:   Python (Maintained by the Appwrite Team)
• :white_check_mark:   Kotlin (Maintained by the Appwrite Team)
• :white_check_mark:   Swift (Maintained by the Appwrite Team)
• :white_check_mark:   .NET - Beta (Maintained by the Appwrite Team)

Community

• :white_check_mark:   Appcelerator Titanium (Maintained by Michael Gangolf)
• :white_check_mark:   Godot Engine (Maintained by fenix-hub @GodotNuts)

Looking for more SDKs? - Help us by contributing a pull request to our SDK Generator!

Architecture

Appwrite uses a microservices architecture that was designed for easy scaling and delegation of responsibilities. In addition, Appwrite supports multiple APIs, such as REST, WebSocket, and GraphQL to allow you to interact with your resources by leveraging your existing knowledge and protocols of choice.

The Appwrite API layer was designed to be extremely fast by leveraging in-memory caching and delegating any heavy-lifting tasks to the Appwrite background workers. The background workers also allow you to precisely control your compute capacity and costs using a message queue to handle the load. You can learn more about our architecture in the contribution guide.

Contributing

All code contributions, including those of people having commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly :heart: pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Security

For security issues, kindly email us at security@appwrite.io instead of posting a public issue on GitHub.

Follow Us

Join our growing community around the world! Check out our official Blog. Follow us on X, LinkedIn, Dev Community or join our live Discord server for more help, ideas, and discussions.

License

This repository is available under the BSD 3-Clause License.