diff --git a/website/integrations/services/filerise/index.mdx b/website/integrations/services/filerise/index.mdx new file mode 100644 index 0000000000..192d6ab2eb --- /dev/null +++ b/website/integrations/services/filerise/index.mdx @@ -0,0 +1,56 @@ +--- +title: Integrate with FileRise +sidebar_label: FileRise +support_level: community +--- + +## What is FileRise + +> Lightweight, self-hosted web-based file manager with multi-file upload, editing, and batch operations. +> +> -- https://github.com/error311/FileRise + +## Preparation + +The following placeholders are used in this guide: + +- `filerise.company` is the FQDN of the FileRise installation. +- `authentik.company` is the FQDN of the authentik installation. + +:::note +This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application. +::: + +## authentik configuration + +To support the integration of FileRise with authentik, you need to create an application/provider pair in authentik. + +### Create an application and provider in authentik + +1. Log in to authentik as an administrator and open the authentik Admin interface. +2. Navigate to **Applications** > **Applications** and click **Create with Provider** to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.) + + - **Application**: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. + - **Choose a Provider type**: select **OAuth2/OpenID Connect** as the provider type. + - **Configure the Provider**: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations. + - Note the **Client ID**,**Client Secret**, and **slug** values because they will be required later. + - Set **Redirect URI** to `https://filerise.company/api/auth/auth.php?oidc=callback`. + - Select any available signing key. + - **Configure Bindings** _(optional)_: you can create a [binding](/docs/add-secure-apps/flows-stages/bindings/) (policy, group, or user) to manage the listing and access to applications on a user's **My applications** page. + +3. Click **Submit** to save the new application and provider. + +## FileRise configuration + +1. Log in to FileRise as an administrator. +2. Click on your profile icon in the upper right corner, then select **Admin Panel**. +3. Open the **OIDC Configuration & TOTP** section and configure the following settings: + - **OIDC Provider URL**: `https://authentik.company/application/o//` + - **OIDC Client OpenID**: Client ID from authentik. + - **OIDC Client Secret**: Client Secret from authentik. + - **OIDC Redirect URI**: `https://filerise.company/api/auth/auth.php?oidc=callback` +4. Click **Save Settings**. + +## Configuration verification + +To confirm that authentik is properly configured with FileRise, log out and log back in using the **Login with OIDC** button. diff --git a/website/sidebars/integrations.mjs b/website/sidebars/integrations.mjs index ddd7f6f40d..7432a58807 100644 --- a/website/sidebars/integrations.mjs +++ b/website/sidebars/integrations.mjs @@ -133,6 +133,7 @@ const items = [ "services/adventurelog/index", "services/calibre-web/index", "services/engomo/index", + "services/filerise/index", "services/frappe/index", "services/freshrss/index", "services/gravitee/index",