Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ APIs section:
- [GraphQL](https://appwrite.io/docs/apis/graphql)
- [REST](https://appwrite.io/docs/apis/rest)
- [Realtime](https://appwrite.io/docs/apis/realtime)
- [Events](https://appwrite.io/docs/apis/events)
- [Webhooks](https://appwrite.io/docs/apis/webhooks)
- [Response codes](https://appwrite.io/docs/apis/response-codes)
- [Error handling](https://appwrite.io/docs/apis/error-handling)

Tooling section:

Expand All @@ -57,10 +61,11 @@ Tooling section:

Advanced section:

- [Platform](https://appwrite.io/docs/advanced/platform)
- [Billing](https://appwrite.io/docs/advanced/billing)
- [Migrations](https://appwrite.io/docs/advanced/migrations)
- [Self-hosting](https://appwrite.io/docs/advanced/self-hosting)
- [Security](https://appwrite.io/docs/advanced/security)
- [Release policy](https://appwrite.io/docs/advanced/release-policy)

Here's the intended purpose and structure of each section.

Expand Down Expand Up @@ -214,7 +219,7 @@ Split content such that each piece makes sense without reading dependents or exp
- [ ] Point Cloud to new version in [src/routes/docs/references/[version]/[platform]/[service]/+page.server.ts](src/routes/docs/references/[version]/[platform]/[service]/+page.server.ts)
- [ ] Update install command in [/workspaces/website/src/routes/docs/advanced/self-hosting/+page.markdoc](/workspaces/website/src/routes/docs/advanced/self-hosting/+page.markdoc)
- [ ] Update events [src/partials/[product]-events.md](src/partials/)
- [ ] Update response code [src/routes/docs/advanced/platform/response-codes/+page.markdoc](src/routes/docs/advanced/platform/response-codes/+page.markdoc)
- [ ] Update response code [src/routes/docs/apis/response-codes/+page.markdoc](src/routes/docs/apis/response-codes/+page.markdoc)
- [ ] Bump latest SDK versions in SDKs page, quick start, and tutorials
- [ ] Create new sections for new products
- [ ] Create new concept and journey pages for new features
Expand Down
2 changes: 1 addition & 1 deletion src/partials/account-vs-user.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% info title="Account vs Users API" %}
The Account API is the API you should use in your **client applications** with [Client SDKs](/docs/sdks#client) like web, Flutter, mobile, and native apps.
Account API creates sessions, which represent an authenticated user and is attached to a user's [account](/docs/products/auth/accounts).
Sessions respect [permissions](/docs/advanced/platform/permissions), which means users can only access resources if they have been granted the correct permissions.
Sessions respect [permissions](/docs/advanced/security/permissions), which means users can only access resources if they have been granted the correct permissions.

The Users API is a dedicated API for managing users from an admin's perspective.
It should be used with backend or server-side applications with [Server SDKs](/docs/sdks#server). Users API uses API keys instead of sessions.
Expand Down
4 changes: 2 additions & 2 deletions src/partials/auth-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can change the session limit in the **Security** tab of the Auth Service in
# Permissions {% #permissions %}

Security is very important to protect users' data and privacy.
Appwrite uses a [permissions model](/docs/advanced/platform/permissions) coupled with user sessions to ensure users need correct permissions to access resources.
Appwrite uses a [permissions model](/docs/advanced/security/permissions) coupled with user sessions to ensure users need correct permissions to access resources.
With all Appwrite services, including databases and storage, access is granted at the collection, bucket, document, or file level.
These permissions are enforced for client SDKs and server SDKs when using JWT, but are ignored when using a server SDK with an API key.

Expand All @@ -45,7 +45,7 @@ Password history can be enabled in the Auth service's **Security** tab on the Ap

# Password dictionary {% #password-dictionary %}

Password dictionary protects users from using bad passwords. It compares the user's password to the [10,000 most common passwords](https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10k-most-common.txt) and throws an error if there's a match. Together with [rate limits](/docs/advanced/platform/rate-limits), password dictionary will significantly reduce the chance of a malicious actor guessing user passwords.
Password dictionary protects users from using bad passwords. It compares the user's password to the [10,000 most common passwords](https://github.com/danielmiessler/SecLists/blob/master/Passwords/Common-Credentials/10k-most-common.txt) and throws an error if there's a match. Together with [rate limits](/docs/advanced/security/rate-limits), password dictionary will significantly reduce the chance of a malicious actor guessing user passwords.

Password dictionary can be enabled in the Auth service's **Security** tab on the Appwrite Console.

Expand Down
43 changes: 29 additions & 14 deletions src/partials/functions-env-vars.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
| Variable | Description | Available at Build and/or Run Time |
| ----------------------------------- | ---------------------------------------------------------- | ---------------------------------- |
| `APPWRITE_FUNCTION_API_ENDPOINT` | The API endpoint of the running function | Both |
| `APPWRITE_VERSION` | The Appwrite version used to run the function | Both |
| `APPWRITE_REGION` | The region where the function will run from | Both |
| `APPWRITE_FUNCTION_API_KEY` | The function API key used for server authentication | Build time |
| `APPWRITE_FUNCTION_ID` | The ID of the running function | Both |
| `APPWRITE_FUNCTION_NAME` | The name of the running function | Both |
| `APPWRITE_FUNCTION_DEPLOYMENT` | The deployment ID of the running function | Both |
| `APPWRITE_FUNCTION_PROJECT_ID` | The project ID of the running function | Both |
| `APPWRITE_FUNCTION_RUNTIME_NAME` | The runtime of the running function | Both |
| `APPWRITE_FUNCTION_RUNTIME_VERSION` | The runtime version of the running function | Both |
| `APPWRITE_FUNCTION_CPUS` | The CPU (runtime) specification of the running function | Both |
| `APPWRITE_FUNCTION_MEMORY` | The memory (runtime) specification of the running function | Both |
| Variable | Description | Available at Build and/or Run Time |
| ------------------------------------ | ------------------------------------------------------------- | ---------------------------------- |
| `APPWRITE_FUNCTION_API_ENDPOINT` | The API endpoint of the running function | Both |
| `APPWRITE_VERSION` | The Appwrite version used to run the function | Both |
| `APPWRITE_REGION` | The region where the function will run from | Both |
| `APPWRITE_DEPLOYMENT_TYPE` | The deployment source type, such as `manual`, `cli`, or `vcs` | Both |
| `APPWRITE_FUNCTION_API_KEY` | The function API key used for server authentication | Build time |
| `APPWRITE_FUNCTION_ID` | The ID of the running function | Both |
| `APPWRITE_FUNCTION_NAME` | The name of the running function | Both |
| `APPWRITE_FUNCTION_DEPLOYMENT` | The deployment ID of the running function | Both |
| `APPWRITE_FUNCTION_PROJECT_ID` | The project ID of the running function | Both |
| `APPWRITE_FUNCTION_RUNTIME_NAME` | The runtime of the running function | Both |
| `APPWRITE_FUNCTION_RUNTIME_VERSION` | The runtime version of the running function | Both |
| `APPWRITE_FUNCTION_CPUS` | The CPU (runtime) specification of the running function | Both |
| `APPWRITE_FUNCTION_MEMORY` | The memory (runtime) specification of the running function | Both |
| `APPWRITE_VCS_REPOSITORY_ID` | The provider repository ID for VCS deployments | Both |
| `APPWRITE_VCS_REPOSITORY_NAME` | The provider repository name for VCS deployments | Both |
| `APPWRITE_VCS_REPOSITORY_OWNER` | The owner of the provider repository | Both |
| `APPWRITE_VCS_REPOSITORY_URL` | The URL of the provider repository | Both |
| `APPWRITE_VCS_REPOSITORY_BRANCH` | The branch used for the VCS deployment | Both |
| `APPWRITE_VCS_REPOSITORY_BRANCH_URL` | The URL of the branch used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_HASH` | The commit hash used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_MESSAGE` | The commit message used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_URL` | The URL of the commit used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_AUTHOR_NAME` | The name of the VCS commit author | Both |
| `APPWRITE_VCS_COMMIT_AUTHOR_URL` | The URL of the VCS commit author | Both |
| `APPWRITE_VCS_ROOT_DIRECTORY` | The root directory configured for the VCS deployment | Both |

VCS metadata variables are populated for Git deployments. For manual and CLI deployments, VCS fields may be empty.
39 changes: 29 additions & 10 deletions src/partials/sites-env-vars.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
| Variable | Description | Available at Build and/or Run Time |
| ------------------------------- | ------------------------------------------------------- | ---------------------------------- |
| `APPWRITE_SITE_API_ENDPOINT` | The API endpoint of the running site | Both |
| `APPWRITE_SITE_NAME` | The name of the running site. | Both |
| `APPWRITE_SITE_DEPLOYMENT` | The deployment ID of the running sites. | Both |
| `APPWRITE_SITE_PROJECT_ID` | The project ID of the running site. | Both |
| `APPWRITE_SITE_RUNTIME_NAME` | The runtime name of the running site. | Both |
| `APPWRITE_SITE_RUNTIME_VERSION` | The runtime version of the running site. | Both |
| `APPWRITE_SITE_CPUS` | The CPU (runtime) specification of the running site. | Both |
| `APPWRITE_SITE_MEMORY` | The memory (runtime) specification of the running site. | Both |
| Variable | Description | Available at Build and/or Run Time |
| ------------------------------------ | ------------------------------------------------------------- | ---------------------------------- |
| `APPWRITE_SITE_API_ENDPOINT` | The API endpoint of the running site | Both |
| `APPWRITE_VERSION` | The Appwrite version used to run the site | Both |
| `APPWRITE_REGION` | The region where the site will run from | Both |
| `APPWRITE_DEPLOYMENT_TYPE` | The deployment source type, such as `manual`, `cli`, or `vcs` | Both |
| `APPWRITE_SITE_API_KEY` | The site API key used for server authentication | Build time |
| `APPWRITE_SITE_ID` | The ID of the running site | Both |
| `APPWRITE_SITE_NAME` | The name of the running site | Both |
| `APPWRITE_SITE_DEPLOYMENT` | The deployment ID of the running site | Both |
| `APPWRITE_SITE_PROJECT_ID` | The project ID of the running site | Both |
| `APPWRITE_SITE_RUNTIME_NAME` | The runtime name of the running site | Both |
| `APPWRITE_SITE_RUNTIME_VERSION` | The runtime version of the running site | Both |
| `APPWRITE_SITE_CPUS` | The CPU (runtime) specification of the running site | Both |
| `APPWRITE_SITE_MEMORY` | The memory (runtime) specification of the running site | Both |
| `APPWRITE_VCS_REPOSITORY_ID` | The provider repository ID for VCS deployments | Both |
| `APPWRITE_VCS_REPOSITORY_NAME` | The provider repository name for VCS deployments | Both |
| `APPWRITE_VCS_REPOSITORY_OWNER` | The owner of the provider repository | Both |
| `APPWRITE_VCS_REPOSITORY_URL` | The URL of the provider repository | Both |
| `APPWRITE_VCS_REPOSITORY_BRANCH` | The branch used for the VCS deployment | Both |
| `APPWRITE_VCS_REPOSITORY_BRANCH_URL` | The URL of the branch used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_HASH` | The commit hash used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_MESSAGE` | The commit message used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_URL` | The URL of the commit used for the VCS deployment | Both |
| `APPWRITE_VCS_COMMIT_AUTHOR_NAME` | The name of the VCS commit author | Both |
| `APPWRITE_VCS_COMMIT_AUTHOR_URL` | The URL of the VCS commit author | Both |
| `APPWRITE_VCS_ROOT_DIRECTORY` | The root directory configured for the VCS deployment | Both |

VCS metadata variables are populated for Git deployments. For manual and CLI deployments, VCS fields may be empty.
Loading
Loading