Awesome
<p align="center"> <a href="https://growi.org"> <img src="https://user-images.githubusercontent.com/1638767/38254268-d4476bbe-3793-11e8-964c-8865d690baff.png" width="240px"> </a> </p> <p align="center"> <a href="https://github.com/weseek/growi/releases/latest"><img src="https://img.shields.io/github/release/weseek/growi.svg"></a> <a href="https://communityinviter.com/apps/wsgrowi/invite/">join our Slack team</a> </p> <p align="center"> <a href="https://docs.growi.org">Documentation</a> / <a href="https://demo.growi.org">Demo</a> </p>GROWI
| demonstration |
|---|
 |
Table Of Contents
Features
- Features
- Create hierarchical pages with markdown -> Try GROWI on the demo site
- Simultaneously edit with multiple people
- Support Authentication with LDAP / Active Directory, OAuth
- SSO(Single Sign On) with SAML
- Slack/Mattermost, IFTTT Integration
- GROWI Docs: Features
- Pluggable
- Docker Ready
- Docker Compose Ready
Quick Start for Production
docker-compose
Helm (Experimental)
On-premise
Migration Guide from Crowi (en/ja) is here.
Configuration
See GROWI Docs: Admin Guide (en/ja).
Environment Variables
See GROWI Docs: Environment Variables (en/ja).
Development
Dependencies
- Node.js v18.x or v20.x
- npm 6.x
- pnpm 9.x
- Turborepo
- MongoDB 6.0 or above
Optional Dependencies
- Redis 3.x
- ElasticSearch 7.x or 8.x (needed when using Full-text search)
- CAUTION: Following plugins are required
Command details
| command | desc |
|---|---|
npm run app:build | Build GROWI app client |
npm run app:server | Launch GROWI app server |
npm run start | Invoke npm run app:build and npm run app:server |
For more info, see GROWI Docs: List of npm Scripts.
Documentation
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.