Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publishing integrations with space:script:inject scope is not allowed #185

Open
JackBailey opened this issue Jun 19, 2023 · 3 comments
Open
Labels
scope-script-injection A tag to track requests for the scope script:inject

Comments

@JackBailey
Copy link

JackBailey commented Jun 19, 2023

I'm trying to create a Umami integration, forked from the Plausible one but I'm getting the error Publishing integrations with space:script:inject scope is not allowed.

I'm just trying to publish it privately for now, how do I resolve this?

My gitbook-manifest.yml:

name: Umami
title: Umami
organization: cBtGw0QchuEMpqSwIWJB
icon: ./assets/icon.png
description: Receive GitBook traffic insights directly in your Umami dashboard.
previewImages:
    - ./assets/plausible-preview.png
externalLinks:
    - label: Documentation
      url: https://www.gitbook.com/integrations/plausible
visibility: public
script: ./src/index.ts
scopes:
    - space:script:inject
contentSecurityPolicy:
    script-src: |
        https://plausible.io;
    connect-src: |
        plausible.io
        *;
summary: |
    # Overview

    Plausible Analytics are a GDPR CCPA and cookie law compliant site analytics. Web analytics is the process of measuring and analyzing the usage of a website. With Plausible activated on your website, you get access to a simple open source analytics dashboard. You can then use this data to assess the performance of your site and to figure out what you can do to improve your future efforts.

    # How it works

    The GitBook Plausible Analytics integration allows you to track traffic in your published spaces from your Plausible dashboard. Automatic tracking in your documentation: Each of your connected GitBook spaces will fetch the cookie-less Plausible tracking script and inject it in your public content.

    # Configure

    You can enable the integration on single published space by navigating to the sub-navigation and clicking on Integrations button. If you prefer to enable  the integration or multiple or all published spaces you can do so by navigating to the org settings and clicking the Integrations tab. You will need your Domain to finish the configuration.
categories:
    - analytics
configurations:
    space:
        properties:
            website:
                type: string
                title: Website ID
                description: The Website ID you configured for this Umami website.
            api:
                type: string
                title: Self-hosted API
                description: When self-hosting, configure the url of the instance API (empty when using analytics.umami.is).
        required:
            - website
@addisonschultz addisonschultz added the scope-script-injection A tag to track requests for the scope script:inject label Jun 22, 2023
@addisonschultz
Copy link
Collaborator

Hi @JackBailey,

Unfortunately right now the scope required for creating an integration like this is closed for the initial launch of the integration platform. That being said, we do know it's a highly requested feature, so have this high up on our radar for the next iteration(s) of the platform in general. We need to define a few things and figure out a secure and sustainable way to manage these kinds of scopes - and until we have that in place we'll do our best to monitor the requests coming in!

@rovertech007
Copy link

We are trying to build a private plugin for our customers to help them track the documentation usage and we are not able to use the space:script:inject. This is an important part of our product and would highly appreciate if this can be priortized.

@nimrod-codota
Copy link

nimrod-codota commented Mar 3, 2024

Hi @addisonschultz, wondering if there are any news on this? thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope-script-injection A tag to track requests for the scope script:inject
Projects
None yet
Development

No branches or pull requests

4 participants