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
16 changes: 14 additions & 2 deletions .optimize-cache.json
Original file line number Diff line number Diff line change
Expand Up @@ -1438,13 +1438,25 @@
"images/docs/network/pops-map.png": "205ead599703cf47d0df316db8fcc4f48d5eed01508109fc740d17914275e9ab",
"images/docs/network/regions-map.png": "c65f1423ab19c3048bf8bf93117e8f2e1d13a2bc705c00307de7ee821e5668a1",
"images/docs/platform/add-platform.png": "5a05bb9d75a8d5270bfa5e67df7e6de20a9fad174476a112b5bdab72e7bdad30",
"images/docs/platform/create-api-key.png": "7661b3845e13704643f8ff4f763faa8e61efb90878c3ffa7466ece0910b8ecab",
"images/docs/platform/create-webhook.png": "77e08173da6ac534524e025433cf75e532d853a135944a7c6ba2278357d88b2d",
"images/docs/platform/dark/add-platform.png": "1bb0e7dba22556e64064951882d625532285fa80bed43fd77774f31545a15b0f",
"images/docs/platform/dark/create-api-key.png": "f15696f0b28dfc46813d7185be11da8be89da72be66b1894cfcc7227036e4afa",
"images/docs/platform/dark/create-webhook.png": "88f7f5c857fe986b5803c7df003c4db55faa79e3fa3135cf9491073d0b2736be",
"images/docs/platform/dark/execution-details.png": "c0481ddc206447460f9d317ba8d421615066f67a50bc9ef41a8f71766ecffb14",
"images/docs/platform/execution-details.png": "ece1364b8b00254bbd982421b6eed6d7f519d34c4e80377fcaaa4cb5d5dd3f89",
"images/docs/project/auth-methods.png": "caa81b517332b06cf539edf25de91a444d8e19ac212d2dd8d75ba14f74933db6",
"images/docs/project/create-api-key.png": "7661b3845e13704643f8ff4f763faa8e61efb90878c3ffa7466ece0910b8ecab",
"images/docs/project/dark/auth-methods.png": "45421e0c586c5f7dc156e823642ab9667f97950f23ca01ce3b8d993ee49fb820",
"images/docs/project/dark/create-api-key.png": "f15696f0b28dfc46813d7185be11da8be89da72be66b1894cfcc7227036e4afa",
"images/docs/project/dark/mock-phones.png": "f26a9cd69f3bc57279cd17109336ea8f55c40f22118b29bd3066afb678ebdf84",
"images/docs/project/dark/platforms.png": "d8e1f107a3c9597ac703fa3c98279bf7bb398761c137455344a8cab05857ec0b",
"images/docs/project/dark/policies.png": "d51a421b4c57b4f2a0d28653e156325b113816a2ad096a2ff15bb15702362b6d",
"images/docs/project/dark/protocols.png": "ff39e7d76dd82d5d13024dd39f589f49ab159c67d1805cb32d3f8ba907b62822",
"images/docs/project/dark/services.png": "fd58dd37313629739db739392a287c5bd15cc196ebb9ed0095b069684aaf6218",
"images/docs/project/mock-phones.png": "ad8c936aafa4782f44611e1c8be9a0a85578485cff3ab49356355f10c178be4a",
"images/docs/project/platforms.png": "7200e9aee04f6fcbc1d232a474b9f80ed406e78ec981c59f69f576649fa8f564",
"images/docs/project/policies.png": "1a35fa9333be000e5131e011fa7e7644aea1148e43d238fa51c98366b7d5871b",
"images/docs/project/protocols.png": "22bfbe1bc2960244c467d8dc373d4b021a79ee9a9b01e9e1d89c5cf3b0bea385",
"images/docs/project/services.png": "b7bb5785e64fdace11e6989a070e326cd1dfc5a67de9a8e17e80ebde20c5fbdf",
"images/docs/quick-starts/add-platform.png": "3b13ba983ea1d2529a1f34a719acef903ec0b58879ed511012280a28ccbde17e",
"images/docs/quick-starts/create-project.png": "7fdb25def02c5dbdb08cd38c2d03b7b454c930194a900553e3e68d51cb28a1d5",
"images/docs/quick-starts/dark/add-platform.png": "b12a85b64b136589268831b9cb26a664ec97418ad25a38be5273baab8253aa16",
Expand Down
Binary file added mock-phones-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion src/redirects.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
[
{
"link": "/docs/advanced/platform/api-keys",
"redirect": "/docs/products/project/api-keys"
},
{
"link": "/docs/getting-started-for-web",
"redirect": "/docs/quick-starts"
Expand Down Expand Up @@ -201,7 +205,7 @@
},
{
"link": "/docs/keys",
"redirect": "/docs/advanced/platform/api-keys"
"redirect": "/docs/products/project/api-keys"
},
{
"link": "/docs/permissions",
Expand Down
6 changes: 6 additions & 0 deletions src/routes/docs/Sidebar.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@
icon: 'icon-globe-alt',
isParent: true,
new: isNewUntil('19 Jul 2025')
},
{
label: 'Project',
href: '/docs/products/project',
icon: 'icon-briefcase',
isParent: true
}
]
},
Expand Down
4 changes: 0 additions & 4 deletions src/routes/docs/advanced/platform/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,6 @@
label: 'Rate limits',
href: '/docs/advanced/platform/rate-limits'
},
{
label: 'API keys',
href: '/docs/advanced/platform/api-keys'
},
{
label: 'Dev keys',
href: '/docs/advanced/platform/dev-keys'
Expand Down
4 changes: 0 additions & 4 deletions src/routes/docs/advanced/platform/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,6 @@ Control which users can access which resources.
Appwrite has rate limits on some endpoints to prevent abuse.
{% /cards_item %}

{% cards_item href="/docs/advanced/platform/api-keys" title="API keys" %}
Create and manage API keys used by Server SDKs.
{% /cards_item %}

{% cards_item href="/docs/advanced/platform/dev-keys" title="Dev keys" %}
Create and manage dev keys used by Client SDKs in dev environments.
{% /cards_item %}
Expand Down
59 changes: 59 additions & 0 deletions src/routes/docs/products/project/+layout.svelte
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<script lang="ts">
import Docs from '$lib/layouts/Docs.svelte';
import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte';

const parent: NavParent = {
href: '/docs',
label: 'Project'
};

const navigation: NavTree = [
{
label: 'Getting started',
items: [
{
label: 'Overview',
href: '/docs/products/project'
}
]
},
{
label: 'Concepts',
items: [
{
label: 'Auth methods',
href: '/docs/products/project/auth-methods'
},
{
label: 'API keys',
href: '/docs/products/project/api-keys'
},
{
label: 'Platforms',
href: '/docs/products/project/platforms'
},
{
label: 'Protocols',
href: '/docs/products/project/protocols'
},
{
label: 'Services',
href: '/docs/products/project/services'
},
{
label: 'Policies',
href: '/docs/products/project/policies'
},
{
label: 'Mock phones',
href: '/docs/products/project/mock-phones'
}
]
}
];
</script>

<Docs variant="two-side-navs">
<Sidebar {navigation} {parent} />
<slot />
</Docs>
34 changes: 34 additions & 0 deletions src/routes/docs/products/project/+page.markdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: article
title: Project
description: Configure your Appwrite project, including auth methods, platforms, protocols, services, and policies.
back: /docs
---

An Appwrite **Project** is the top-level container for all the resources your app uses, from users and databases to storage buckets and functions. The settings on a project control which authentication methods are available, which client platforms can connect, which protocols and services are exposed, and which policies apply to the resources inside it.

# Concepts {% #concepts %}

{% cards %}
{% cards_item href="/docs/products/project/auth-methods" title="Auth methods" %}
Enable or disable authentication methods on your project.
{% /cards_item %}
{% cards_item href="/docs/products/project/api-keys" title="API keys" %}
Create and manage API keys used by Server SDKs.
{% /cards_item %}
{% cards_item href="/docs/products/project/platforms" title="Platforms" %}
Register the apps and origins that are allowed to call your project.
{% /cards_item %}
{% cards_item href="/docs/products/project/protocols" title="Protocols" %}
Toggle the API protocols clients can use to reach your project.
{% /cards_item %}
{% cards_item href="/docs/products/project/services" title="Services" %}
Turn individual Appwrite services on or off for your project.
{% /cards_item %}
{% cards_item href="/docs/products/project/policies" title="Policies" %}
Configure project-wide policies that apply across resources.
{% /cards_item %}
{% cards_item href="/docs/products/project/mock-phones" title="Mock phones" %}
Register fictional phone numbers and OTPs to test phone authentication.
{% /cards_item %}
{% /cards %}
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ API keys are for server SDKs and the CLI in production environments, while Dev k
# Create API key {% #create-api-key %}

{% only_dark %}
![Project settings screen](/images/docs/platform/dark/create-api-key.png)
![Project settings screen](/images/docs/project/dark/create-api-key.png)
{% /only_dark %}
{% only_light %}
![Project settings screen](/images/docs/platform/create-api-key.png)
![Project settings screen](/images/docs/project/create-api-key.png)
{% /only_light %}

To create a new API key, navigate to **Overview** > **Integration** > **API keys** and click **Create API key**.
Expand Down
Loading
Loading