|
|
@@ -1,3 +1,5 @@
|
|
|
+- [日本語 🇯🇵](./README_JP.md)
|
|
|
+
|
|
|
<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">
|
|
|
@@ -12,52 +14,46 @@
|
|
|
<a href="https://docs.growi.org">Documentation</a> / <a href="https://demo.growi.org">Demo</a>
|
|
|
</p>
|
|
|
|
|
|
-
|
|
|
-GROWI
|
|
|
-===========
|
|
|
+# 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 |
|
|
|
-| :-: |
|
|
|
-||
|
|
|
+| demonstration |
|
|
|
+| :-------------------------------------------------------------------------------------------------------------------: |
|
|
|
+|  |
|
|
|
|
|
|
-Table Of Contents
|
|
|
----------------
|
|
|
+## Table Of Contents
|
|
|
|
|
|
- [Features](#features)
|
|
|
- [Quick Start for Production](#quick-start-for-production)
|
|
|
- - [docker-compose](#docker-compose)
|
|
|
- - [Helm (Experimental)](#helm-experimental)
|
|
|
- - [On-premise](#on-premise)
|
|
|
+ - [docker-compose](#docker-compose)
|
|
|
+ - [Helm (Experimental)](#helm-experimental)
|
|
|
+ - [On-premise](#on-premise)
|
|
|
- [Environment Variables](#environment-variables)
|
|
|
- [Documentation](#documentation)
|
|
|
- [License](#license)
|
|
|
|
|
|
-Features
|
|
|
-========
|
|
|
-
|
|
|
-* **Features**
|
|
|
- * Create hierarchical pages with markdown -> [HERE](https://docs.growi.org/en/guide/getting-started/five_minutes.html) is 5 minutes tutorial
|
|
|
- * Simultaneously edit with multiple people by [HackMD(CodiMD)](https://hackmd.io/) integration
|
|
|
- * [GROWI Docs: HackMD(CodiMD) Integration](https://docs.growi.org/en/admin-guide/admin-cookbook/integrate-with-hackmd.html)
|
|
|
- * Support Authentication with LDAP / Active Directory, OAuth
|
|
|
- * SSO(Single Sign On) with SAML
|
|
|
- * Slack/Mattermost, IFTTT Integration
|
|
|
- * [GROWI Docs: Features](https://docs.growi.org/en/guide/features/page_layout.html)
|
|
|
-* **Pluggable**
|
|
|
- * You can find plugins from [npm](https://www.npmjs.com/browse/keyword/growi-plugin) or [github](https://github.com/search?q=topic%3Agrowi-plugin)!
|
|
|
-* **[Docker Ready][dockerhub]**
|
|
|
-* **[Docker Compose Ready][docker-compose]**
|
|
|
- * [GROWI Docs: Multiple sites](https://docs.growi.org/en/admin-guide/admin-cookbook/multi-app.html)
|
|
|
- * [GROWI Docs: HTTPS(with Let's Encrypt) proxy integration](https://docs.growi.org/en/admin-guide/admin-cookbook/lets-encrypt.html)
|
|
|
-
|
|
|
-Quick Start for Production
|
|
|
-===========================
|
|
|
-
|
|
|
+# Features
|
|
|
+
|
|
|
+- **Features**
|
|
|
+ - Create hierarchical pages with markdown -> [HERE](https://docs.growi.org/en/guide/getting-started/five_minutes.html) is 5 minutes tutorial
|
|
|
+ - Simultaneously edit with multiple people by [HackMD(CodiMD)](https://hackmd.io/) integration
|
|
|
+ - [GROWI Docs: HackMD(CodiMD) Integration](https://docs.growi.org/en/admin-guide/admin-cookbook/integrate-with-hackmd.html)
|
|
|
+ - Support Authentication with LDAP / Active Directory, OAuth
|
|
|
+ - SSO(Single Sign On) with SAML
|
|
|
+ - Slack/Mattermost, IFTTT Integration
|
|
|
+ - [GROWI Docs: Features](https://docs.growi.org/en/guide/features/page_layout.html)
|
|
|
+- **Pluggable**
|
|
|
+ - You can find plugins from [npm](https://www.npmjs.com/browse/keyword/growi-plugin) or [github](https://github.com/search?q=topic%3Agrowi-plugin)!
|
|
|
+- **[Docker Ready][dockerhub]**
|
|
|
+- **[Docker Compose Ready][docker-compose]**
|
|
|
+ - [GROWI Docs: Multiple sites](https://docs.growi.org/en/admin-guide/admin-cookbook/multi-app.html)
|
|
|
+ - [GROWI Docs: HTTPS(with Let's Encrypt) proxy integration](https://docs.growi.org/en/admin-guide/admin-cookbook/lets-encrypt.html)
|
|
|
+
|
|
|
+# Quick Start for Production
|
|
|
|
|
|
### docker-compose
|
|
|
|
|
|
@@ -74,9 +70,7 @@ Quick Start for Production
|
|
|
- [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
|
|
|
-------------
|
|
|
+## 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/)).
|
|
|
|
|
|
@@ -84,9 +78,7 @@ See [GROWI Docs: Admin Guide](https://docs.growi.org/en/admin-guide/) ([en](http
|
|
|
|
|
|
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
|
|
|
-==========
|
|
|
+# Development
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
@@ -95,72 +87,64 @@ Development
|
|
|
- yarn
|
|
|
- MongoDB 4.x
|
|
|
|
|
|
+<!-- The following links do not exist -->
|
|
|
+
|
|
|
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)
|
|
|
+ - **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`|
|
|
|
+| 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).
|
|
|
+<!-- The following links do not exist -->
|
|
|
|
|
|
+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
|
|
|
-==============
|
|
|
+# Documentation
|
|
|
|
|
|
- [GROWI Docs](https://docs.growi.org/)
|
|
|
- [GROWI Developers Wiki (ja)](https://dev.growi.org/)
|
|
|
|
|
|
+# Contribution
|
|
|
|
|
|
-Contribution
|
|
|
-============
|
|
|
-
|
|
|
-Found a Bug?
|
|
|
--------------
|
|
|
+## 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?
|
|
|
--------------------
|
|
|
+## 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.
|
|
|
+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].
|
|
|
+- 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
|
|
|
-------------------
|
|
|
+## Language on GitHub
|
|
|
|
|
|
You can write issues and PRs in English or Japanese.
|
|
|
|
|
|
-Discussion
|
|
|
------------
|
|
|
+## 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
|
|
|
|
|
|
-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).
|
|
|
-
|
|
|
+- 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
|
Yuki Takei