paulmataruso/Palmr
1
0
Fork 0
mirror of https://github.com/kyantech/Palmr.git synced 2025-10-23 06:11:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update documentation links and references to 3.2-beta (#227)

Browse Source
This commit is contained in:
Daniel Luiz Alves
2025-08-21 13:35:50 -03:00
committed by GitHub
parent cc368377c2 5afc6ea271
commit 5e889956c7
20 changed files with 77 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
apps/docs/content/docs/3.2-beta/architecture.mdx
View File

@@ -51,7 +51,7 @@ If you need to protect sensitive files at rest, you can enable encryption by set
For optimal performance with encryption enabled, ensure your hardware supports AES-NI acceleration (check with `cat /proc/cpuinfo | grep aes` on Linux). For optimal performance with encryption enabled, ensure your hardware supports AES-NI acceleration (check with `cat /proc/cpuinfo | grep aes` on Linux).
As an alternative, consider using S3-compatible object storage (e.g., AWS S3 or MinIO), which can offload file storage from the local filesystem and potentially reduce local CPU overhead for encryption/decryption. See [S3 Providers](/docs/3.1-beta/s3-providers) for setup instructions. As an alternative, consider using S3-compatible object storage (e.g., AWS S3 or MinIO), which can offload file storage from the local filesystem and potentially reduce local CPU overhead for encryption/decryption. See [S3 Providers](/docs/3.2-beta/s3-providers) for setup instructions.
### Fastify + Zod + TypeScript ### Fastify + Zod + TypeScript
@@ -127,7 +127,7 @@ Palmr. is designed to be flexible in how you handle file storage:
**Optional S3-compatible storage:** **Optional S3-compatible storage:**
- Enable S3 storage by setting `ENABLE_S3=true`, look at [S3 Providers](/docs/3.1-beta/s3-providers) for more information. - Enable S3 storage by setting `ENABLE_S3=true`, look at [S3 Providers](/docs/3.2-beta/s3-providers) for more information.
- Compatible with AWS S3, MinIO, and other S3-compatible services - Compatible with AWS S3, MinIO, and other S3-compatible services
- Ideal for cloud deployments and distributed setups - Ideal for cloud deployments and distributed setups
- Provides additional scalability and redundancy options - Provides additional scalability and redundancy options

6
apps/docs/content/docs/3.2-beta/manual-installation.mdx
View File

@@ -5,7 +5,7 @@ icon: Cog
Hey there! Looking to run **Palmr.** your way, with complete control over every piece of the stack? This manual installation guide is for you. No Docker, no pre-built containers just the raw source code to tweak, customize, and deploy as you see fit. Hey there! Looking to run **Palmr.** your way, with complete control over every piece of the stack? This manual installation guide is for you. No Docker, no pre-built containers just the raw source code to tweak, customize, and deploy as you see fit.
> **Prefer a quicker setup?** If this hands-on approach feels like overkill, check out our [**Quick Start (Docker)**](/docs/3.1-beta/quick-start) guide for a fast, containerized deployment. This manual path is tailored for developers who want to dive deep, modify the codebase, or integrate custom services. > **Prefer a quicker setup?** If this hands-on approach feels like overkill, check out our [**Quick Start (Docker)**](/docs/3.2-beta/quick-start) guide for a fast, containerized deployment. This manual path is tailored for developers who want to dive deep, modify the codebase, or integrate custom services.
Here's what you'll do at a glance: Here's what you'll do at a glance:
@@ -232,10 +232,10 @@ pnpm serve
Palmr. is now up and running locally . Here are some suggested next steps: Palmr. is now up and running locally . Here are some suggested next steps:
- **Manage Users**: Dive into the [Users Management](/docs/3.1-beta/manage-users) guide. - **Manage Users**: Dive into the [Users Management](/docs/3.2-beta/manage-users) guide.
- **Switch to Object Storage**: Update `.env` variables to use an S3-compatible bucket (see Quick Notes above). - **Switch to Object Storage**: Update `.env` variables to use an S3-compatible bucket (see Quick Notes above).
- **Secure Your Instance**: Put Palmr. behind a reverse proxy like **Nginx** or **Caddy** and enable HTTPS. - **Secure Your Instance**: Put Palmr. behind a reverse proxy like **Nginx** or **Caddy** and enable HTTPS.
- **Learn the Internals**: Explore how everything connects in the [Architecture](/docs/3.1-beta/architecture) overview. - **Learn the Internals**: Explore how everything connects in the [Architecture](/docs/3.2-beta/architecture) overview.
Jump into whichever area fits your needs our docs are designed for exploration in any order. Jump into whichever area fits your needs our docs are designed for exploration in any order.

