Documentation / Demo
# GROWI
[](https://github.com/weseek/growi/actions)
[](https://david-dm.org/weseek/growi)
[](https://david-dm.org/weseek/growi?type=dev)
[](https://hub.docker.com/r/weseek/growi/)
| demonstration |
| :-------------------------------------------------------------------------------------------------------------------: |
|  |
## 目次
- [機能紹介](#features)
- [さっそくはじめてみる](#quick-start-for-production)
- [docker-compose](#docker-compose)
- [Helm (Experimental)](#helm-experimental)
- [オンプレミス](#on-premise)
- [環境変数](#environment-variables)
- [ドキュメント](#documentation)
- [ライセンス](#license)
# 機能紹介
- **機能紹介**
- マークダウンを使用してページを階層構造で作成できます。 -> 5 分間チュートリアルは[こちら](https://docs.growi.org/en/guide/getting-started/five_minutes.html)
- HackMD(CodiMd)[https://hackmd.io/] を統合することで同時多人数編集ができます。
- - [GROWI Docs: HackMD(CodiMD) 連携](https://docs.growi.org/en/admin-guide/admin-cookbook/integrate-with-hackmd.html)
- LDAP / Active Direcotry , OAuth 認証をサポートしています。
- SAML を用いた Single Sign On が可能です。
- Slack/Mattermost, IFTTT と連携することができます。
- [GROWI Docs: 機能紹介](https://docs.growi.org/en/guide/features/page_layout.html)
- **プラグイン**
- You can find plugins from [npm](https://www.npmjs.com/browse/keyword/growi-plugin) or [github](https://github.com/search?q=topic%3Agrowi-plugin)!
- [npm](https://www.npmjs.com/browse/keyword/growi-plugin) または [github](https://github.com/search?q=topic%3Agrowi-plugin)! から 便利なプラグインを見つけることができます。
- **[Docker の準備][dockerhub]**
- **[Docker Compose の準備][docker-compose]**
- [GROWI Docs: 複数の GROWI を起動](https://docs.growi.org/en/admin-guide/admin-cookbook/multi-app.html)
- [GROWI Docs: Let's Encrypt による HTTPS 運用](https://docs.growi.org/en/admin-guide/admin-cookbook/lets-encrypt.html)
# Quick Start for Production
### docker-compose
- [GROWI Docs: Launch with docker-compose](https://docs.growi.org/en/admin-guide/getting-started/docker-compose.html) ([en](https://docs.growi.org/en/admin-guide/getting-started/docker-compose.html)/[ja](https://docs.growi.org/ja/admin-guide/getting-started/docker-compose.html))
### Helm (Experimental)
- [GROWI Helm Chart](https://github.com/weseek/helm-charts/tree/master/charts/growi)
### On-premise
**[Migration Guide from Crowi](https://docs.growi.org/en/admin-guide/migration-guide/from-crowi-onpremise.html) ([en](https://docs.growi.org/en/admin-guide/migration-guide/from-crowi-onpremise.html)/[ja](https://docs.growi.org/ja/admin-guide/migration-guide/from-crowi-onpremise.html))** is here.
- [GROWI Docs: Install on Ubuntu Server](https://docs.growi.org/en/admin-guide/getting-started/ubuntu-server.html)
- [GROWI Docs: Install on CentOS](https://docs.growi.org/en/admin-guide/getting-started/centos.html)
## Configuration
See [GROWI Docs: Admin Guide](https://docs.growi.org/en/admin-guide/) ([en](https://docs.growi.org/en/admin-guide/)/[ja](https://docs.growi.org/ja/admin-guide/)).
### Environment Variables
See [GROWI Docs: Environment Variables](https://docs.growi.org/en/admin-guide/admin-cookbook/env-vars.html) ([en](https://docs.growi.org/en/admin-guide/admin-cookbook/env-vars.html)/[ja](https://docs.growi.org/ja/admin-guide/admin-cookbook/env-vars.html)).
# Development
## Dependencies
- Node.js v12.x or v14.x
- npm 6.x
- yarn
- MongoDB 4.x
See [confirmed versions](https://docs.growi.org/en/dev/startup/dev-env.html#set-up-node-js-environment).
### Optional Dependencies
- Redis 3.x
- ElasticSearch 6.x (needed when using Full-text search)
- **CAUTION: Following plugins are required**
- [Japanese (kuromoji) Analysis plugin](https://www.elastic.co/guide/en/elasticsearch/plugins/current/analysis-kuromoji.html)
- [ICU Analysis Plugin](https://www.elastic.co/guide/en/elasticsearch/plugins/current/analysis-icu.html)
## Command details
| command | desc |
| ---------------------- | ------------------------------------------------------- |
| `yarn run build:prod` | Build the client |
| `yarn run server:prod` | Launch the server |
| `yarn start` | Invoke `yarn run build:prod` and `yarn run server:prod` |
For more info, see [GROWI Docs: List of npm Commands](https://docs.growi.org/en/dev/startup-v2/launch.html#list-of-npm-commands).
# Documentation
- [GROWI Docs](https://docs.growi.org/)
- [GROWI Developers Wiki (ja)](https://dev.growi.org/)
# Contribution
## Found a Bug?
If you found a bug in the source code, you can help us by
[submitting an issue][issues] to our [GitHub Repository][growi]. Even better, you can
[submit a Pull Request][pulls] with a fix.
## Missing a Feature?
You can _request_ a new feature by [submitting an issue][issues] 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][pulls].
## 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](https://growi-slackin.weseek.co.jp/) and talk about anything, anytime.
# License
- The MIT License (MIT)
- See [LICENSE](https://github.com/weseek/growi/blob/master/LICENSE) and [THIRD-PARTY-NOTICES.md](https://github.com/weseek/growi/blob/master/THIRD-PARTY-NOTICES.md).
[crowi]: https://github.com/crowi/crowi
[growi]: https://github.com/weseek/growi
[issues]: https://github.com/weseek/growi/issues
[pulls]: https://github.com/weseek/growi/pulls
[dockerhub]: https://hub.docker.com/r/weseek/growi
[docker-compose]: https://github.com/weseek/growi-docker-compose