weseek__growi/README.md

Demo Site

crowi-plus

crowi-plus is a fork of Crowi which is perfectly compatible with the official project.

Why crowi-plus?

• Pluggable
  • You can find plugins from npm or github!
• Fast
  • Optimize client-side code chunks by Webpack
  • Optimize the performance when live preview
  • Adopt faster libs(date-fns, pino)
  • Using CDN
• Secure
  • Prevent XSS (Cross Site Scripting)
  • Upgrade jQuery to 3.x and other insecure libs
  • The official Crowi status is
• Convenient
  • Support Authentication with LDAP / Active Directory
  • Slack Incoming Webhooks Integration
  • Miscellaneous features
• Docker Ready
• Docker Compose Ready
  • Multiple sites example
  • HTTPS(with Let's Encrypt) proxy integration example
• Support IE11 (Experimental)
• Developer-friendly
  • Less compile time
  • LiveReload separately available by server/client code change
  • Exclude Environment-dependency (confirmed to be developable on Win/Mac/Linux)

Check out all additional features from here.

Quick Start for Production

Using Heroku

1. Go to https://heroku.com/deploy
2. (Optional) Input INSTALL_PLUGINS to install plugins

Using docker-compose

git clone https://github.com/weseek/crowi-plus-docker-compose.git crowi-plus
cd crowi-plus
docker-compose up

See also weseek/crowi-plus-docker-compose

On-premise

Migration Guide from Official Crowi is here.

Dependencies

• node 6.x (DON'T USE 7.x)
• npm 4.x (DON'T USE 5.x)
• yarn
• MongoDB 3.x

See confirmed versions.

Optional Dependencies

• Redis 3.x
• ElasticSearch 5.x (needed when using Full-text search)
  • CAUTION: Following plugins are required
    • Japanese (kuromoji) Analysis plugin
    • ICU Analysis Plugin

How to start

Build and run the app

git clone https://github.com/weseek/crowi-plus.git
cd crowi-plus
yarn
MONGO_URI=mongodb://MONGO_HOST:MONGO_PORT/crowi npm start

DO NOT USE npm install, use yarn instead.

If you launch crowi-plus with Redis and ElasticSearch, add environment variables before npm start like following:

export MONGO_URI=mongodb://MONGO_HOST:MONGO_PORT/crowi
export REDIS_URL=redis://REDIS_HOST:REDIS_PORT/crowi
export ELASTICSEARCH_URI=http://ELASTICSEARCH_HOST:ELASTICSEARCH_PORT/crowi
npm start

For more info, see Developers Guide and the official documents.

Command details

|command|desc| |--|--| |npm run build:prod|Build the client| |npm run server:prod|Launch the server| |npm start|Invoke npm run build:prod and npm run server:prod|

How to upgrade

git pull
yarn
npm start

How to install plugins

• Stop server if server is running
• yarn add to install plugin or npm install --save
  • Don't forget --save option if you use npm or crowi-plus doesn't detect plugins
• npm start to build client app and start server

Examples

yarn add crowi-plugin-lsx
npm start

For more info, see Developers Guide on Wiki.

Documentation

• github wiki pages
  • Questions and Answers
  • Migration Guide from Official Crowi
  • Developers Guide

Contribution

For development

Build and Run the app

1. clone this repository
2. yarn global add npm@4 to install required global dependencies
3. yarn to install all dependencies
   • DO NOT USE npm install
4. npm run build to build client app
5. npm run server to start the dev server
6. Access http://0.0.0.0:3000

Found a Bug?

If you found a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, firstly please submit the issue with your proposal to make sure we can confirm it. Please clarify what kind of change you would like to propose.

• For a Major Feature, firstly open an issue and outline your proposal so it can be discussed. It also allows us to coordinate better, prevent duplication of work and help you to create the change so it can be successfully accepted into the project.
• Small Features can be created and directly submitted as a Pull Request.

Language

You can write issues and PRs in English or Japanese.

Discussion

If you have questions or suggestions, you can join our Slack team and talk about anything, anytime.

License

• The MIT License (MIT)
• See LICENSE file.