naoak / growi-docker-compose

:anchor: growi-docker-compose - The fastest way to boot All-in-One GROWI

growi-docker-compose

Quick start GROWI with docker-compose

Table of Contents

1. Start
2. Upgrade
3. Migrate from crowi-plus-docker-compose
4. How to install plugins
5. NOTE: DISABLED Environment Variables
6. More convenient Examples
7. Documentation

Start

git clone https://github.com/weseek/growi-docker-compose.git growi
cd growi
docker-compose up

and access to http://localhost:3000

How to access from other than localhost

Edit docker-compose.yml and modify ports for app

Before

services:
  app:
    ports:
      - 127.0.0.1:3000:3000

After

services:
  app:
    ports:
      - 3000:3000

For High-memory environment

If you have enough memory, increase heap size for Elasticsearch with ES_JAVA_OPTS value in docker-compose.yml.

environment:
  - "ES_JAVA_OPTS=-Xms2g -Xmx2g"

Upgrade

Check upgrading guide

Please be sure to access Admin's guide - GROWI Docs(en/ja) and see 'Upgrade' section before upgrading. Sometimes you may have to deal with problems that may occur by yourself.

Upgrading to v4.2 or later

To upgrade app to v4.2 or later, you have to upgrade mongoDB to v4.x. Please see this page for the details.

Upgrading app container

# go to growi-docker-compose workdir
cd growi

# stop
docker-compose stop

# remove current container and images
docker-compose rm app
docker rmi weseek/growi:5

# rebuild app container image
git pull
docker-compose build

# start
docker-compose up

Migrate from crowi-plus-docker-compose

If you have used weseek/crowi-plus docker image with docker-compose so far, please see migration document.

NOTE: DISABLED Environment Variables

Followings are unchangable.

• PORT
• NODE_ENV

Followings are disabled because they are overwritten by docker-compose.yml

• MONGO_URI
• PASSWORD_SEED

Change docker-compose.yml if you need.

Others conform to weseek/growi

More convenient Examples

• Multiple sites
• HTTPS(with Let's Encrypt) proxy integration
• HackMD(CodiMD) integration
• Backup MongoDB data

Documentation

• GROWI Docs

Issues

If you have any problems or questions about this image, please contact us through a GitHub issue.

License

• The MIT License (MIT)
• See LICENSE file.