Skip to content
A file system/markdown based knowledge base editor/viewer
Branch: master
Clone or download
Latest commit 8c4bb5e May 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin add changes from v0.3 Nov 24, 2018
config
kb initial commit May 17, 2018
pages
public added better favicons, moved from sass to glamor, moved components Nov 4, 2018
src updated docker_startup to fix git permission error Nov 24, 2018
.dockerignore add changes from v0.3 Nov 24, 2018
.editorconfig initial commit May 17, 2018
.eslintignore add changes from v0.3 Nov 24, 2018
.eslintrc.js add changes from v0.3 Nov 24, 2018
.gitignore add changes from v0.3 Nov 24, 2018
.prettierrc added prettier, removed seperate react eslint config, fixed missing Jun 1, 2018
Dockerfile add changes from v0.3 Nov 24, 2018
LICENSE initial commit May 17, 2018
README.md add changes from v0.3 Nov 24, 2018
docker_startup.sh updated docker_startup to fix git permission error Nov 24, 2018
next.config.js added better favicons, moved from sass to glamor, moved components Nov 4, 2018
package.json Update Next.js Jun 7, 2019
yarn.lock Update Next.js Jun 7, 2019

README.md

MYKB

A file system/markdown based knowledge base editor/viewer

Demo

You can try the demo at: https://mykb.jjsweb.site

- Login
email: admin
password: secretpass

P.S. the demo is reset every 10 minutes

About

MYKB is a file system/markdown based knowledge base editor/viewer built with Next.js

Current features:

  • live preview when editing a doc
  • live file system watching
  • caching of docs to speed up searching/viewing of docs
  • offline viewing of cached docs (requires browser that supports service workers)
  • automatic git versioning
  • automatic trusting of Cloudflare reverse proxies

Installing

  • With Docker

    docker run --name mykb -v /path/to/docs:/kb -v /path/to/config:/config --env "PUID=USER_ID" --env "PGID=GROUP_ID" -p 3000:3000 ijjk/mykb:latest
    
  • With yarn (or npm)

    1. Clone repo
      git clone https://github.com/ijjk/mykb
      
    2. Install dependencies
      cd path/to/mykb; yarn
      
    3. Build it
      yarn build && NODE_ENV=production node ./bin/genSecret.js
      
    4. Start it
      yarn start
      

Options

production.json (overrides default.json with production NODE_ENV var)

Name Description
useGit Whether or not to use a git repo to automatically version changes to docs (requires git to be installed)
docsDir The directory where the markdown docs are located
cacheSize Max size of docs to store in memory for faster searching (default 10MB)
trustCloudflare Whether to trust X-Forwarded-For header from Cloudflare IPs (used for rate limiting)

trustIPs.json - An array of proxy-addr compatible addresses to trust the X-Forwarded-For header from (Only needed if behind reverse proxy)

License

Copyright (c) 2017

Licensed under the MIT license.

You can’t perform that action at this time.