|
| 1 | +--- |
| 2 | +title: 'Projects' |
| 3 | +order: 119 |
| 4 | +--- |
| 5 | + |
| 6 | +## Projects |
| 7 | + |
| 8 | +A **Project** in Yorkie is a logical grouping that isolates documents, channels, and clients. Projects enable multi-tenancy, allowing you to run multiple independent applications or environments within a single Yorkie installation. |
| 9 | + |
| 10 | +### Overview |
| 11 | + |
| 12 | +Every Yorkie installation starts with a `default` project that is created automatically. When a [Client](/docs/js-sdk#client) connects without specifying an API key, it is placed in the default project. For production applications, you should create dedicated projects to isolate data and configure settings independently. |
| 13 | + |
| 14 | +```mermaid |
| 15 | +graph TB |
| 16 | + subgraph Server["Yorkie Server"] |
| 17 | + subgraph P1["Project: my-app-prod"] |
| 18 | + D1["Documents"] |
| 19 | + C1["Channels"] |
| 20 | + CL1["Clients"] |
| 21 | + end |
| 22 | + subgraph P2["Project: my-app-staging"] |
| 23 | + D2["Documents"] |
| 24 | + C2["Channels"] |
| 25 | + CL2["Clients"] |
| 26 | + end |
| 27 | + subgraph P3["Project: another-app"] |
| 28 | + D3["Documents"] |
| 29 | + C3["Channels"] |
| 30 | + CL3["Clients"] |
| 31 | + end |
| 32 | + end |
| 33 | +``` |
| 34 | + |
| 35 | +### Project Isolation |
| 36 | + |
| 37 | +Each project provides complete isolation: |
| 38 | + |
| 39 | +- **Documents** in one project are invisible to clients in another project. A document key like `doc-1` can exist independently in multiple projects. |
| 40 | +- **Channels** are scoped to their project. Broadcast messages and presence updates only reach clients within the same project. |
| 41 | +- **Clients** belong to exactly one project, determined by the API key they use to connect. |
| 42 | +- **Configuration** (auth webhooks, event webhooks, resource limits, housekeeping thresholds) is set per project. |
| 43 | + |
| 44 | +### API Keys |
| 45 | + |
| 46 | +Each project has two keys: |
| 47 | + |
| 48 | +| Key | Purpose | Usage | |
| 49 | +|-----|---------|-------| |
| 50 | +| **Public Key** | Identifies the project for client connections | Used as `apiKey` when creating a [Client](/docs/js-sdk#client) | |
| 51 | +| **Secret Key** | Authenticates server-side applications | Used in the `authorization` header for [Admin API](/docs/tools/admin-api) requests | |
| 52 | + |
| 53 | +```javascript |
| 54 | +// Connect a client to a specific project using its public key |
| 55 | +const client = new yorkie.Client({ |
| 56 | + rpcAddr: '{{API_ADDR}}', |
| 57 | + apiKey: 'your-project-public-key', |
| 58 | +}); |
| 59 | +``` |
| 60 | + |
| 61 | +> Keep your **Secret Key** confidential. It grants full access to manage documents within the project via the [Admin API](/docs/tools/admin-api). Never expose it in client-side code. |
| 62 | +
|
| 63 | +### Managing Projects |
| 64 | + |
| 65 | +Projects are managed through the [CLI](/docs/tools/cli#project) or the [Dashboard]({{DASHBOARD_PATH}}). |
| 66 | + |
| 67 | +#### Creating a Project |
| 68 | + |
| 69 | +```bash |
| 70 | +$ yorkie project create my-app-prod |
| 71 | +``` |
| 72 | + |
| 73 | +This returns the project details including both keys: |
| 74 | + |
| 75 | +```json |
| 76 | +{ |
| 77 | + "name": "my-app-prod", |
| 78 | + "public_key": "...", |
| 79 | + "secret_key": "...", |
| 80 | + "created_at": "..." |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +#### Listing Projects |
| 85 | + |
| 86 | +```bash |
| 87 | +$ yorkie project ls |
| 88 | +``` |
| 89 | + |
| 90 | +#### Updating a Project |
| 91 | + |
| 92 | +Configure project settings such as auth webhooks, event webhooks, and resource limits: |
| 93 | + |
| 94 | +```bash |
| 95 | +# Set an auth webhook URL |
| 96 | +$ yorkie project update my-app-prod --auth-webhook-url https://my-server.com/auth |
| 97 | + |
| 98 | +# Configure event webhooks |
| 99 | +$ yorkie project update my-app-prod \ |
| 100 | + --event-webhook-url https://my-server.com/events \ |
| 101 | + --event-webhook-events-add DocumentRootChanged |
| 102 | + |
| 103 | +# Set resource limits |
| 104 | +$ yorkie project update my-app-prod \ |
| 105 | + --max-attachments-per-document 50 \ |
| 106 | + --max-subscribers-per-document 100 |
| 107 | + |
| 108 | +# Configure housekeeping |
| 109 | +$ yorkie project update my-app-prod \ |
| 110 | + --client-deactivate-threshold 24h |
| 111 | +``` |
| 112 | + |
| 113 | +For the full set of update options, see [Updating the Project](/docs/tools/cli#updating-the-project). |
| 114 | + |
| 115 | +### Per-Project Configuration |
| 116 | + |
| 117 | +Each project can be independently configured with the following settings: |
| 118 | + |
| 119 | +| Setting | Description | Reference | |
| 120 | +|---------|-------------|-----------| |
| 121 | +| **Auth Webhook** | External authentication endpoint for validating client requests | [Security: Auth Webhook](/docs/advanced/security#auth-webhook) | |
| 122 | +| **Event Webhook** | Notification endpoint for document events | [Event Webhook](/docs/advanced/event-webhook) | |
| 123 | +| **Allowed Origins** | CORS restrictions for client connections | [Security: Allowed Origins](/docs/advanced/security#allowed-origins) | |
| 124 | +| **Max Attachments** | Maximum clients that can attach to a single document | [Document Limits](/docs/js-sdk#document-limits) | |
| 125 | +| **Max Subscribers** | Maximum clients that can subscribe to a single document | [Document Limits](/docs/js-sdk#document-limits) | |
| 126 | +| **Client Deactivate Threshold** | Time after which inactive clients are automatically deactivated by [Housekeeping](/docs/glossary) | [CLI](/docs/tools/cli#updating-the-project) | |
| 127 | + |
| 128 | +### Common Patterns |
| 129 | + |
| 130 | +#### Separate Environments |
| 131 | + |
| 132 | +Create distinct projects for development, staging, and production: |
| 133 | + |
| 134 | +```bash |
| 135 | +$ yorkie project create my-app-dev |
| 136 | +$ yorkie project create my-app-staging |
| 137 | +$ yorkie project create my-app-prod |
| 138 | +``` |
| 139 | + |
| 140 | +Use environment variables in your application to select the appropriate API key: |
| 141 | + |
| 142 | +```javascript |
| 143 | +const client = new yorkie.Client({ |
| 144 | + rpcAddr: process.env.YORKIE_RPC_ADDR, |
| 145 | + apiKey: process.env.YORKIE_API_KEY, |
| 146 | +}); |
| 147 | +``` |
| 148 | + |
| 149 | +#### Multiple Applications |
| 150 | + |
| 151 | +If you host multiple collaborative applications on a single Yorkie server, create a project for each: |
| 152 | + |
| 153 | +```bash |
| 154 | +$ yorkie project create docs-app |
| 155 | +$ yorkie project create whiteboard-app |
| 156 | +$ yorkie project create chat-app |
| 157 | +``` |
| 158 | + |
| 159 | +Each application's documents, channels, and client data remain fully isolated. |
| 160 | + |
| 161 | +### Further Reading |
| 162 | + |
| 163 | +- [CLI: Project Management](/docs/tools/cli#project) -- Full CLI reference for project commands |
| 164 | +- [Admin API](/docs/tools/admin-api) -- Server-side document management using the project's secret key |
| 165 | +- [Security](/docs/advanced/security) -- Configuring auth webhooks and allowed origins |
| 166 | +- [Resources](/docs/advanced/resources) -- Configuring project-level resource limits |
| 167 | +- [Glossary](/docs/glossary) -- Definitions of all key terms |
0 commit comments