Self-host a wiki for your startup (why, instructions and Docker-compose)
source link: http://chsasank.github.io/outline-self-hosted-wiki.html
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
How is your startup sharing knowledge with the rest of your team? We’ve been using slack’s #general
or #random
channels to make announcements. We regularly post documents and PPTs slack channels so that they can be used by other people. We have a channel called #setup
to post all IT related information like how to login to VPN etc.
But after a few weeks, these docs/notes become super hard to find. As good slack’s search is, you have to precisely know what you’re looking for. What we needed was a centralized knowledge base website - something like Confluence
But Confluence is clunky and slow, and not cheap ($5/user). We experimented with TiddlyWiki . It calls itself ‘a non-linear personal web notebook’. It’s an opensource software which you can host on your servers or AWS. But its non linear organization makes it super unintuitive and confusing.
Why Outline?
Then, I found outline ! Outline is similar to TiddlyWiki in that it’s opensource and free to self-host. Its UI is a great balance between simplicity of plain text notes and feature creep of Confluence. Login to outline is through your slack - so one less password to remember (or save). You can create private notebooks for a team or just for yourself. You can create a public link of a note so that you can share it with people outside your team - say via email.
Outline has great UI
Best part of all of this is that data doesn’t leave your servers if you self-host it! We already have a server lying around on AWS to host our own python package server, pypi . Since neither hosting pypi nor hosting outline are particularly intensive, we’ve hosted outline on this machine as wiki.qure.ai
.
Install Outline
Unfortunately, documentation for self-hosting outline is limited. There’s no robust docker-compose avaialable that you can use to directly create your server. In the rest of this post, I’ll show you how to host in your laptop or server. Before starting, make sure to install docker and docker-compose .
git clone https://github.com/chsasank/outline-wiki-docker-compose.git cd outline-wiki-docker-compose make install
make install
Follow the instructions. You’ll have to create a slack app. Slack app
If you want to install HTTPS:
make https
Run the server:
make start
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK