crowi / Crowi
Licence: mit
Crowi - The Markdown Wiki - Empower the team with sharing your knowledge
Stars: ✭ 1,031
Programming Languages
javascript
184084 projects - #8 most used programming language
typescript
32286 projects
Projects that are alternatives of or similar to Crowi
Community
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS
Stars: ✭ 1,286 (+24.73%)
Mutual labels: wiki, knowledge
Tiddlyresearch
Local and Anki-compatible note-taking tool based on TiddlyWiki
Stars: ✭ 129 (-87.49%)
Mutual labels: wiki, knowledge
knowledge
Everything I know. My knowledge wiki. My notes (mostly for fast.ai). Document everything. Brain dump.
Stars: ✭ 118 (-88.55%)
Mutual labels: knowledge, wiki
til
Personal Wiki of Interesting things I learn every day at the intersection of software, life & stuff aka my second brain 🧠️
Stars: ✭ 41 (-96.02%)
Mutual labels: knowledge, wiki
Alfred My Mind
Alfred workflow to search through my notes and bookmarks
Stars: ✭ 321 (-68.87%)
Mutual labels: wiki, knowledge
Personalwiki
📓 A simple personal wiki of my current knowledge
Stars: ✭ 303 (-70.61%)
Mutual labels: wiki, knowledge
Xplain
🌎 Complex Topics Explained For Your Level And Background. ✏️
Stars: ✭ 44 (-95.73%)
Mutual labels: wiki, knowledge
Growi
⚓️ GROWI - Team collaboration software using markdown
Stars: ✭ 859 (-16.68%)
Mutual labels: wiki
Decko
Start with a deck of wiki cards. Develop it into a rich web app.
Stars: ✭ 37 (-96.41%)
Mutual labels: wiki
Trackdown
TrackDown - Issue Tracking with plain Markdown. If you are missing the "git clone" for your tickets from github.com or bitbucket.org, then this is for you. A lightweight Ticketing System for distributed and unconnected small Teams.
Stars: ✭ 10 (-99.03%)
Mutual labels: wiki
Ugics 2018 Android Basics Wiki
Wiki for Udacity Google India Challenge Scholarship 2018 🎓 Android Basics Course 📒
Stars: ✭ 29 (-97.19%)
Mutual labels: wiki
Wiki
An open-source, community powered wiki, run by Discord enthusiasts.
Stars: ✭ 40 (-96.12%)
Mutual labels: wiki
Tft Overlay Outdated
TFT Overlay - Team and item builder for League of Legends Teamfight Tactics
Stars: ✭ 44 (-95.73%)
Mutual labels: wiki
Describing a knowledge base
Code for Describing a Knowledge Base
Stars: ✭ 42 (-95.93%)
Mutual labels: wiki
Crowi
Empower the team with sharing your knowledge.
Crowi is a Markdown Wiki like:
- Easy to edit and share,
- Markdown supported,
- Useful timeline list view,
- Fast.
Install
Install dependencies and build CSS and JavaScript:
$ npm install
More info is here.
⚠️WARNING⚠️
Don't use master
branch because it is unstable. Use released version except when you want to contribute to the project.
Dependencies
- Node.js 12.x
- MongoDB 4.2.x
- Elasticsearch 6.x.x or 7.x.x (optional) (Doc is here)
- Redis (optional)
- Amazon S3 (optional)
- Google Project (optional)
- Slack App (optional)
Start Up on Local
Crowi is designed to be set up on Heroku or some PaaS, but you can also start up Crowi with ENV parameter on your local.
$ PASSWORD_SEED=somesecretstring MONGO_URI=mongodb://username:[email protected]/crowi node app.js
or please write .env
.
Environment
-
PORT
: Server port. default:3000
. -
BASE_URL
: Server base URL (e.g. https://demo.crowi.wiki/). If this env is not set, it is detected by accessing URL. -
NODE_ENV
:production
ORdevelopment
. -
MONGO_URI
: URI to connect to MongoDB. This parameter is also byMONGOHQ_URL
ORMONGOLAB_URI
. -
REDIS_URL
: URI to connect to Redis (used for session store and socket.io). This parameter is also byREDISTOGO_URL
. -
ELASTICSEARCH_URI
: URI to connect to Elasticearch. -
PASSWORD_SEED
: A password seed used by password hash generator. -
SECRET_TOKEN
: A secret key for verifying the integrity of signed cookies. -
FILE_UPLOAD
:aws
(default),local
,none
Optional:
-
MATHJAX
: If set1
, enable MathJax feature. -
PLANTUML_URI
: If set the url of PlantUML server, then enable PlantUML feature. e.g.http://localhost:18080
. -
ENABLE_DNSCACHE
: If settrue
, Use internal DNS cache for crowi in Linux VMs. (See also: #407)
see: .env.sample
For develop
We can use docker-compose for develop without complicated settings.
$ docker-compose -f docker-compose.development.yml up
- Express restarts when a file changed
- Webpack compiled assets automatically
Troubleshooting
Please try the following commands.
# Stop containers
$ docker-compose -f docker-compose.development.yml stop
# Remove containers
$ docker-compose -f docker-compose.development.yml rm
# Remove images
$ docker-compose -f docker-compose.development.yml images -q | xargs docker rmi -f
# Build images
$ docker-compose -f docker-compose.development.yml build
License
- The MIT License (MIT)
- See LICENSE file.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].