• 日本語 🇯🇵

Documentation / Demo

GROWI

demonstration

Table Of Contents

• Features
• Quick Start for Production
  • docker-compose
  • Helm (Experimental)
  • On-premise
• Environment Variables
• Documentation
• License

Features

• Features
  • Create hierarchical pages with markdown -> HERE is 5 minutes tutorial
  • Simultaneously edit with multiple people by HackMD(CodiMD) integration
    • GROWI Docs: HackMD(CodiMD) Integration
  • Support Authentication with LDAP / Active Directory, OAuth
  • SSO(Single Sign On) with SAML
  • Slack/Mattermost, IFTTT Integration
  • GROWI Docs: Features
• Pluggable
  • You can find plugins from npm or github!
• Docker Ready
• Docker Compose Ready
  • GROWI Docs: Multiple sites
  • GROWI Docs: HTTPS(with Let's Encrypt) proxy integration

Quick Start for Production

docker-compose

• GROWI Docs: Launch with docker-compose (en/ja)

Helm (Experimental)

• GROWI Helm Chart

On-premise

Migration Guide from Crowi (en/ja) is here.

• GROWI Docs: Install on Ubuntu Server
• GROWI Docs: Install on CentOS

Configuration

See GROWI Docs: Admin Guide (en/ja).

Environment Variables

See GROWI Docs: Environment Variables (en/ja).

Development

Dependencies

• Node.js v16.x or v18.x
• npm 6.x
• yarn
• Turborepo
• MongoDB 4.x

Optional Dependencies

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

Command details

command	desc
yarn app:build	Build GROWI app client
yarn app:server	Launch GROWI app server
yarn start	Invoke yarn app:build and yarn app:server

For more info, see GROWI Docs: List of npm Scripts.

Documentation

• GROWI Docs
• GROWI Developers Wiki (ja)

Contribution

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 on GitHub

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 and THIRD-PARTY-NOTICES.md.