Halaman utama Jelajahi Bantuan
Masuk
wiki
/
weseek__growi
cermin dari https://github.com/weseek/growi
2
0
Fork 0
Berkas Masalah 0 Wiki

Tidak Ada Deskripsi

Pohon: b47fe6715f
Ranting Tag
weseek__growi
ZIP TAR.GZ
Yuki Takei b47fe6715f rename PreventMarkdownListInterceptor 7 tahun lalu
.github 7770c76f37 WIP: replace 'crowi' to 'growi' 8 tahun lalu
.vscode 26958a1a0c add .vscode/settings.json 7 tahun lalu
bin 3d22a381c4 fix lint errors 8 tahun lalu
config f9ab6d4b74 clean code 8 tahun lalu
lib ac2e174d16 Improvement: Detach code blocks correctly 7 tahun lalu
local_modules 3d179149c8 fix lint errors 8 tahun lalu
public 5311a6a457 add icons for Keymap Mode 8 tahun lalu
resource b47fe6715f rename PreventMarkdownListInterceptor 7 tahun lalu
test ace9d87159 fix #415 7 tahun lalu
tmp b875cefd69 add tmp/plugins dir 9 tahun lalu
.babelrc 48dbe895b2 Get rid of babel-preset-es2015 8 tahun lalu
.editorconfig 2d42c72e58 add .editorconfig 9 tahun lalu
.eslintignore d00f8ac763 fix lint errors 8 tahun lalu
.eslintrc.js 1d78038f21 fix lint errors 8 tahun lalu
.gitignore 26958a1a0c add .vscode/settings.json 7 tahun lalu
.node-dev.json dc3af550d5 use node-dev and easy-livereload 9 tahun lalu
CHANGES.md 478709bfc8 update docs 7 tahun lalu
LICENSE 282f6c3101 Update LICENSE 8 tahun lalu
Procfile dbc71db496 fix Procfile 8 tahun lalu
README.md 23d684d28b Update README.md 8 tahun lalu
THIRD-PARTY-NOTICES.md 9a326e38d6 replace "crowi-plus" with "GROWI" 8 tahun lalu
app.js b2296f2b04 fix error handling 8 tahun lalu
app.json 148d74380f add growi-plugin-pukiwiki-like-linker for to INSTALL_PLUGINS list for Heroku 8 tahun lalu
package.json 6348168c57 upgrade libs 7 tahun lalu
wercker.yml a12156df71 set MONGO_URL when build-prod step runs 8 tahun lalu
yarn.lock 6348168c57 upgrade libs 7 tahun lalu

README.md

Demo Site

GROWI

wercker status dependencies status devDependencies Status docker pulls

Features

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/growi-docker-compose.git growi
cd growi
docker-compose up

See also weseek/growi-docker-compose

On-premise

Migration Guide from Crowi is here.

Dependencies

  • node 8.x (DON'T USE 9.x)
  • npm 5.x
  • yarn
  • MongoDB 3.x

See confirmed versions.

Optional Dependencies

How to start

Build and run the app

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

DO NOT USE npm install, use yarn instead.

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

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

For more info, see Developers Guide and Crowi 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
  • npm start to build client app and start server

Examples

yarn add growi-plugin-lsx
npm start

For more info, see Developers Guide on Wiki.

Environment Variables

  • Required
    • MONGO_URI: URI to connect to MongoDB.
  • Option
    • NODE_ENV: production OR development.
    • PORT: Server port. default: 3000
    • REDIS_URL: URI to connect to Redis (to session store).
    • SESSION_NAME: The name of the session ID cookie to set in the response by Express. default: connect.sid
    • ELASTICSEARCH_URI: URI to connect to Elasticearch.
    • PASSWORD_SEED: A password seed used by password hash generator.
    • SECRET_TOKEN: A secret key for verifying the integrity of signed cookies.
    • FILE_UPLOAD: aws (default), local, none

Documentation

Contribution

For development

Build and Run the app

  1. clone this repository
  2. yarn to install all dependencies
    • DO NOT USE npm install
  3. npm run build to build client app
  4. npm run server to start the dev server
  5. 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.