Provision/update sitemap-generator #8

New Issue

emil · 2023-11-04T00:29:05Z

emil commented

2023-11-04 00:29:05 +00:00

User story

As an owner of a Wiki.js instance on The Edge, I would like my wiki website to be easily registered with a variety of web search engines (Google search, Bing, Yandex, etc.), so that pages would be indexed and easier to find on the Internet.

Context

While Wiki.js is great software for knowledge management, SEO is not a strength of its current stable version. It doesn't create a sitemap.xml automatically as many other web applications do. This is a known limitation and there are Github issues raising the awareness, e.g. this one. Someone created a small open source app that bridges this gap.

It needs to be installed in the Edge container of an already running Wiki.js instance, where the sitemap generator app will be run as a daemon and thus a new HTTP endpoint for generating sitemap.xml will be added.

The reverse proxy on the Internet Gateway will make it transparent to search engines how exactly the sitemap file will be generated.

Acceptance criteria

The most up to date version of the sitemap generator has been fetched in the container from https://github.com/hostwiki/wikijs-sitemap.
wikijs-sitemap has been configured to connect to the existing Wiki.js database in the Edge container through.
wikijs-sitemap has been verified to start and stop successfully and to respond with a sitemap to HTTP requests.

# User story As an owner of a Wiki.js instance on *The Edge*, I would like my wiki website to be easily registered with a variety of web search engines (Google search, Bing, Yandex, etc.), so that pages would be indexed and easier to find on the Internet. # Context While Wiki.js is great software for knowledge management, SEO is not a strength of its current stable version. It doesn't create a `sitemap.xml` automatically as many other web applications do. This is a known limitation and there are Github issues raising the awareness, e.g. [this one](https://github.com/requarks/wiki/discussions/5312). Someone created a small [open source app](https://github.com/hostwiki/wikijs-sitemap) that bridges this gap. It needs to be installed in the Edge container of an already running Wiki.js instance, where the sitemap generator app will be run as a daemon and thus a new HTTP endpoint for generating `sitemap.xml` will be added. The reverse proxy on the Internet Gateway will make it transparent to search engines how exactly the sitemap file will be generated. # Acceptance criteria 1. The most up to date version of the sitemap generator has been fetched in the container from `https://github.com/hostwiki/wikijs-sitemap`. 2. `wikijs-sitemap` has been configured to connect to the existing Wiki.js database in the Edge container through. 3. `wikijs-sitemap` has been verified to start and stop successfully and to respond with a sitemap to HTTP requests.

emil added this to the wiki.js - installation & update project 2023-11-04 00:29:05 +00:00

emil added a new dependency 2023-11-10 22:05:56 +00:00

#12 Define, enable and start a systemd service for the sitemap generator

emil changed title from ~~Provision sitemap-generator in Edge container~~ to Provision sitemap-generator

2023-11-10 22:43:40 +00:00

emil added the

Edge Container

label 2023-11-10 22:45:57 +00:00

emil changed title from ~~Provision sitemap-generator~~ to Provision/update sitemap-generator

2023-11-10 23:49:49 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Blocks

#12 Define, enable and start a systemd service for the sitemap generator

the-liberated-edge/wikijs

Reference: the-liberated-edge/wikijs#8