@arcjet/astro

[Arcjet][arcjet] helps developers protect their apps in just a few lines of
code. Implement rate limiting, bot protection, email verification, and defense
against common attacks.

This is the [Arcjet][arcjet] SDK integration for [Astro][astro].

- npm package (@arcjet/astro)
- GitHub source code (arcjet-astro/ in arcjet/arcjet-js)

Getting started

Visit the [quick start guide][quick-start] to get started.

Example

Try an Arcjet protected Next.js app live at
[example.arcjet.com][example-next-url]
([source code][example-next-source]).
See [arcjet/example-astro][example-astro-source] for an Astro example.

What is this?

This is our adapter to integrate Arcjet into Astro.
Arcjet helps you secure your Astro website.
This package exists so that we can provide the best possible experience to
Astro users.

When should I use this?

You can use this if you are using Astro.
See our [_Get started_ guide][arcjet-get-started] for other supported
frameworks.

Install

This package is ESM only.
Install with npm and the Astro CLI in Node.js:

``sh
npx astro add @arcjet/astro
`

Use

Configure Arcjet in astro.config.mjs:

`js
import arcjet, { shield } from "@arcjet/astro";
import { defineConfig } from "astro/config";

export default defineConfig({
// We recommend setting
// validateSecrets.
env: { validateSecrets: true },
integrations: [
arcjet({
rules: [
// Shield protects your app from common attacks.
// Use DRY_RUN instead of LIVE to only log.
shield({ mode: "LIVE" }),
],
}),
],
});
`

…then use Arcjet in on-demand routes (such as src/pages/api.json.ts):

`ts
import type { APIRoute } from "astro";
import aj from "arcjet:client";

export const GET: APIRoute = async ({ request }) => {
const decision = await aj.protect(request);

if (decision.isDenied()) {
return Response.json({ message: "Forbidden" }, { status: 403 });
}

return Response.json({ message: "Hello world" });
};
``

For more on how to configure Arcjet with Astro and how to protect Astro,
see the [Arcjet Astro SDK reference][arcjet-reference-astro] on our website.

License

[Apache License, Version 2.0][apache-license] © [Arcjet Labs, Inc.][arcjet]

[arcjet-get-started]: https://docs.arcjet.com/get-started
[arcjet-reference-astro]: https://docs.arcjet.com/reference/astro
[arcjet]: https://arcjet.com
[astro]: https://astro.build/
[example-astro-source]: https://github.com/arcjet/example-astro
[example-next-source]: https://github.com/arcjet/example-nextjs
[example-next-url]: https://example.arcjet.com
[quick-start]: https://docs.arcjet.com/get-started/astro
[apache-license]: http://www.apache.org/licenses/LICENSE-2.0