A simple and beautiful wiki for teams
Expect some things to be broken as we're actively working on a stable v0.3.0 release. Although the master branch is expected to work fine, we'd suggest you to wait until everything is completed.
If you'd like to help, drop in on any of the issues or pull requests, or email one of
You can also get a preview of the next version on the v0.3.0
/refactor
branches
A website or database developed collaboratively by a community of users, allowing any user to add and edit content. Example: Wikipedia
As your company grows it becomes difficult to keep track of all the knowledge in your team. It is difficult to communicate every detail about the company policies to new team members. Things get lost in Slack channels. It becomes difficult to keep things in context.
A wiki helps you keep track of all this information. Every article is filed under a topic to keep things organised among departments. Everything is transparent, who made what changes to which document and when.
Wiki softwares are too complicated for small teams. Matterwiki is just that, a simple wiki for teams to store and collaborate on knowledge. People use it to store documentation, notes, culture guidelines, employee onboarding content and everything else they want to.
You need to have Node
(version 7 or above) and npm
installed on your system.
git clone http://github.com/matterwiki/matterwiki
npm install
config.js
(present in the project root) and change the auth_secret
value with any secret phrase.
NOTE: This phrase will be used to encode and decode your access tokens. Keep it safe and private
npm run build
NODE_ENV=production PORT=8000 pm2 start index.js --name "matterwiki"
Some points to note here :
NODE_ENV
could take one of these two values, dev
or production
.PORT
is optional. If it is not specified, then 5000
would be used.However, if you do not need all this, running npm start
should boot up the production build of the app.
6. Head to yoururl.com/#/setup
and create the Admin account.
Replace yoururl.com with your URL. If you're running locally, replace with localhost:5000
7. Login with your new admin account and head to the Admin dashboard.
8. Create topics and add users to your Wiki.
NOTE - Using MySQL
First setup MySQL
Install mysql from npm
npm install mysql
Change the object from
module.exports = {
client: 'sqlite3',
connection: {
filename: "./db/matterwiki.sqlite"
},
useNullAsDefault: true
}
to
module.exports = {
client: 'mysql',
connection: {
host : '127.0.0.1',
user : 'your_database_user',
password : 'your_database_password',
database : 'myapp_test'
},
useNullAsDefault: true
}
You can run MatterWiki with Docker.
git clone http://github.com/matterwiki/matterwiki
docker build -t matterwiki .
docker run --name=matterwiki -p 5000:5000 matterwiki
You can add -v /<path>/db:/server/db
to store the db on the host filesystem, and -v /<path>/config.js:/server/config.js
to specify your own JWT secret configuration. Add --restart=always -d
options to run it as a daemon.
Matterwiki uses a Node.js API with a React.js front-end and Sqlite3 for the database.
As the app is built atop a JSON API, it is simple to integrate your Wiki with your mobile app or blog. For more, read the API documentation.
:star: this repo
Raise an issue!
We welcome all kinds of contributions. It doesn't matter if it's a grammar fix, or some refactoring, or an even an entire UI overhaul. So help us improve Matterwiki for everyone. Take a look at our contributing document for understanding local development setup and the code base.
Before you create a new feature request please check our public roadmap for the v0.3.0 release. It lists the features we're currently working on. The issues tagged with the backlog
label are next in line.
If you want to explore alternatives here are some other Wikis we love.
We're also referring to them for inspiration as we go along.