2
apps/docs/content/docs/3.2-beta/oidc-authentication/auth0.mdx
View File

@@ -360,7 +360,7 @@ With Auth0 authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

2
apps/docs/content/docs/3.2-beta/oidc-authentication/authentik.mdx
View File

@@ -374,7 +374,7 @@ With Authentik authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

2
apps/docs/content/docs/3.2-beta/oidc-authentication/discord.mdx
View File

@@ -332,7 +332,7 @@ With Discord authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

2
apps/docs/content/docs/3.2-beta/oidc-authentication/frontegg.mdx
View File

@@ -314,7 +314,7 @@ With Frontegg authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

2
apps/docs/content/docs/3.2-beta/oidc-authentication/github.mdx
View File

@@ -295,7 +295,7 @@ With GitHub authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

2
apps/docs/content/docs/3.2-beta/oidc-authentication/google.mdx
View File

@@ -325,7 +325,7 @@ With Google authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

16
apps/docs/content/docs/3.2-beta/oidc-authentication/index.mdx
View File

@@ -38,14 +38,14 @@ Before configuring OIDC authentication, ensure you have:
Palmr's OIDC implementation is compatible with any OpenID Connect compliant provider, including as official providers: Palmr's OIDC implementation is compatible with any OpenID Connect compliant provider, including as official providers:
- **[Google](/docs/3.1-beta/oidc-authentication/google)** - **[Google](/docs/3.2-beta/oidc-authentication/google)**
- **[Discord](/docs/3.1-beta/oidc-authentication/discord)** - **[Discord](/docs/3.2-beta/oidc-authentication/discord)**
- **[Github](/docs/3.1-beta/oidc-authentication/github)** - **[Github](/docs/3.2-beta/oidc-authentication/github)**
- **[Zitadel](/docs/3.1-beta/oidc-authentication/zitadel)** - **[Zitadel](/docs/3.2-beta/oidc-authentication/zitadel)**
- **[Auth0](/docs/3.1-beta/oidc-authentication/auth0)** - **[Auth0](/docs/3.2-beta/oidc-authentication/auth0)**
- **[Authentik](/docs/3.1-beta/oidc-authentication/authentik)** - **[Authentik](/docs/3.2-beta/oidc-authentication/authentik)**
- **[Frontegg](/docs/3.1-beta/oidc-authentication/frontegg)** - **[Frontegg](/docs/3.2-beta/oidc-authentication/frontegg)**
- **[Kinde Auth](/docs/3.1-beta/oidc-authentication/kinde-auth)** - **[Kinde Auth](/docs/3.2-beta/oidc-authentication/kinde-auth)**
Although these are the official providers (internally tested with 100% success), you can connect any OIDC provider by providing your credentials and connection URL. We've developed a practical way to integrate virtually all OIDC providers available in the market. In this documentation, you can consult how to configure each of the official providers, as well as include other providers not listed as official. Just below, you will find instructions on how to access the OIDC provider configuration. For specific details about configuring each provider, select the desired option in the sidebar, in the "OIDC Authentication" section. Although these are the official providers (internally tested with 100% success), you can connect any OIDC provider by providing your credentials and connection URL. We've developed a practical way to integrate virtually all OIDC providers available in the market. In this documentation, you can consult how to configure each of the official providers, as well as include other providers not listed as official. Just below, you will find instructions on how to access the OIDC provider configuration. For specific details about configuring each provider, select the desired option in the sidebar, in the "OIDC Authentication" section.

