Raneto is a free, open source documentation & knowledge base project written in JavaScript and released under MIT. It has 2,904 GitHub stars, 440 forks and 91 open issues, and was last pushed 8 months ago. On this registry it ranks #52 of 100 tracked projects in Documentation & Knowledge Base, with 5 head-to-head comparisons available. It gained 2 stars over the last 30 tracked days.

What is Raneto?

Raneto is a free, open, Markdown-powered knowledge base for Node.js, built for people and teams who want a self-hosted wiki whose pages are plain files rather than rows in a database.

What it is

Raneto is a Node.js application that serves a knowledge base or wiki from a directory of Markdown files. Its README describes the project as "a free, open, simple Markdown-powered knowledge base for Node.js", and lists file-based content as its first top feature. The whole site is generated from .md files, with the content directory configurable through CONTENT_DIR and defaulting to content/pages.

It lives in the Node.js ecosystem and is distributed as a self-hosted web application rather than a hosted service. The concrete thing it replaces is a wiki or knowledge base whose pages are stored in a database and edited through that database: with Raneto the pages are .md files on disk, so the knowledge base can be versioned, copied, and inspected as ordinary text. Configuration sits in config/config.js, and environment variables take the highest priority and override those values.

Key capabilities

  • File-based content: every page is a Markdown .md file under CONTENT_DIR, default content/pages.
  • Search over both file names and file contents.
  • In-browser Markdown editor, enabled with ALLOW_EDITING.
  • Login system for edit protection, enabled with AUTHENTICATION and configured through ADMIN_USERNAME and ADMIN_PASSWORD.
  • Environment-variable configuration overriding config/config.js: SESSION_SECRET (minimum 32 characters, generated with openssl rand -base64 32), BASE_URL, SITE_TITLE, LOCALE, GOOGLE_ANALYTICS_ID.
  • Server control through ADDRESS (default 127.0.0.1) and PORT (default 8080), with HOST retained as deprecated.
  • MIT-licensed, with a continuous integration workflow at .github/workflows/nodejs.ci.yml and a FOSSA license report.

Who uses it and how

  • Self-hosted documentation sites, tagged self-hosted and wiki, run as a Node.js process behind whatever address the operator sets in ADDRESS.
  • Public documentation deployments that set BASE_URL to a domain such as https://docs.example.com and SITE_TITLE to the name shown in the browser and header.
  • Teams that want content reviewed as files: the editor, writing, and markdown topics point to authoring workflows where pages are written and edited as Markdown.
  • Installations serving more than one language: LOCALE selects UI translation codes such as en and fr.
  • Projects that want usage measurement without a separate analytics stack, by setting a Google Analytics 4 measurement ID such as G-XXXXXXXXXX in GOOGLE_ANALYTICS_ID.

Getting started

The README documents setup through config/config.js and the environment variables listed above rather than through an install command. Full instructions and a live demo are linked from https://docs.raneto.com/, with the project home page at https://raneto.com.

How it compares

No comparable projects or paid products are named in the facts supplied for this page.

When to use it — and when not to

Pick Raneto when the knowledge base should be a directory of Markdown files and the operator is comfortable running a Node.js process, setting SESSION_SECRET, BASE_URL, and ADDRESS, and — because authentication and editing are opt-in — explicitly enabling AUTHENTICATION and ALLOW_EDITING if the site needs them. Avoid it if a turnkey hosted wiki is required, or if the deployment must expose editing: the defaults bind to 127.0.0.1 on port 8080 with authentication off, so exposure is an explicit decision. Worth noting before committing: the README excerpt covers configuration well but says little about installation, deployment, or upgrades, and the project carries 91 open issues against 2,902 stars and 438 forks.

project readme (upstream, from github) — read inline

Raneto Node.js CI FOSSA Status

Raneto Logo

Raneto is a free, open, simple Markdown-powered knowledge base for Node.js.
Find out more →
Live Demo →
Documentation →

Top Features

  • All content is file-based
  • Search file names and contents
  • Markdown editor in the browser
  • Login system for edit protection
  • Simple and Lightweight

Mailing List

Click here to join the mailing list for project news and important security alerts!

Environment Variables

Environment variables take the highest priority and override values set in config/config.js.

Variable Config Key Type Description
SESSION_SECRET session_secret String Session signing secret. Min 32 chars. Generate: openssl rand -base64 32
ADMIN_USERNAME credentials[0] String Admin username (must be set together with ADMIN_PASSWORD)
ADMIN_PASSWORD credentials[0] String Admin password (must be set together with ADMIN_USERNAME)
CONTENT_DIR content_dir String Path to content directory containing .md files (default: content/pages)
BASE_URL base_url String Base URL of the site (e.g. https://docs.example.com)
SITE_TITLE site_title String Site title shown in the browser and header
GOOGLE_ANALYTICS_ID google_analytics_id String Google Analytics 4 measurement ID (e.g. G-XXXXXXXXXX)
LOCALE locale String Locale code for UI translations (e.g. en, fr)
AUTHENTICATION authentication Boolean Set to true to enable authentication
ALLOW_EDITING allow_editing Boolean Set to true to enable the web editor
ADDRESS (server) String IP address to listen on (default: 127.0.0.1)
PORT (server) Number Port to listen on (default: 8080)
HOST (server) String Deprecated — use ADDRESS instead

License Report

FOSSA Status

Frequently asked questions

Is Raneto free to use?

Raneto is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does Raneto do?

Markdown powered Knowledgebase Wiki for Node.js

What is Raneto written in?

Raneto is primarily written in JavaScript. Its source is publicly available at https://github.com/ryanlelek/Raneto, and it has 2,904 GitHub stars.