Skip to main content

Differentiation between KurocoFiles Directories and Domains

Types and Usage of KurocoFiles Directories​

KurocoFiles has the following three directory types:

KurocoFiles​

Usage: Static content to be publicly accessible to internet users.

Features:

  • Public files accessible to anyone without authentication.
  • Fastest access possible.

KurocoFiles (Restricted Access)​

Usage: Static content requiring authentication.

Features:

  • Accessible only to authenticated users.
  • Fine access control based on group permissions.
  • Secure file delivery.

KurocoFiles (Metadata)​

Usage: Files requiring credit or description information.

Features:

  • Ability to attach credit information and descriptions to files.
  • Metadata included in API responses.
  • File information management in the file manager.

Types and Usage of Domains​

Files in KurocoFiles can be accessed through the following three domains:

API Domain​

Domain: kuroco.app

Features:

  • If using Cookie authentication in the API, the credentials can be directly used.
  • Image optimization feature does not work.
  • Counted as API requests.

Files Domain​

Domain: kuroco-img.app

Features:

  • URLs included in API responses point to this domain.
  • URLs in API responses for authenticated files include a t=... token.
  • Image optimization feature works.
  • Most common method for file access.

Admin Panel Domain​

Domain: kuroco-mng.app

Features:

  • Authentication in the admin panel can be directly used.
  • Image optimization and caching features do not work.
  • Ideal for site administrators to check files.

Use Cases​

  • Case 1: Files for Admin Panel Plugin
    Admin Panel Domain + KurocoFiles (Restricted Access)

    Reasons:
      - Files not meant for public access → Restricted Access Directory
      - Intended for use in admin panel → Utilize Admin Panel Domain for authentication
      - Emphasis on security over response speed

    Note: If files can be public, using Files Domain + KurocoFiles (Normal) provides faster responses.

  • Case 2: Public Images for Frontend
    Files Domain + KurocoFiles (Normal)

    Reasons:
      - General public content → Normal Directory
      - Utilize image optimization feature → Files Domain
      - Fast access possible

  • Case 3: Member-Exclusive Static Content
    API Domain + KurocoFiles (Restricted Access)

    Reasons:
      - Authentication required → Restricted Access Directory
      - Utilize Cookie authentication → API Domain
      - Integration with frontend authentication state

    Note: Even for authenticated files, if accessing URLs from API responses, the URLs contain tokens making Files Domain usable directly.

  • Case 4: Images Requiring Copyright Protection
    Files Domain + KurocoFiles (with metadata)
    Reasons:
      - Credit information required → Directory with metadata
      - Utilize image optimization → Files Domain
      - Metadata retrievable in API response

By selecting the appropriate combination of directories and domains, optimal file management can be achieved in terms of security, performance, and functionality. Please choose the best configuration based on your needs.

Support

If you have any other questions, please contact us or check out Our Slack Community.

Contact form
Join Kuroco Slack community