Jahia GraphQL Extension Websites

The purpose of this module is to allow the creation, deletion, import and export of a website thanks to GraphQL queries.

Permissions

All mutations in this module require the websitesAdmin permission. Callers that do not hold this permission will have their request rejected by the GraphQL security layer before any operation is attempted.

Note that exportAllSites runs the export under the calling user's own JCR session (SEC-136) — it does not escalate to root. The resulting archive is confined to the content the caller is authorized to read, so a websitesAdmin holder cannot use it to capture content beyond their own read rights. importWebsite additionally requires full server-administrator rights (it imports users and roles), not merely websitesAdmin.

Installation

• In Jahia, go to "Administration --> Server settings --> System components --> Modules"
• Upload the JAR graphql-extension-websites-X.X.X.jar
• Check that the module is started

Configuration (AWS S3 for exportAllSites)

AWS S3 credentials and bucket details must be set via the OSGi ConfigurationAdmin service — never pass them inline in a GraphQL mutation.

Edit (or drop) the file at:

<jahia-var>/karaf/etc/org.jahia.community.graphql.websites.cfg

aws.s3.region=us-east-1
aws.s3.bucketName=my-backup-bucket
aws.s3.accessKey=<your-access-key-id>
aws.s3.secretAccessKey=<your-secret-access-key>

The default shipped configuration (src/main/resources/META-INF/configurations/org.jahia.community.graphql.websites.cfg) has all values blank so that exportAllSites returns AWS_S3_BUCKET_NOT_CONFIGURED until the administrator provides real credentials. Jahia's module extender will not overwrite a deployed karaf/etc file that was already customised (the file starts with # default configuration - won't be overridden).

How to use

In the tools

• Go to the page "Jahia GraphQL Core Provider : graphql-playground" (JAHIA_URL/modules/graphql-dxm-provider/tools/graphql-playground.jsp)

Creation

mutation {
    admin {
        jahia {
            websites {
                createSiteByKey(
                    siteKey: "SITE_KEY"
                    serverName: "SERVER_NAME"
                    title: "SITE_TITLE"
                    templateSet: "TEMPLATE_SET"
                    locale: "LOCALE"
                )
            }
        }
    }
}

Deletion

mutation {
    admin {
        jahia {
            websites {
                deleteSiteByKey(siteKey: "SITE_KEY")
            }
        }
    }
}

Import

mutation {
    admin {
        jahia {
            websites {
                importWebsite(
                    importPath: "RELATIVE_IMPORT_PATH",
                    siteKey: "SITE_KEY"
                )
            }
        }
    }
}

Export

mutation {
    admin {
        jahia {
            websites {
                exportWebsite(
                    siteKey: "SITE_KEY",
                    exportPath: "RELATIVE_EXPORT_PATH",
                    onlyStaging: true
                )
            }
        }
    }
}

Export All Sites To AWS S3

Configure credentials via the .cfg file described in the Configuration section above, then trigger the export:

mutation {
    admin {
        jahia {
            websites {
                exportAllSites
            }
        }
    }
}

Possible return values:

• SUCCESS — export and S3 upload completed; the local ZIP was removed.
• AWS_S3_BUCKET_NOT_CONFIGURED — one or more S3 config values are blank; no upload attempted.

On an unexpected error the mutation raises a GraphQL error (DataFetchingException) rather than returning an enum value — check the Jahia server logs.

Security note: do not set credentials inline via the configuration(...) mutation as shown in older documentation. That approach leaks secrets into GraphQL access logs and audit trails. Use the .cfg file or an OSGi-compatible secrets manager instead.

Residual risks (documented, not fixed here)

• Pre-import zip-slip / archive validation: the ZIP content is validated by Jahia core's ImportExportBaseService. This module delegates entirely to that layer; no additional ZIP-slip check is performed here. The mutation is gated by websitesAdmin, so only trusted administrators can trigger imports.
• exportAllSites privilege scope: the export runs under the caller's own session (SEC-136) and is confined to content the caller can read, so it is not an instance-wide root dump. Any further tightening of the required permission beyond websitesAdmin is deferred.