Tilføj kommentarer til din Django-app

• Python 3.10+
• Django 4.2, 5.0, 5.1, eller 5.2
• Et FastComments tenant ID (brug demo for at prøve det uden en konto)
• Et API secret er kun påkrævet for Secure SSO

Installer fra et release-tag (dette projekt distribueres via git-tags, ikke PyPI):

pip install "git+https://github.com/fastcomments/fastcomments-django.git@v0.1.0"

For server-side REST-adgang (hjælperne admin() / public_api()), tilføj api ekstra, som henter SDK'ens genererede klient:

pip install "fastcomments-django[api] @ git+https://github.com/fastcomments/fastcomments-django.git@v0.1.0"

Tilføj appen til INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "fastcomments_django",
]

Konfigurer din tenant i settings.py:

import os

FASTCOMMENTS = {
    "TENANT_ID": os.environ.get("FASTCOMMENTS_TENANT_ID", "demo"),
}

Indsæt widget'en i enhver skabelon:

{% load fastcomments %}

{% fastcomments url_id="my-page" %}

For at automatisk videregive den indloggede bruger til widgeten, læser tag'ene den aktuelle bruger fra request'en. Sørg for, at dit projekt har begge disse (de er som standard aktiveret i et standard Django‑projekt):

• django.template.context_processors.request i TEMPLATES["OPTIONS"]["context_processors"]
• django.contrib.auth.middleware.AuthenticationMiddleware i MIDDLEWARE

Uden en request i skabelonens kontekst, renderes widgets for en anonym besøgende. Du kan altid videregive en bruger eksplicit: {% fastcomments user=some_user %}.

Every widget has its own tag. All of them accept **extra keyword arguments, which are merged into the widget config as‑is (use camelCase keys) for anything not covered by the named arguments below.

Named arguments map to the widget's camelCase config keys:

Eksempler:

{% load fastcomments %}

{% fastcomments url_id="my-page" locale="en_us" default_sort_direction="MR" %}

{% fastcomments_live_chat url_id="room-1" %}

Comments: {% fastcomments_comment_count url_id="my-page" number_only=True %}

{# Samarbejdschat knytter sig til et eksisterende element på siden #}
<article id="post-body">...</article>
{% fastcomments_collab_chat target="#post-body" %}

{# Masseoptællinger: placer markører, derefter fylder en masseindlæser dem alle ind #}
{% for post in posts %}
    <a href="\{{ post.url }}">\{{ post.title }}</a>
    {% fastcomments_count_marker url_id=post.url_id %}
{% endfor %}
{% fastcomments_comment_count_bulk %}

Enable SSO og vælg en tilstand i settings.py. Secure SSO underskriver brugeren på server‑siden med HMAC‑SHA256 ved hjælp af din API‑hemmelighed og anbefales.

FASTCOMMENTS = {
    "TENANT_ID": os.environ["FASTCOMMENTS_TENANT_ID"],
    "API_KEY": os.environ["FASTCOMMENTS_API_KEY"],   # din API‑hemmelighed; underskriver Secure SSO
    "SSO": {
        "ENABLED": True,
        "MODE": "secure",                            # "secure" | "simple"
        # Kortlæg FastComments‑felter til din brugermodel. Værdier kan være et attribut
        # navn, en punktnotation‑sti ("profile.avatar_url"), et callable(user), eller None.
        "USER_MAP": {
            "id": "id",
            "email": "email",
            "username": "username",
            "avatar": None,
            "display_name": None,
            "website_url": None,
        },
        "IS_ADMIN": lambda user: user.is_staff,      # callable(user) -> bool, eller punktnotation‑sti
        "IS_MODERATOR": None,
        "GROUP_IDS": None,                           # callable(user) -> list, eller punktnotation‑sti
    },
}

Vælg SSO id bevidst. FastComments id er den permanente håndtag for en brugers kommentarthistorik. Standard-USER_MAP kortlægger den til din Django‑primærnøgle for nul‑konfigurations‑bekvemmelighed, men sekventielle heltals‑PK'er er gennemskuelige og svære at ændre senere (ændring af en brugers id opdeler deres historik i en ny konto). For alt ud over en demo, kortlæg id til en stabil, uigennemsigtig værdi valgt på forhånd (en UUID eller et dedikeret offentligt id), og læg aldrig private data i den. Eksempel‑appen bruger et brugernavns‑baseret id af denne grund.

SSO injiceres automatisk i {% fastcomments %}, {% fastcomments_live_chat %}, {% fastcomments_collab_chat %}, {% fastcomments_image_chat %} og {% fastcomments_user_activity %} for den aktuelle bruger.

Login-/logout‑URL’er, der vises for ikke‑loggede besøgende, standard er reverse("login") / reverse("logout"); tilsidesæt dem med SSO["LOGIN_URL"] / SSO["LOGOUT_URL"].

Tilpasset kortlægning

To højere præcedens‑indstillinger har forrang over USER_MAP:

• En metode på din brugermodel (den Python‑ækvivalente analog til et interface):

  class User(AbstractUser):
      def to_fastcomments_user_data(self):
          return {"id": self.pk, "email": self.email, "username": self.get_username()}

• En global mapper, en punktnotation‑sti til callable(user) -> dict:

  FASTCOMMENTS = {"SSO": {"USER_MAPPER": "myapp.sso.map_user"}}

Præcedens er USER_MAPPER > to_fastcomments_user_data() > USER_MAP.

Med udvidelsen [api] installeret kan du kalde FastComments REST API'en gennem SDK'en, som er forudkonfigureret med din API-nøgle og region:

from fastcomments_django import admin, public_api, get_manager

admin().get_comments("YOUR_TENANT_ID", ...)     # godkendt (DefaultApi)
public_api().get_comments_public(...)            # offentlig (PublicApi)

# Generér en SSO-token til API‑kald eller klientoverdragelse:
token = get_manager().sso().token_for(request.user)

Indstil REGION for at rute widgets og API til EU:

FASTCOMMENTS = {"TENANT_ID": "...", "REGION": "eu"}

Overskriv fastcomments/widget.html ved at placere din egen kopi tidligere på
skabelonsøgestien (et projekt templates/fastcomments/widget.html). Dette er
Django-analogen til Laravel's vendor:publish --tag=fastcomments-views.

A runnable showcase lives in example/: a left-rail + main-stage app with a page per widget and a sign-in page listing pre-seeded demo users.
Log ind som en af dem, og kommentar‑ og live‑chat‑widgetsene autentificerer den identitet via Secure SSO. Fra den mappe:

python manage.py migrate
# Use your own tenant to see Secure SSO in action (an API secret enables it):
FASTCOMMENTS_TENANT_ID=... FASTCOMMENTS_API_KEY=... python manage.py runserver

Uden en API secret falder den tilbage til den offentlige demo tenant (anonymous).
example/browser_smoke.py er en Playwright e2e der indlæser siden i en rigtig browser og poster en kommentar som Secure‑SSO‑brugeren.