W2 wiki is a web-based, wiki-like notepad that you can host yourself.
- Elegant text markup:
- Uses Markdown Syntax.
- It supports double-brackets [[like this]] to link to another page in the wiki by title
- Title & content search
- Filesystem storage (no database required) in plain Markdown text files.
- Image uploading support
- Optionally password-protected
- Unlike cloud / hosted solutions, you retain control of your data
- Written in PHP for portability and hackability
- Extremely compact (only a few .php files and a .css file)
- Differences to original w2wiki by panicsteve:
- Rudimentary, optional git integration to commit (and push) each page edit
- Support for renaming and deleting pages
- Markdown formatting syntax help on edit page
- Localization support (en/de/ja/oc translations included)
- Improved icon-based interface
- Optional, always visible sidebar fed by a special page
- Merged All/Recent list of all pages
- Links:
- Possibility to display pages that link to the current page
- Support for links to sub-captions (using # in links)
- When navigating to a non-existing page, show links to similar pages
- Mark links to non-existing pages (by default in red)
- Mark external links with globe icon
- Image uploads:
- Option to shrink uploaded images (based on maximum side length)
- Fix rotation (based on EXIF data)
- List of uploaded images providing usage information and option to delete
- Upload folder: the name is configurable (
UPLOAD_FOLDER,UPLOAD_URL), but it still has to be a direct subfolder of PAGES_PATH (to capture uploads in the git repository), and the web server has to serve it statically, e.g. via a soft link in the root folder (see INSTALL.md)
See Installation instructions.
Automated tests (PHPUnit, run against a private copy of the wiki) are described in tests/README.md; they run on GitHub Actions for pull requests.
In its current form, W2 wiki is not security-hardened; it's recommended to only run on an additionally secured server (e.g. in a small, private network for one user only; and secured behind a VPN and/or HTTPS with basic authentication).
SVG uploads are disabled by default, since SVG files can contain scripts; they can be enabled with the optional enshrined/svg-sanitize library, see the installation instructions.
W2 is licensed under the MIT license.
Originally written by Steven Frank and others, with modifications by
W2 wiki uses PHP Markdown by Michel Fortin for rendering Markdown to HTML.
The Markdown syntax description is taken from daringfireball.net.
Maintainer of this fork is codeling.
Please report bugs in the github issue tracker of this fork.