[레드마인 플러그인] Redmine CKEditor (with Redmine 4.2.9)

소개

CKEditor는 글을 작성할 때 글자의 폰트, 색상, 스타일, 정렬, 그림 첨부, 코드 스니핏 등의 기능을 제공하는 에디터 툴이라고 생각하시면 됩니다. 레드마인은 기본적으로 마크다운을 제공하지만, 더 풍부한 기능을 사용하기 위해서는 CKEditor를 별도로 설치해야 합니다.

CKEditor 편집 화면

설치 따라 하기

1. 저장소에서 최신 버전 다운로드하기

git clone -b 1.2.3 https://github.com/a-ono/redmine_ckeditor

2. 파일 복사하기

Redmine Plugin 경로를 매핑했다면, 아래와 같이 업로드합니다.

Plugin 경로에 파일 업로드하기

만약, 매핑을 안 했다면 직접 다운로드한 파일을 Redmine plugin 경로로 복사해야 하는 번거로움이 있습니다. 차라리 셋업 과정에서 매핑을 해놓고 시작하는 게 좋습니다. 매핑 관련해서는 아래 게시물을 참고하세요.

[Container Manager] MariaDB와 레드마인 구축하는 방법, 쉽게 따라하기

[Container Manager] MariaDB와 레드마인 구축하는 방법, 쉽게 따라하기

3. Redmine Plugin 경로에 파일 확인 후 설치하기

아래 명령어로 플러그인 경로에 접근합니다.

cd /home/redmine/redmine/plugins/

그리고 아래 명령어로 파일 목록을 조회합니다.

ls -l

정상적으로 파일을 복사했다면 Redmine Plugin 경로에 아래와 같이 redmine_ckeditor 폴더가 있어야 합니다.

플러그인 경로에 복사한 플러그인 확인하기

설치를 위해 다시 레드마인 루트 경로로 이동합니다.

cd /home/redmine/redmine

아래 명령어를 실행합니다.

bundle install --without development test

bundle exec rails redmine:plugins:migrate RAILS_ENV=production

설치에 문제가 없었다면 레드마인을 재시작합니다.

만약, 위 설치 과정에서 여러 오류가 발생한다면, 아래 '오류에 따른 조치 방법'을 참고하세요. 그리고 다시 위의 설치 명령어를 입력하여 재시도하시기 바랍니다. 

참고로, 아래 조치 사항은 여러 시도 끝에 해결된 방법입니다. 불필요한 명령어가 있거나 순서가 틀릴 수 있지만, 제 상황에서는 문제가 해결되었습니다.

※ 오류에 따른 조치 방법

mysql2 오류

mysql2 에러

위 이미지처럼, mysql2 오류가 있다면 아래의 순서대로 진행해 보세요.

sudo apt-get install -y build-essential libmysqlclient-dev

만약, 위 명령어를 실행해도 오류가 있다면 아래 명령어를 실행하세요.

sudo apt-get update

sudo apt-get install -y default-libmysqlclient-dev

이후 아래의 명령어를 실행하세요.

gem install mysql2 -v '0.5.6'

마지막으로 아래의 명령어를 실행합니다.

bundle install

ruby 2.7.0 오류

ruby 2.7.0 오류

위 이미지처럼, ruby 2.7.0 오류가 있다면 아래의 순서대로 진행해 보세요.

bundle install --no-deployment

만약, sqlite3 에러가 발생한다면 아래 명령어를 실행하세요.

sqlite3 오류

sudo apt-get update

sudo apt-get install -y sqlite3 libsqlite3-dev

그리고 아래의 명령어를 실행합니다.

gem install sqlite3 -v '1.4.4'

마지막으로 아래의 명령어를 실행합니다.

bundle install

pg 오류

pg 오류

위 이미지처럼, pg 오류가 있다면 아래의 순서대로 진행해 보세요.

sudo apt-get update

sudo apt-get install -y postgresql postgresql-contrib libpq-dev

그리고 아래의 명령어를 실행합니다.

gem install pg -v '1.2.3'

마지막으로 아래의 명령어를 실행합니다.

bundle install

4. rich_files 연동하기

CKEditor에서 이미지를 업로드하면 rich_files 폴더에 이미지가 보관됩니다. 혹시 이미 보유하고 있는 rich_files가 있다면, 아래의 경로에 복사합니다.

/home/redmine/redmine/public/system/rich/rich_files/rich_files

또는 아래와 같이 레드마인 컨테이너 설정에서 폴더를 매핑하여 file station에서 옮기는 것도 가능합니다.

rich_files 경로 매핑하기

5. CKEditor 활성화하기

이제 모든 설치가 완료되었으니, 레드마인의 본문 형식을 CKEditor로 변경하여 저장합니다.

레드마인 본문 형식을 변경하는 방법