Boris Mann

Open Source. Community. Decentralized Web. Building dev tools at Fission. Cooks & eats.

Home

Wiki

  • Last Edit: September 28, 2020

Various thoughts on wiki software

WikiJS

Used to run this site – see WikiJSWikiJS
WikiWiki
Various thoughts on wiki software
WikiJS
Used to run this site – see WikiJSWikiJS
[[Wiki]] software built on [[NodeJS]]. Has great [[DeployToHeroku]] support

Home page https://wiki.js.org/
OpenCollective Donations https://opencollective.com/wikijs
Github https://github.com/Requarks/wiki
Deploy via Heroku https://github.com/Requarks/wiki-heroku

An open source, modern and powerful wiki app built on Node.js, Git and Markdown. Can be maintained through a git repo (public or private, Github, Gitlab, etc) with standard git commits, as well as allowing edits through the front e...
.
Outline

https://www.getoutline.com/
https://github.com/outline/outline
https://twitter.com/outlinewiki

Licensed as Business Source License – which I had not heard of. Documenting under LicensingLicensing
Licensing, and “open source” licensing in particular, is something I’ve spent a lot of time on.
Presentations
Licenses
[[Kyle Mitchell]] https://writing.kemitchell.com/
[[Parity]], [[Prosperity]], and [[License Zero]] are all Kyle Mitchell projects, who I am a big fan of.
Parity
https://paritylicense.com/
Non-commercial license, where the software may be used for any purpose except for-profit.
Prosperity
https://prosperitylicense.com/
Open, share-alike license aka copyleft, where software may...

My fork: https://github.com/bmann/outline, setup to easily deploy to Heroku (not updated to recent head, yet). The app.json did get merged, so you should use the main version.
The other issue I had, with having mult...
software built on [[NodeJS]]. Has great DeployToHerokuDeployToHeroku
HerokuHeroku
Heroku CLI https://devcenter.heroku.com/articles/heroku-cli
Heroku Teams https://devcenter.heroku.com/articles/heroku-teams – it used to be awkward to “share” deployments, or have a fake company user that owned it; teams are free for up to 5 members, then $10 per month for more. Also no free dynos for teams.
I have been using Heroku for many many years. Heroku was [[serverless]] (and containers) before either term existed. I have helped get a variety of open source software running on Heroku ...
has a “Deploy to Heroku” button that lets people deploy apps using just a browser and the Heroku dashboard.
Creating a ‘Deploy to Heroku’ Button
The two base requirements are that the source code is on Github and that it contains an app.json file.

app.json schema is

support

Home page https://wiki.js.org/
OpenCollective Donations https://opencollective.com/wikijs
Github https://github.com/Requarks/wiki
Deploy via Heroku https://github.com/Requarks/wiki-heroku

An open source, modern and powerful wiki app built on Node.js, Git and Markdown. Can be maintained through a git repo (public or private, Github, Gitlab, etc) with standard git commits, as well as allowing edits through the front e...
.

Outline

Licensed as Business Source License – which I had not heard of. Documenting under LicensingLicensing
Licensing, and “open source” licensing in particular, is something I’ve spent a lot of time on.
Presentations
Licenses
[[Kyle Mitchell]] https://writing.kemitchell.com/
[[Parity]], [[Prosperity]], and [[License Zero]] are all Kyle Mitchell projects, who I am a big fan of.
Parity
https://paritylicense.com/
Non-commercial license, where the software may be used for any purpose except for-profit.
Prosperity
https://prosperitylicense.com/
Open, share-alike license aka copyleft, where software may...

My fork: https://github.com/bmann/outline, setup to easily deploy to Heroku (not updated to recent head, yet). The app.json did get merged, so you should use the main version.

The other issue I had, with having multiple Google accounts logging in to one team, got solved with a small edit by someone else.

Resources

I’d like to have a wiki that is private except for a group of (50-100) people I whitelist. Preferably free, or worst case, fixed fee that doesn’t scale with users.

Howwww do I do this!? New pricing for GitHub and Notion don’t help here, unless I’m missing something. – Lee Edwards (@terronk), May 19th, 2020

My response:

I’m just in the midst of setting up @requarks for personal use. It syncs to a git repo, runs on Heroku for about $16/month ($7 paid dyno & $9 paid postgres DB)

Even GitHub Free now appears to allow unlimited collaborators on a private repo.


Wikis that use source-control for their backing store, Paul Hammant, Sept 2017

https://paulhammant.com/2017/09/23/wikis-that-use-source-control-for-their-backing-store/

Quoted from the article:


Maintained wiki implementations

  • Gollum - Git backing store, Docker ready, maintained but has not had a lot of commits recently
  • SahrisWiki - Mercurial backing store, Docker ready, maintained but has not had a lot of commits recently
  • Zim Wiki - Bazaar, Git, Mercurial, or Fossil backing stores - personal desktop (fat client) rather than group web-app. v cool.
  • Fossil’s Wiki - Fossil is a VCS itelf and has a built-in wiki.
  • Realms - Git backing store. Python2. Actively maintained.
  • DokuWiki - Git backing store. PHP. Actively maintained.
  • Jingo - Git backing store. PHP. Actively maintained.

Has this to say about WikiJS:

Can be linked to a Git repo and do round trip, but the database is the main DB, with sync to/from Git being done at intervals via single committer ID. That said, it is “Docker ready” using NodeJS and is actively maintained.

Which is not quite true. The DB is essentially a cache. The single committer is true.

My notes: