wiki README

The project's README from github.com/requarks/wiki. As one markdown file: README.md.

Wiki.js

Release License Standard - JavaScript Style Guide Build + Publish
GitHub Sponsors Open Collective backers and sponsors Downloads Docker Pulls
Chat on Discord Follow on Bluesky Follow on Telegram Reddit

A modern, lightweight and powerful wiki app built on NodeJS

Follow our Twitter feed to learn about upcoming updates and new releases!

Donate

Wiki.js is an open source project that has been made possible due to the generous contributions by community backers. If you are interested in supporting this project, please consider becoming a sponsor, becoming a patron, donating to our OpenCollective, via Paypal or via Ethereum (0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5).

Become a Sponsor Become a Patron Donate on OpenCollective Donate via Paypal
Donate via Ethereum Buy a T-Shirt

Gold Tier Sponsors

GitHub Sponsors

Support this project by becoming a sponsor. Your name will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [Become a sponsor]

Alexander Casassovici
(@alexksso)
Broxen
(@broxen)
Dacon
(@xDacon)
Maxime Pierre
(@DonNabla)
Jay Daley
(@JayDaley)
Oleksii
(@idokka)
Shane Kearney
(@shanekearney)

OpenCollective Sponsors

Support this project by becoming a sponsor. Your logo will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [Become a sponsor]

Patreon Backers

Thank you to all our patrons! 🙏 [Become a patron]

  • Aeternum
  • Al Romano
  • Alex Balabanov
  • Alex Milanov
  • Alex Zen
  • Arti Zirk
  • Ave
  • Brandon Curtis
  • Damien Hottelier
  • Daniel T. Holtzclaw
  • Dave 'Sri' Seah
  • djagoo
  • dz
  • Douglas Lassance
  • Ergoflix
  • Ernie Reid
  • Etienne
  • Flemis Jurgenheimer
  • Florent
  • Günter Pavlas
  • hong
  • Hope
  • Ian
  • Imari Childress
  • Iskander Callos
  • Josh Stewart
  • Justin Dunsworth
  • Keir
  • Loïc CRAMPON
  • Ludgeir Ibanez
  • Lyn Matten
  • Mads Rosendahl
  • Mark Mansur
  • Matt Gedigian
  • Mike Ditton
  • Nate Figz
  • Patryk
  • Paul O'Fallon
  • Philipp Schürch
  • Tracey Duffy
  • Quaxim
  • Richeir
  • Sergio Navarro Fernández
  • Shad Narcher
  • ShadowVoyd
  • SmartNET.works
  • Stepan Sokolovskyi
  • Zach Crawford
  • Zach Maynard
  • 张白驹

OpenCollective Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Special Thanks

Browserstack
Browserstack for providing access to their great cross-browser testing tools.

Cloudflare
Cloudflare for providing their great CDN, SSL and advanced networking services.

DigitalOcean
DigitalOcean for providing hosting of the Wiki.js documentation site and APIs.

Icons8
Icons8 for providing access to their beautiful icon sets.

Lokalise
Lokalise for providing access to their great localization tool.

MacStadium
MacStadium for providing access to their Mac hardware in the cloud.

Netlify
Netlify for providing hosting for our website.

ngrok
ngrok for providing access to their great HTTP tunneling services.

Porkbun
Porkbun for providing domain registration services.

wiki (requarks/wiki)

Searching Database…

29K ·GitHub
Что это такое?Wiki.js — вики-приложение с открытым исходным кодом на Node.js: веб-приложение для собственного сервера, где можно писать и упорядочивать документацию и базу знаний команды.
Wiki.js — это облачный сервис или что-то, что я запускаю сам?Вы запускаете его сами: это серверное приложение на Node.js, которое разворачивается на вашей собственной инфраструктуре, а страницы читаются и редактируются через браузер.
Как его запустить?Следуйте официальному руководству по установке на сайте документации; приложению нужен Node.js 20 или новее, а для развёртывания в Kubernetes есть Helm-чарт.
Есть ли подводные камни — лицензия или что-то ещё?Проект распространяется по лицензии AGPL-3.0: если вы измените Wiki.js и будете предлагать его как сетевой сервис, вы обязаны открыть изменённый исходный код. Сервер с Node.js 20+ вы тоже обслуживаете сами.
Он работает только под Linux или на любой ОС?Проект кроссплатформенный — подойдёт всё, где работает Node.js 20+; CI нацелен на Linux и развёртывание в Kubernetes, а посетителям нужен только браузер.
Какие интеграции есть из коробки?Среди зависимостей — поиск Algolia, аутентификация Keycloak, Azure Blob Storage, сервер Apollo GraphQL, инструменты для сертификатов ACME/Let's Encrypt и защита от спама Akismet. То есть поиск, SSO, облачное хранилище, API, автоматический SSL и фильтрация спама встроены.
Можно попробовать до установки?Да, в README вместе с документацией и руководствами по установке есть ссылка на официальный демо-стенд. Проект существует с 2016 года и набрал около 29 000 звёзд на GitHub.
Как хранится сам контент — обычные файлы, Markdown?Markdown и git входят в число ключевых тем проекта: страницы пишутся в Markdown, а интеграция с git — полноценная функция. Какие именно хранилища поддерживаются, описано в официальной документации.
What are similar projects?PandaWiki, docs, outline, gollum, docmost, BookStack, jevbox, directus
Creator
requarks
Size
51.1 MB
Stars
29K
Age
10y
Commits · 90 Days