This software allows you to generate a sitemap for your Wiki.js instance.
Currently, it only supports Postgres, but support for MySQL will be added if requested or if I have the time.
It supports Postgres, MySQL and MariaDB.
You can run it as a standalone Node.js program or within a Docker container.
- It connects to your Wiki.js database
- It generates a sitemap for public posts.
You can view a demo of the sitemap on the following Wiki.js site: https://testwiki.hostwiki.io
The sitemap can be accessed at: https://testwiki.hostwiki.io/sitemap.xml
- Does not handle splitting the sitemap in the event of exceeding the 50,000 URL limit for sitemaps
- It regenerates the sitemap every 24 hours (will be configurable in future updates)
Only supports postgres (need MYSQL or SQLite support? create an issue)
- Wiki.js (with Postgres, MySQL or MariaDB)
- Reverse proxy (e.g Nginx, Apache)
To use, you must be serving your Wiki.js instance over a reverse proxy server.
The service is exposed via port 3012 to avoid any port conflicts with Wiki.js.
Edit the .env to include your database credential.
git clone https://github.com/hostwiki/wikijs-sitemap
cd wikijs-sitemap
npm ci installStart the server with
node serverTo keep the nodejs program running, you can use pm2 or run it as a service.
Make sure to pass the correct environment variables.
The DB_TYPE accepts postgres, mysql and mariadb as possible values. It defaults to postgres if not set.
You use DB_PASS or DB_PASS_FILE to set your database password.
-e DB_TYPE=postgres
-e DB_HOST=
-e DB_PORT=
-e DB_PASS=
-e DB_USER=
-e DB_NAME=
You can find a Docker Compose examples for Postgres and MySQL in the example directory.
If you wish to run it via docker create:
docker create --name=wikijs-sitemap -e DB_TYPE=postgres -e DB_HOST=db -e DB_PORT=5432 -e DB_PASS_FILE=/etc/wiki/.db-secret -v /etc/wiki/.db-secret:/etc/wiki/.db-secret:ro -e DB_USER=wiki -e DB_NAME=wiki --restart=unless-stopped --network=wikinet -p 3012:3012 hostwiki/wikijs-sitemap:latestdocker start wikijs-sitemapIf you wish to run it via docker run:
docker run --name wikijs-sitemap -e DB_TYPE=postgres -e DB_HOST=db -e DB_PORT=5432 -e DB_PASS_FILE=/etc/wiki/.db-secret -v /etc/wiki/.db-secret:/etc/wiki/.db-secret:ro -e DB_USER=wiki -e DB_NAME=wiki --restart=unless-stopped --network=wikinet -p 3012:3012 -d hostwiki/wikijs-sitemap:latestAfter a successful setup, the sitemap will be available at localhost:3012/sitemap.xml.
Next, you have to proxy it via a reverse proxy server like Nginx or Apache.
location /sitemap.xml {
proxy_pass http://127.0.0.1:3012/sitemap.xml;
proxy_http_version 1.1;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
Make sure to install the necessary Apache mods.
sudo a2enmod proxy proxy_httpThen add this to your Wiki.js apache configuration file.
ProxyPreserveHost On
ProxyPass /sitemap.xml http://localhost:3012/sitemap.xml
ProxyPassReverse /sitemap.xml http://localhost:3012/sitemap.xml
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent