This is an Astro integration that allows you to easily add a security.txt
file to your Astro site.
You need to be using astro@4.0.0
or higher.
Install the integration automatically using the Astro CLI:
pnpm astro add @itsmatteomanf/astro-security-txt
npx astro add @itsmatteomanf/astro-security-txt
yarn astro add @itsmatteomanf/astro-security-txt
Or install it manually:
- Install the required dependencies
pnpm add @itsmatteomanf/astro-security-txt
npm install @itsmatteomanf/astro-security-txt
yarn add @itsmatteomanf/astro-security-txt
- Add the integration to your astro config
+import securityTxt from "@itsmatteomanf/astro-security-txt";
export default defineConfig({
integrations: [
+ securityTxt({
+ contact: 'mailto:example@example.com'
+ }),
],
});
The configuration opbject, with its defaults, is here:
const options = {
contact: undefined,
expires: new Date(Date.now() + 1000 * 60 * 60 * 24 * 365),
encryption: undefined,
acknowledgements: undefined,
preferredLanguages: undefined,
canonical: undefined,
policy: undefined,
hiring: undefined,
csaf: undefined,
};
The only required option is contact
, which must be a string or an array of strings.
All other options are optional, or a string or an array of strings.
It follows the specs at securitytxt.org.
MIT Licensed. Made with ❤️ by Matteo Manfredi.