3

I am looking for open-source software that I can use to store technical documentation for various projects and which can be hosted on my home server. Preferably it would have a web UI and could be hosted on a single VM with no external dependencies.

I use GitLab for development projects and the README.md is enough for project docs, but there is some documentation that doesn't belong in GitLab (for example instructions on how to set up GitLab).

Does anyone know of something that would fit these needs?

2

This may be an obvious answer you've already discounted, but the solution that is at once the easiest and the most potentially customizable is hosting your own Wiki. This provides you with a simple edit/publish web UI like the GitHub document functions, and if your goal is to host or even allow collaborative editing of more self-contained formats (e.g. PDF), there are Wiki tool varieties with many different capabilities than the MediaWiki engine that runs Wikipedia.

If running on a VM, some stable/easy form of linux like Debian or even Ubuntu would allow installation of all the web hosting and database dependencies (e.g. Apache web server, LAMP stack), for which there are many guides.

Wikimatrix is a database of something like 140 wiki installations and tools, with smart comparisons based on features you need or your hosting platform. Might be too much information if you're looking for something simple, but very useful if you have something very particular in mind.

MediaWiki - familiar and powerful, fairly easy to install.

DocuWiki - Minimalist, based on text files so runs without database, simple in function and setup yet very capable. Allows the publishing of a series of documents very easily. Honestly, if you're basically looking for something to mimic the GitHub project readme or maybe the list of wiki help pages, this might be exactly what you want.

TiddlyWiki - very minimalist and lightweight, more for simple note-taking and editing (missing the more advanced Wiki features of DocuWiki).

TracWiki - software versioning and issue tracking features on top of wiki features.

Redmine - Software/issues with project management tools like gnatt charts, calendars, forums.

XWiki - A "second generation" wiki that, in addition to the basics of document editing and versioning/history, features inbuilt file management for publishing and potentially collaborative editing of PDF, office docs, and even movies. Also features collaborative tools like blogs, forums, and task organization and assignment. Steeper learning curve for setup, but very impressive as a single-software solution for hosting/editing many different types of documents.

| improve this answer | |
  • Cheers, I'll check them out, went for BootStack in the end which is working out well so far – dippynark May 30 '17 at 20:48
  • Ah, well BS seems to be a commercially managed web app/cloud service, so seems a radical departure from the idea of hosting it on your own VM. If that kind of platform appeals to you, self-hosted versions of repute are OwnCloud, Seafile and Tonido. Probably overkill if you're looking for something to replace a readme feature, as these can be used to share terabytes of data from the personal level up to enterprise-class IT usage. Bootstack can be "transferred" to your own OpenStack install later, but the three I mentioned are all free with commercial options for business. – chronometric May 30 '17 at 20:56
  • And zend.to is probably the simplest form of that managed cloud data idea, it's basically a Dropbox that you host on your own machine. More for sharing files internally than publishing them per se, but so are private clouds. Incidentally, if you're looking at commercial options, it's probably easy to find a cheap web server that comes with some of the Wiki tools mentioned above already setup for you. – chronometric May 30 '17 at 21:01
  • ah sorry I meant bookstack not bootstack aha – dippynark May 31 '17 at 8:40

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.