fluxerapp/fluxer
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

refactor progress

Browse Source
This commit is contained in:
Hampus Kraft
2026-02-17 12:22:36 +00:00
parent cb31608523
commit d5abd1a7e4
8257 changed files with 1190207 additions and 761040 deletions
Download Patch File Download Diff File Expand all files Collapse all files

157
fluxer_docs/resources/instance.mdx Normal file
View File

@@ -0,0 +1,157 @@
---
title: 'Instance'
description: 'Instance object schemas from the Fluxer API.'
---
<a id="wellknownfluxerresponse"></a>
## WellKnownFluxerResponse
**Related endpoints**
- [`GET /.well-known/fluxer`](/api-reference/instance/get-instance-discovery-document)
| Field | Type | Description |
|-------|------|-------------|
| api_code_version | integer (int53) | Version of the API server code |
| app_public | [WellKnownFluxerResponseAppPublic](#wellknownfluxerresponseapppublic) | Public application configuration for client-side features |
| captcha | [WellKnownFluxerResponseCaptcha](#wellknownfluxerresponsecaptcha) | Captcha configuration |
| endpoints | [WellKnownFluxerResponseEndpoints](#wellknownfluxerresponseendpoints) | Endpoint URLs for various services |
| features | [WellKnownFluxerResponseFeatures](#wellknownfluxerresponsefeatures) | Feature flags for this instance |
| federation? | [WellKnownFluxerResponseFederation](#wellknownfluxerresponsefederation) | Federation configuration |
| gif | [WellKnownFluxerResponseGif](#wellknownfluxerresponsegif) | GIF provider configuration for clients |
| limits | [WellKnownFluxerResponseLimits](#wellknownfluxerresponselimits) | Limit configuration with rules and trait definitions |
| oauth2? | [WellKnownFluxerResponseOauth2](#wellknownfluxerresponseoauth2) | OAuth2 endpoints for federation |
| public_key? | [WellKnownFluxerResponsePublicKey](#wellknownfluxerresponsepublickey) | Public key for E2E encryption |
| push | [WellKnownFluxerResponsePush](#wellknownfluxerresponsepush) | Push notification configuration |
| sso | [SsoStatusResponse](#ssostatusresponse) | Single sign-on configuration |
<a id="wellknownfluxerresponseapppublic"></a>
## WellKnownFluxerResponseAppPublic
Public application configuration for client-side features
| Field | Type | Description |
|-------|------|-------------|
| sentry_dsn | string | Sentry DSN for client-side error reporting |
| sentry_project_id | [SnowflakeType](#snowflaketype) | Sentry project ID |
| sentry_proxy_path | string | Proxy path for Sentry requests |
| sentry_public_key | string | Sentry public key |
| sentry_report_host | string | Host for Sentry error reports |
<a id="wellknownfluxerresponsecaptcha"></a>
## WellKnownFluxerResponseCaptcha
Captcha configuration
| Field | Type | Description |
|-------|------|-------------|
| hcaptcha_site_key | ?string | hCaptcha site key if using hCaptcha |
| provider | string | Captcha provider name (hcaptcha, turnstile, none) |
| turnstile_site_key | ?string | Cloudflare Turnstile site key if using Turnstile |
<a id="wellknownfluxerresponseendpoints"></a>
## WellKnownFluxerResponseEndpoints
Endpoint URLs for various services
| Field | Type | Description |
|-------|------|-------------|
| admin | string | Base URL for the admin panel |
| api | string | Base URL for authenticated API requests |
| api_client | string | Base URL for client API requests |
| api_public | string | Base URL for public API requests |
| gateway | string | WebSocket URL for the gateway |
| gift | string | Base URL for gift links |
| invite | string | Base URL for invite links |
| marketing | string | Base URL for the marketing website |
| media | string | Base URL for the media proxy |
| static_cdn | string | Base URL for static assets (avatars, emojis, etc.) |
| webapp | string | Base URL for the web application |
<a id="wellknownfluxerresponsefeatures"></a>
## WellKnownFluxerResponseFeatures
Feature flags for this instance
| Field | Type | Description |
|-------|------|-------------|
| manual_review_enabled | boolean | Whether manual review mode is enabled for registrations |
| self_hosted | boolean | Whether this is a self-hosted instance |
| sms_mfa_enabled | boolean | Whether SMS-based MFA is available |
| stripe_enabled | boolean | Whether Stripe payments are enabled |
| voice_enabled | boolean | Whether voice/video calling is enabled |
<a id="wellknownfluxerresponsefederation"></a>
## WellKnownFluxerResponseFederation
Federation configuration
| Field | Type | Description |
|-------|------|-------------|
| enabled | boolean | Whether federation is enabled on this instance |
| version | integer (int53) | Federation protocol version |
<a id="wellknownfluxerresponsegif"></a>
## WellKnownFluxerResponseGif
GIF provider configuration for clients
| Field | Type | Description |
|-------|------|-------------|
| provider | [WellKnownFluxerResponseGifProvider](#wellknownfluxerresponsegifprovider) | GIF provider used by the instance GIF picker |
<a id="wellknownfluxerresponselimits"></a>
## WellKnownFluxerResponseLimits
Limit configuration with rules and trait definitions
| Field | Type | Description |
|-------|------|-------------|
| defaultsHash | string | Hash of the default limit values for cache invalidation |
| rules | [LimitRuleResponse](#limitruleresponse)[] | Array of limit rules to evaluate |
| traitDefinitions | string[] | Available trait definitions (e.g., "premium") |
| version | enum&lt;`2`&gt; | Wire format version |
<a id="wellknownfluxerresponseoauth2"></a>
## WellKnownFluxerResponseOauth2
OAuth2 endpoints for federation
| Field | Type | Description |
|-------|------|-------------|
| authorization_endpoint | string | OAuth2 authorization endpoint URL |
| scopes_supported | string[] | Supported OAuth2 scopes |
| token_endpoint | string | OAuth2 token endpoint URL |
| userinfo_endpoint | string | OAuth2 userinfo endpoint URL |
<a id="wellknownfluxerresponsepublickey"></a>
## WellKnownFluxerResponsePublicKey
Public key for E2E encryption
| Field | Type | Description |
|-------|------|-------------|
| algorithm | enum&lt;`x25519`&gt; | Key algorithm |
| id | [SnowflakeType](#snowflaketype) | Key identifier |
| public_key_base64 | string | Base64-encoded public key |
<a id="wellknownfluxerresponsepush"></a>
## WellKnownFluxerResponsePush
Push notification configuration
| Field | Type | Description |
|-------|------|-------------|
| public_vapid_key | ?string | VAPID public key for web push notifications |