[go: nahoru, domu]

Skip to content
/ next-strapi-sitemap Public template

Generate sitemap and robots.txt for NextJS used web hook from STRAPI

Notifications You must be signed in to change notification settings

stovv/next-strapi-sitemap

Repository files navigation

SiteMap and Robots.txt generator for NextJS with STR API

Getting started

  1. Clone into scripts folder into nextjs project

    cd <your project on nextjs>
    git clone https://github.com/stovv/next-strapi-sitemap.git scripts
  2. Install dependencies

    cd  <your project on nextjs>/scripts
    
    # if you use yarn
    yarn install
    
    # if you use npm
    # npm install 
  3. Update start command in package.json

    {
        "name": "project name",
        ...
        "start": "next start & cd scripts;node sitemap-generator.js"
    }
  4. Create .env file by example in .env.example

    # port for sitemap generator server 
    PORT=
    
    # host name of site for sitemap generate
    # e.g https://sitename.com
    HOST=
    
    # host name for your strapi instanse
    # e.g https://strapi.sitename.com
    BACKEND_HOST=
    
    # a secret token that will be transmitted to the generator to check the adequacy of the call
    WEBHOOK_TOKEN=
  5. Generate webhook token
    You can use services like this https://www.random.org/strings/

  6. Go to your strapi admin panel

    1. Open admin/settings/webhooks
    2. Click to Create New Webhook button
    3. Fill
    4. Add Header
      • Key = Authorization
      • Value = your generated webhook token from 6 step
    5. Select all action on entry (create, update, delete)

    webhook example

  7. Update next.config.js for initial generate sitemaps and robots on next build

     // next.config.js
     const withPlugins = require('next-compose-plugins');
     module.exports = withPlugins(
         [ ],
         {
             webpack: (config, { buildId, dev, isServer, defaultLoaders, webpack }) => {
                 if (isServer){
                 // Generate sitemaps and robots.txt
                     const { generate } = require('./scripts/generate-sitemap');
                     generate(
                     // Public host name for sitemap generation
                     'https://sitename.ru',
                     // subfolder for generated sitemaps (not index sitemap) in public folder
                     'sitemaps',
                     // folder for generated sitemaps and robots.txt
                     './public',
                     // disallow routes in robots.txt
                     ['/api/', '/login']
                     );
                 }
                 return config;
             }
         }
     );
  8. Start your project by yarn start or npm run start


Enjoy! 🤘

About

Generate sitemap and robots.txt for NextJS used web hook from STRAPI

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published