2
apps/docs/content/docs/3.2-beta/oidc-authentication/kinde-auth.mdx
View File

@@ -359,7 +359,7 @@ With Kinde Auth authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

4
apps/docs/content/docs/3.2-beta/oidc-authentication/pocket-id.mdx
View File

@@ -270,10 +270,10 @@ After configuring Pocket ID authentication:
- **User management**: Review auto-registration settings - **User management**: Review auto-registration settings
- **Backup verification**: Test backup and restore procedures - **Backup verification**: Test backup and restore procedures
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources
- [Pocket ID Documentation](https://docs.pocket-id.org) - [Pocket ID Documentation](https://docs.pocket-id.org)
- [OIDC Specification](https://openid.net/specs/openid-connect-core-1_0.html) - [OIDC Specification](https://openid.net/specs/openid-connect-core-1_0.html)
- [Palmr OIDC Overview](/docs/3.1-beta/oidc-authentication) - [Palmr OIDC Overview](/docs/3.2-beta/oidc-authentication)

2
apps/docs/content/docs/3.2-beta/oidc-authentication/zitadel.mdx
View File

@@ -413,7 +413,7 @@ With Zitadel authentication configured, you might want to:
- **Review security settings**: Ensure your authentication setup meets your security requirements - **Review security settings**: Ensure your authentication setup meets your security requirements
- **Monitor usage**: Keep track of authentication patterns and user activity - **Monitor usage**: Keep track of authentication patterns and user activity
For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.1-beta/oidc-authentication). For more information about OIDC authentication in Palmr, see the [OIDC Authentication overview](/docs/3.2-beta/oidc-authentication).
## Useful resources ## Useful resources

57
apps/docs/content/docs/3.2-beta/quick-start.mdx
View File

@@ -86,7 +86,7 @@ Choose your storage method based on your needs:
``` ```
<Callout type="info"> <Callout type="info">
**Having upload or permission issues?** Add `PALMR_UID=1000` and `PALMR_GID=1000` to your environment variables. Check our [UID/GID Configuration](/docs/3.1-beta/uid-gid-configuration) guide for more details. **Having upload or permission issues?** Add `PALMR_UID=1000` and `PALMR_GID=1000` to your environment variables. Check our [UID/GID Configuration](/docs/3.2-beta/uid-gid-configuration) guide for more details.
</Callout> </Callout>
### Deploy ### Deploy
@@ -139,7 +139,7 @@ Choose your storage method based on your needs:
``` ```
<Callout type="info"> <Callout type="info">
**Having upload or permission issues?** Add `PALMR_UID=1000` and `PALMR_GID=1000` to your environment variables. Check our [UID/GID Configuration](/docs/3.1-beta/uid-gid-configuration) guide for more details. **Having upload or permission issues?** Add `PALMR_UID=1000` and `PALMR_GID=1000` to your environment variables. Check our [UID/GID Configuration](/docs/3.2-beta/uid-gid-configuration) guide for more details.
</Callout> </Callout>
### Deploy ### Deploy
@@ -155,21 +155,21 @@ Choose your storage method based on your needs:
Customize Palmr's behavior with these environment variables: Customize Palmr's behavior with these environment variables:
| Variable | Default | Description | | Variable | Default | Description |
| ------------------------------- | ------- | -------------------------------------------------------------------------------------------- | | ------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------- |
| `ENABLE_S3` | `false` | Enable S3-compatible storage backends | | `ENABLE_S3` | `false` | Enable S3-compatible storage backends |
| `S3_REJECT_UNAUTHORIZED` | `true` | Enable strict SSL certificate validation for S3 (set to `false` for self-signed certificates) | | `S3_REJECT_UNAUTHORIZED` | `true` | Enable strict SSL certificate validation for S3 (set to `false` for self-signed certificates) |
| `ENCRYPTION_KEY` | - | **Required when encryption is enabled**: 32+ character key for file encryption | | `ENCRYPTION_KEY` | - | **Required when encryption is enabled**: 32+ character key for file encryption |
| `DISABLE_FILESYSTEM_ENCRYPTION` | `true` | Disable file encryption for better performance (set to `false` to enable encryption) | | `DISABLE_FILESYSTEM_ENCRYPTION` | `true` | Disable file encryption for better performance (set to `false` to enable encryption) |
| `SECURE_SITE` | `false` | Enable secure cookies for HTTPS/reverse proxy deployments | | `SECURE_SITE` | `false` | Enable secure cookies for HTTPS/reverse proxy deployments |
| `DEFAULT_LANGUAGE` | `en-US` | Default application language ([see available languages](/docs/3.1-beta/available-languages)) | | `DEFAULT_LANGUAGE` | `en-US` | Default application language ([see available languages](/docs/3.2-beta/available-languages)) |
| `PALMR_UID` | `1000` | User ID for container processes (helps with file permissions) | | `PALMR_UID` | `1000` | User ID for container processes (helps with file permissions) |
| `PALMR_GID` | `1000` | Group ID for container processes (helps with file permissions) | | `PALMR_GID` | `1000` | Group ID for container processes (helps with file permissions) |
| `DOWNLOAD_MAX_CONCURRENT` | auto-scale | Maximum number of simultaneous downloads (see [Download Memory Management](/docs/3.1-beta/download-memory-management)) | | `DOWNLOAD_MAX_CONCURRENT` | auto-scale | Maximum number of simultaneous downloads (see [Download Memory Management](/docs/3.2-beta/download-memory-management)) |
| `DOWNLOAD_MEMORY_THRESHOLD_MB` | auto-scale | Memory threshold in MB before throttling | | `DOWNLOAD_MEMORY_THRESHOLD_MB` | auto-scale | Memory threshold in MB before throttling |
| `DOWNLOAD_QUEUE_SIZE` | auto-scale | Maximum queue size for pending downloads | | `DOWNLOAD_QUEUE_SIZE` | auto-scale | Maximum queue size for pending downloads |
| `DOWNLOAD_MIN_FILE_SIZE_GB` | `3.0` | Minimum file size in GB to activate memory management | | `DOWNLOAD_MIN_FILE_SIZE_GB` | `3.0` | Minimum file size in GB to activate memory management |
| `DOWNLOAD_AUTO_SCALE` | `true` | Enable auto-scaling based on system memory | | `DOWNLOAD_AUTO_SCALE` | `true` | Enable auto-scaling based on system memory |
<Callout type="info"> <Callout type="info">
**Performance First**: Palmr runs without encryption by default for optimal speed and lower resource usage—perfect for **Performance First**: Palmr runs without encryption by default for optimal speed and lower resource usage—perfect for
@@ -184,7 +184,7 @@ Customize Palmr's behavior with these environment variables:
<Callout> <Callout>
**Using a Reverse Proxy?** Set `SECURE_SITE=true` and check our [Reverse Proxy **Using a Reverse Proxy?** Set `SECURE_SITE=true` and check our [Reverse Proxy
Configuration](/docs/3.1-beta/reverse-proxy-configuration) guide for proper HTTPS setup. Configuration](/docs/3.2-beta/reverse-proxy-configuration) guide for proper HTTPS setup.
</Callout> </Callout>
### Generate Encryption Keys (Optional) ### Generate Encryption Keys (Optional)
@@ -204,7 +204,7 @@ Once deployed, open Palmr in your browser:
<Callout type="info"> <Callout type="info">
**Learn More**: For complete API documentation, authentication, and integration examples, see our [API **Learn More**: For complete API documentation, authentication, and integration examples, see our [API
Reference](/docs/3.1-beta/api) guide Reference](/docs/3.2-beta/api) guide
</Callout> </Callout>
<Callout type="warn"> <Callout type="warn">
@@ -240,7 +240,7 @@ Prefer Docker commands over Compose? Here are the equivalent commands:
<Callout type="info"> <Callout type="info">
**Permission Issues?** Add `-e PALMR_UID=1000 -e PALMR_GID=1000` to the command above. See our [UID/GID Configuration](/docs/3.1-beta/uid-gid-configuration) guide for details. **Permission Issues?** Add `-e PALMR_UID=1000 -e PALMR_GID=1000` to the command above. See our [UID/GID Configuration](/docs/3.2-beta/uid-gid-configuration) guide for details.
</Callout> </Callout>
</Tab> </Tab>
@@ -266,7 +266,7 @@ Prefer Docker commands over Compose? Here are the equivalent commands:
``` ```
<Callout type="info"> <Callout type="info">
**Permission Issues?** Add `-e PALMR_UID=1000 -e PALMR_GID=1000` to the command above. See our [UID/GID Configuration](/docs/3.1-beta/uid-gid-configuration) guide for details. **Permission Issues?** Add `-e PALMR_UID=1000 -e PALMR_GID=1000` to the command above. See our [UID/GID Configuration](/docs/3.2-beta/uid-gid-configuration) guide for details.
</Callout> </Callout>
</Tab> </Tab>
@@ -286,10 +286,11 @@ You can customize this for all storage types (filesystem or S3) by adding:
```yaml ```yaml
environment: environment:
- PRESIGNED_URL_EXPIRATION=7200 # 2 hours - PRESIGNED_URL_EXPIRATION=7200 # 2 hours
``` ```
**When to adjust:** **When to adjust:**
- **Shorter time (1800 = 30 min):** Higher security, but users may need to refresh download links - **Shorter time (1800 = 30 min):** Higher security, but users may need to refresh download links
- **Longer time (7200-21600 = 2-6 hours):** Better for large file transfers, but URLs stay valid longer - **Longer time (7200-21600 = 2-6 hours):** Better for large file transfers, but URLs stay valid longer
- **Default (3600 = 1 hour):** Good balance for most use cases - **Default (3600 = 1 hour):** Good balance for most use cases
@@ -359,17 +360,17 @@ Your Palmr instance is ready! Here's what you can explore:
### Advanced Configuration ### Advanced Configuration
- **[UID/GID Configuration](/docs/3.1-beta/uid-gid-configuration)** - Configure user permissions for NAS systems and custom environments - **[UID/GID Configuration](/docs/3.2-beta/uid-gid-configuration)** - Configure user permissions for NAS systems and custom environments
- **[Download Memory Management](/docs/3.1-beta/download-memory-management)** - Configure large file download handling and queue system - **[Download Memory Management](/docs/3.2-beta/download-memory-management)** - Configure large file download handling and queue system
- **[S3 Storage](/docs/3.1-beta/s3-configuration)** - Scale with Amazon S3 or compatible storage providers - **[S3 Storage](/docs/3.2-beta/s3-configuration)** - Scale with Amazon S3 or compatible storage providers
- **[Manual Installation](/docs/3.1-beta/manual-installation)** - Manual installation and custom configurations - **[Manual Installation](/docs/3.2-beta/manual-installation)** - Manual installation and custom configurations
### Integration & Development ### Integration & Development
- **[API Reference](/docs/3.1-beta/api)** - Integrate Palmr. with your applications - **[API Reference](/docs/3.2-beta/api)** - Integrate Palmr. with your applications
<Callout type="info"> <Callout type="info">
**Need help?** Check our [Troubleshooting Guide](/docs/3.1-beta/troubleshooting) for common issues and solutions. **Need help?** Check our [Troubleshooting Guide](/docs/3.2-beta/troubleshooting) for common issues and solutions.
</Callout> </Callout>
--- ---

2
apps/docs/content/docs/3.2-beta/reverse-proxy-configuration.mdx
View File

@@ -131,7 +131,7 @@ environment:
# - ENCRYPTION_KEY=your-key-here # Required only if encryption is enabled # - ENCRYPTION_KEY=your-key-here # Required only if encryption is enabled
``` ```
> **💡 Note**: Check your host UID/GID with `id` command and use those values. See [UID/GID Configuration](/docs/3.1-beta/uid-gid-configuration) for detailed setup. > **💡 Note**: Check your host UID/GID with `id` command and use those values. See [UID/GID Configuration](/docs/3.2-beta/uid-gid-configuration) for detailed setup.
--- ---

5
apps/docs/content/docs/meta.json
View File

@@ -1,3 +1,6 @@
{ {
"pages": ["3.1-beta", "2.0.0-beta"] "pages": [
"3.2-beta",
"2.0.0-beta"
]
} }

2
apps/docs/src/app/(home)/page.tsx
View File

@@ -59,7 +59,7 @@ const images = [
"https://res.cloudinary.com/technical-intelligence/image/upload/v1745546005/Palmr./profile_mizwvg.png", "https://res.cloudinary.com/technical-intelligence/image/upload/v1745546005/Palmr./profile_mizwvg.png",
]; ];
const docsLink = "/docs/3.1-beta"; const docsLink = "/docs/3.2-beta";
function Hero() { function Hero() {
return ( return (

2
apps/docs/src/app/api/search/route.ts
View File

@@ -9,6 +9,6 @@ export const { GET } = createFromSource(source, (page) => {
url: page.url, url: page.url,
id: page.url, id: page.url,
structuredData: page.data.structuredData, structuredData: page.data.structuredData,
tag: page.url.startsWith("/docs/3.1-beta") ? "v3.2-beta" : "v2.0.0-beta", tag: page.url.startsWith("/docs/3.2-beta") ? "v3.2-beta" : "v2.0.0-beta",
}; };
}); });

