selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitHub
PineDocs logo

Self-host PineDocs

1.2.5

Lightweight file viewer for documentation and wikis

ReleaseOpen SourceGPL-3.0
Updated3 years ago
LanguagePHP
Setup difficultyEasy
MobileResponsive
ThemeDark mode
Stars
142
Port
80 (HTTP web server)
Docker
xy2z/pinedocs
Install with Docker

What is PineDocs?

PineDocs is a fast, lightweight, self-hosted site for viewing files from a directory. It renders Markdown, plaintext, HTML, and code with syntax highlighting for many languages, plus images, vector graphics, animated images, mathematical notation, PDFs, audio, and short video clips — essentially anything a browser can display. No database is required; files are cached in the browser after first view for instant loads. It supports responsive layouts with several color schemes including a dark variant, quick filtering, hidden folders accessible via direct links, and remembers scroll position per page. The project is read-only — content is edited on the server or via git, not through a web UI. It can be deployed via Docker Compose (recommended), plain Docker, or manually on any PHP 8.0+ web server with Composer. Configuration is done through a YAML file controlling title, content directory, layout, color scheme, code highlighting theme, file exclusions, and more. The latest release is 1.2.5 from May 2022; the repository was last pushed in March 2023.

Should you self-host PineDocs?

PineDocs scores 43/100 on selfhost.directory (how scoring works) and ranks #2 of 2 in Documentation Management. It has 142 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is easy: most people get it running in one sitting. An official Docker image is available. It is GPL-3.0-licensed and written mostly in PHP.

Its closest alternative on selfhost.directory is CodeX.docs (55/100, 846 stars). It scores higher overall, so compare the two before you pick. See PineDocs vs CodeX.docs side by side.

Features

  • Client-Side Caching
  • Configurable via YAML
  • Custom CSS/JS
  • File exclusion with regex
  • File viewing
  • Git repository support
  • Hidden folders
  • MathJax support
  • Multiple color schemes
  • Multiple layouts
  • No Database Required
  • Quick filtering
  • Scroll position memory
  • Syntax highlighting

PineDocs README

How to install PineDocs

Install PineDocs with Docker

docker run -itd -v "$PWD"/data:/data/pinedocs -p 3000:80 xy2z/pinedocs

Alternative to Docker Compose.

PineDocs releases & version history

More in Documentation Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…