Appwrite¶

In this article

• Appwrite. Key Features
• Deployment Features
• Getting started after deploying Appwrite
• Initial Workspace Setup in Appwrite
• Ordering a server with Appwrite using the API

Appwrite. Key Features¶

• Authentication: It provides various methods for users’ authentication, including email, social networks, phone, and more.
• Database: A user-friendly API for creating and managing databases. Both SQL and NoSQL databases are supported.
• File storage: It allows uploading and storing files, images, and other content. Caching and optimization mechanisms are available.
• Functions: The ability to run server-side functions in languages like Python, Node.js, Go, and more. It is useful for data processing, machine learning, and others.
• Webhooks: It allows configuring webhooks for various events, such as database changes.
• API and SDK: Appwrite provides a well-documented API and ready-made SDKs in different languages to simplify development.
• Convenient administration: A web interface and SDK for managing projects, users, security settings, and more.

Deployment Features¶

Installed software:

• Docker CE;
• Docker Compose;
• Working directory of the container: /opt/appwrite;
• Web console connection port: 80/443 (via Traefik). For example, https://appwrite<ID server>.hostkey.com/console/;
• Database: MariaDB 10.11 (port 3306);
• Cache: Redis 7.2.4 (port 6379);
• Reverse proxy: Traefik 2.11 and nginx-certbot.
• Docker containers:
  • appwrite: main application container (image appwrite/appwrite:1.5.10);
  • appwrite-mariadb: MariaDB database container (image mariadb:10.11);
  • appwrite-redis: Redis cache container (image redis:7.2.4-alpine);
  • appwrite-traefik: reverse proxy container (image traefik:2.11);
  • nginx-nginx-1: web server and SSL container (image jonasal/nginx-certbot);
  • appwrite-assistant: AI assistant container (image appwrite/assistant:0.4.0);
  • openruntimes-executor: function executor container (image openruntimes/executor:0.5.7);
  • Worker containers: appwrite-worker-* for processing various tasks (databases, functions, webhooks, messaging, etc.).
• Main application files: /opt/appwrite;
• Data and configuration are stored in Docker volumes: appwrite_appwrite-*;
• Web server configuration: /data/nginx/user_conf.d/appwrite<ID server>.hostkey.com.conf.

Getting started after deploying Appwrite¶

A notification will be sent to the e-mail specified during registration that the server is ready for work after paying for the order. It will contain the IP address of the VPS, as well as the login and password for the connection. Clients of our company manage the hardware in the server`s and API control panel — Invapi.

Authorization data is also located here:

• Link to access the Appwrite dashboard with a web interface: in the webpanel tag.

After following the link, you need to create a new account:

1. Click the Sign Up button in the bottom right corner of the login form:

   

2. Fill out the registration form:

   • Name - your name;
   • Email - your email address;
   • Password - come up with a secure password.
3. Check the box agreeing to the terms of use.
4. Click Sign Up:

Initial Workspace Setup in Appwrite¶

Creating an Organization¶

1. After logging in, you will see the Welcome to Appwrite screen.
2. Fill out the form Create a new organization:
3. Enter the name of the organization in the Name field;
4. Click Get started:

Managing Projects¶

Creating a Project¶

1. On the main page of the organization, click Create project;
2. In the opened window:
3. Enter the name of the project in the Name field;
4. Optionally edit the Project ID;
5. Click Create:

Configuring a Project¶

After creating a project, the Getting started page opens with options:

Add Platform:

• Web - for web applications;
• Flutter - for Flutter applications;
• Apple - for iOS applications;
• Android - for Android applications.

Integrate with Server:

• API key - for setting up an API key;
• Webhook - for configuring webhooks:

Managing Members¶

Inviting Members¶

1. Go to the Members tab.
2. Click Invite
3. In the invitation form:
4. Enter the member's email;
5. Optionally enter a name;
6. Click Send invite:

Viewing Members¶

The Members tab displays a list of all members with information:

• Name and avatar;
• Email address;
• Status of two-factor authentication (2FA):

Organization Settings¶

1. Go to the Settings tab.
2. Here you can:
3. Change the organization name and click Update;
4. Delete the organization by clicking Delete (irreversible action).

After successful registration, you will have access to the Appwrite control panel. For more information on the basic settings of Appwrite, see the documentation of the developers.

Ordering a server with Appwrite using the API¶

To install this software using the API, follow these instructions

Some of the content on this page was created or translated using AI.