4
apps/docs/src/app/docs/[[...slug]]/page.tsx
View File

@@ -11,7 +11,7 @@ import { Sponsor } from "../components/sponsor";
export default async function Page(props: { params: Promise<{ slug?: string[] }> }) { export default async function Page(props: { params: Promise<{ slug?: string[] }> }) {
const params = await props.params; const params = await props.params;
const page = source.getPage(params.slug); const page = source.getPage(params.slug);
if (!page) redirect("/docs/3.1-beta"); if (!page) redirect("/docs/3.2-beta");
const MDXContent = page.data.body; const MDXContent = page.data.body;
@@ -49,7 +49,7 @@ export async function generateStaticParams() {
export async function generateMetadata(props: { params: Promise<{ slug?: string[] }> }) { export async function generateMetadata(props: { params: Promise<{ slug?: string[] }> }) {
const params = await props.params; const params = await props.params;
const page = source.getPage(params.slug); const page = source.getPage(params.slug);
if (!page) redirect("/docs/3.1-beta"); if (!page) redirect("/docs/3.2-beta");
return { return {
title: page.data.title + " | Palmr. Docs", title: page.data.title + " | Palmr. Docs",

4
apps/docs/src/app/layout.tsx
View File

@@ -28,7 +28,7 @@ export default function Layout({ children }: { children: ReactNode }) {
<RootProvider <RootProvider
search={{ search={{
options: { options: {
defaultTag: "3.1-beta", defaultTag: "3.2-beta",
tags: [ tags: [
{ {
name: "v2.0.0 Beta", name: "v2.0.0 Beta",
@@ -36,7 +36,7 @@ export default function Layout({ children }: { children: ReactNode }) {
}, },
{ {
name: "v3.0 Beta ✨", name: "v3.0 Beta ✨",
value: "3.1-beta", value: "3.2-beta",
props: { props: {
style: { style: {
border: "1px solid rgba(0,165,80,0.2)", border: "1px solid rgba(0,165,80,0.2)",

20
apps/docs/src/components/OIDCProviderCards.tsx
View File

@@ -6,61 +6,61 @@ const providers = [
{ {
name: "Google", name: "Google",
description: "Configure authentication using Google OAuth2 services", description: "Configure authentication using Google OAuth2 services",
href: "/docs/3.1-beta/oidc-authentication/google", href: "/docs/3.2-beta/oidc-authentication/google",
icon: <Chrome className="w-4 h-4" />, icon: <Chrome className="w-4 h-4" />,
}, },
{ {
name: "Discord", name: "Discord",
description: "Set up Discord OAuth2 for community-based authentication", description: "Set up Discord OAuth2 for community-based authentication",
href: "/docs/3.1-beta/oidc-authentication/discord", href: "/docs/3.2-beta/oidc-authentication/discord",
icon: <MessageSquare className="w-4 h-4" />, icon: <MessageSquare className="w-4 h-4" />,
}, },
{ {
name: "GitHub", name: "GitHub",
description: "Enable GitHub OAuth for developer-friendly sign-in", description: "Enable GitHub OAuth for developer-friendly sign-in",
href: "/docs/3.1-beta/oidc-authentication/github", href: "/docs/3.2-beta/oidc-authentication/github",
icon: <Github className="w-4 h-4" />, icon: <Github className="w-4 h-4" />,
}, },
{ {
name: "Zitadel", name: "Zitadel",
description: "Enterprise-grade identity and access management", description: "Enterprise-grade identity and access management",
href: "/docs/3.1-beta/oidc-authentication/zitadel", href: "/docs/3.2-beta/oidc-authentication/zitadel",
icon: <Shield className="w-4 h-4" />, icon: <Shield className="w-4 h-4" />,
}, },
{ {
name: "Auth0", name: "Auth0",
description: "Flexible identity platform with extensive customization", description: "Flexible identity platform with extensive customization",
href: "/docs/3.1-beta/oidc-authentication/auth0", href: "/docs/3.2-beta/oidc-authentication/auth0",
icon: <Lock className="w-4 h-4" />, icon: <Lock className="w-4 h-4" />,
}, },
{ {
name: "Authentik", name: "Authentik",
description: "Open-source identity provider with modern features", description: "Open-source identity provider with modern features",
href: "/docs/3.1-beta/oidc-authentication/authentik", href: "/docs/3.2-beta/oidc-authentication/authentik",
icon: <Key className="w-4 h-4" />, icon: <Key className="w-4 h-4" />,
}, },
{ {
name: "Frontegg", name: "Frontegg",
description: "User management platform for B2B applications", description: "User management platform for B2B applications",
href: "/docs/3.1-beta/oidc-authentication/frontegg", href: "/docs/3.2-beta/oidc-authentication/frontegg",
icon: <Egg className="w-4 h-4" />, icon: <Egg className="w-4 h-4" />,
}, },
{ {
name: "Kinde Auth", name: "Kinde Auth",
description: "Developer-first authentication and user management", description: "Developer-first authentication and user management",
href: "/docs/3.1-beta/oidc-authentication/kinde-auth", href: "/docs/3.2-beta/oidc-authentication/kinde-auth",
icon: <Users className="w-4 h-" />, icon: <Users className="w-4 h-" />,
}, },
{ {
name: "Pocket ID", name: "Pocket ID",
description: "Open-source identity provider with OIDC support", description: "Open-source identity provider with OIDC support",
href: "/docs/3.1-beta/oidc-authentication/pocket-id", href: "/docs/3.2-beta/oidc-authentication/pocket-id",
icon: <Key className="w-4 h-4" />, icon: <Key className="w-4 h-4" />,
}, },
{ {
name: "Other", name: "Other",
description: "Configure any other OIDC-compliant identity provider", description: "Configure any other OIDC-compliant identity provider",
href: "/docs/3.1-beta/oidc-authentication/other", href: "/docs/3.2-beta/oidc-authentication/other",
icon: <Settings className="w-4 h-4" />, icon: <Settings className="w-4 h-4" />,
}, },
]; ];