[레드마인 관리] 시놀로지 레드마인 백업 및 복원 후기(+ 백업, 복원 팁)

시놀로지 레드마인 백업 및 복원기

레드마인을 사용해 온지 벌써 만 4년이 되어갑니다. 레드마인 도입 배경과 두 달 사용 후기를 남긴 것도 벌써 4년이 지났네요. (과거 글은 아래 링크를 참고하세요.)

[레드마인] 도입 배경

[레드마인] 도입 이후

사실 비용이라든가 유지 보수에 대한 신경을 쓰지 않으려면 상용 서비스를 구입하는 것이 좋은데요. 대표적으로 Zendesk와 JIRA가 있죠. 하지만 서비스 비용이 만만치 않고, 한번 서비스를 사용하면 도중에 바꾸거나 중단하기가 힘듭니다. 회사의 DB 자료를 옮긴다는 것이 쉽지 않기 때문이죠.

그래서 비용이 들지 않고 유지 보수를 위한 방법만 터득하면 아주 괜찮게 사용할 수 있다는 것이 레드마인입니다.

그런데 만 4년을 사용해오면서 아주 간과했던 사실이 있었습니다. 바로 백업과 복원인데요. 초기 레드마인 셋업을 열심히 하고 잘 사용만 해왔지 어떻게 백업하고 복원할지에 대해 신경 쓰지 못했습니다. 게다가 저의 경우에는 시놀로지 도커에서 레드마인을 사용해 왔기 때문에, 시놀로지 하이퍼 백업만 잘하면 될 줄 알았습니다.

하지만 연초에 일이 터지고 말았습니다. 시놀로지 패키지의 보안 업데이트가 수두룩하게 쌓여 있었는데, 레드마인을 업데이트한 후 모든 플러그인이 먹통이 돼버렸습니다. 이에 당황한 나머지 재설치를 진행했는데, 일부 자료(정확히는 DMSF와 CKEditor 플러그인 관련 자료)가 날아가 버렸습니다. 하이퍼 백업을 믿고 진행한 건데 알고 보니 완벽히 백업이 되지 않고 있던 것이었죠.

아무튼 서론이 너무 길었는데요. 본 포스팅을 통해 레드마인 데이터를 어떻게 백업하고 복원해야 하는지 그 과정을 설명합니다.

주의

 

 

시놀로지에서 레드마인을 사용하는 경우, 절대로 레드마인 업데이트를 하지 마시기 바랍니다. 자동 업데이트 옵션도 끄는 것을 권장합니다. 레드마인 업데이트 이후 플러그인이 먹통되기 때문에 다시 설치해야 하기 때문입니다. 그 과정에서 문제가 생기면 골치 아프니, 애초에 업데이트를 안하는 것이 낫습니다.

레드마인 사용 환경

제가 사용하는 레드마인 사용 환경은 다음과 같습니다.

Synology DSM 6.2.4-25556 Update3
Docker 20.10.3-0554
Redmine 3.4.13-0057
-- plugins --
(추천) Redmine CKEditor plugin 1.1.7
(추천) Syntax highlighting with highlightjs 1.0.3
(추천) DMSF 1.6.2
Clipboard image paste 1.13
Redmine Issue Checklist Plugin 2.1.0
(추천) Redmine Issue Templates plugin 0.2.1
(추천) Redmine Lightbox2 0.4.5
(추천) Redmine Local Avatars plugin 1.0.6
(추천) Redmine Startpage plugin 0.1.0

도커 레지스트리에서 최신 버전의 레드마인을 다운로드하여 설치하는 방법도 있습니다. 하지만 이 경우, 직접 DB 연동 작업을 해야 하고 최신 버전과 큰 차이점이 없다고 판단하여 패키지에서 제공하는 레드마인을 사용하고 있습니다.

그리고 지금까지 사용해본 플러그인 중 가장 유용한 항목은 '추천'이라 표시했습니다. 그 외 두 가지는 개인적으로 별로 권장하지 않습니다.

그럼, 위 환경 기준으로 백업 및 복원에 관한 내용을 이어가겠습니다.

레드마인 백업 점검 사항

레드마인 백업을 제대로 하고있는지 점검사항을 정리했습니다.

1. 레드마인 및 플러그인 목록과 버전

현재 사용 중인 레드마인과 플러그인의 버전을 확인합니다. 그리고 나중에 복원 시 동일한 버전으로 설치해야 문제없이 깔끔히 진행됩니다.

그리고 사용 중인 플러그인의 목록도 확인해야 합니다. 저는 복원 과정에서 안 쓰는 플러그인도 있어서 설치를 안 했는데요. 어떤 플러그인(이름이 기억이 나지 않네요)을 설치한 후 레드마인이 동작하지 않는 문제가 발생했습니다. 해당 현상을 찾아보니 백업 당시 설치된 다른 플러그인이 설치 후 DB 연동 과정에서 영향을 줬다고 하는군요.

결과적으로 백업 당시 설치되어 있던 플러그인을 모두 동일하게 설치하니 문제없이 정상 동작했습니다. 레드마인과 플러그인의 전체 정보는 관리 페이지의 정보 화면에서 확인 가능합니다.

레드마인 설치 구성 화면

2. 하이퍼 백업(Hyper Backup) 설정

저는 시놀로지 패키지 중 하나인 하이퍼 백업(Hyper Backup)을 사용하고 있습니다. 하이퍼 백업은 특정 폴더(또는 패키지)를 주기적으로 백업할 수 있는 기능인데요. 이에 대한 내용은 아래 포스팅을 참고하세요.

[Synology NAS Package] 하이퍼 백업(Hyper backup)으로 데이터 보관하기

[Synology NAS Package] 하이퍼 백업(Hyper backup)으로 데이터 보관하기

패키지 센터를 통해 레드마인을 설치하면, File Station으로 아래 경로에서 redmine 자료를 확인할 수 있습니다.

File Station > docker > redmine

docker redmine 폴더

하이퍼 백업 기능을 사용하면 해당 폴더를 주기적으로 백업할 수 있습니다. 여기서 제일 중요한 폴더는 files 인데요. 일감에서 첨부된 파일은 모두 files 폴더에 저장되기 때문입니다(뒤에서 설명할 DMSF도 이곳에 저장됩니다). 그리고 themes 폴더는 레드마인 테마 파일이 보관되는 장소인데요. 레드마인 DB 복원 시 기존에 설정되었던 테마를 찾기 때문에 이 폴더도 백업하는 게 좋습니다.

따라서, 하이퍼 백업으로 redmine 폴더를 백업한다면 첨부파일(그리고 DMSF 업로드 파일)과 테마 파일을 보관할 수 있습니다.

3. DMSF 플러그인 저장 경로

DMSF는 프로젝트 별로 파일 업로드 및 버전 관리가 가능합니다. 그런데 문제는 업로드된 파일이 보관되는 기본 경로가 Docker Redmine 이라는 것인데요. 이 경로는 레드마인 재설치 시 모두 지워지며, 자동으로 백업이 되지 않습니다.

따라서, DMSF 플러그인을 사용한다면 반드시 저장 경로를 백업이 가능한 경로로 변경해야 합니다. 이에 대한 설명은 아래 링크의 5번 항목을 참고하세요.

[레드마인 플러그인] 시놀로지 도커 레드마인(Synology Docker Redmine) DMSF 설치 및 백업 설정 방법

[레드마인 플러그인] 시놀로지 도커 레드마인(Synology Docker Redmine) DMSF 설치 및 백업 설정 방법

위 링크의 내용처럼 DMSF의 저장 경로를 변경하면, 위 1번에서 설명한 files 폴더에 DMSF 업로드 파일도 같이 저장됩니다. 즉, 하이퍼 백업으로 백업이 가능하다는 의미입니다. 만약, DMSF 파일이 백업이 제대로 안됐다면 레드마인 복원 후 아래 이미지처럼 파일이 없다는 에러가 발생합니다.

DMSF 파일을 읽을 수 없다는 에러 메시지

왜냐하면 DB는 정상적으로 복구됐지만, 실제 DMSF 파일이 존재하지 않기 때문이죠.

4. CKEditor 플러그인 저장 경로

아마 레드마인 텍스트 에디터로 CKEditor 플러그인을 가장 많이 사용할 텐데요.

[레드마인 플러그인] Redmine CKEditor

[레드마인 플러그인] Redmine CKEditor

레드마인 플러그인 중 하나인 CKEditor의 치명적인 문제점이 있습니다. 바로 하이퍼 백업 기능으로 백업이 안된다는 것입니다.

개발자분께서 좋은 플러그인을 무료로 제공해 주는 것은 정말 감사하지만, 안타깝게도 더 이상 업데이트는 없는 것 같습니다. 아래 링크를 보면, 백업을 위해 다른 경로로 설정할 수 있어야 한다는 의견이 있습니다.

https://github.com/a-ono/redmine_ckeditor/issues/295

Change path for image files · Issue #295 · a-ono/redmine_ckeditor

그런데 에디터에 무슨 저장일까 싶을 텐데요. CKEditor에서는 아래와 같이 이미지 파일을 본문에 추가할 수 있습니다.

CKEditor 본문에 삽입된 이미지 파일

그리고 이 이미지 파일은 아래 경로에 저장이 됩니다. 아래의 경로는 컨테이너 내부 경로이며 사용자가 직접 백업하지 않는 이상 자동으로 백업될 수 없습니다. 앞서 설명한 DMSF와 동일한 이유입니다.

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

위 경로의 모든 파일을 백업해두지 않으면 나중에 복원했을 때 아래처럼 깨진 그림 파일 또는 그림이 있던 공간이 비어있게 됩니다.

깨진 그림 파일 예시

즉, 안타깝지만 해당 플러그인을 사용한다면 레드마인을 삭제 또는 재설치하기 전에 미리 복사해 둬야 합니다.

5. Maria DB 저장

레드마인의 모든 정보는 DB로 관리가 되는데요. 이는 phpMyAdmin에서 확인할 수 있습니다. 자세한 내용은 아래 링크를 참고하세요.

[레드마인 관리] 시놀로지 레드마인 phpMyAdmin DB 백업 및 복구하기

[레드마인 관리] 시놀로지 레드마인 phpMyAdmin DB 백업 및 복구하기

저는 한 달에 한번 phpMyAdmin에 접속하여 직접 DB 내보내기로 파일을 관리하고 있는데요. 이 경우 백업 시기에 따라 놓치게 되는 DB의 양이 약 한 달치가 넘게 됩니다.

그런데 하이퍼 백업 기능으로 Maria DB를 백업할 수 있다고 하는군요.

https://kb.synology.com/ko-kr/DSM/help/MariaDB10/mariadb?version=6

MariaDB 10 - Synology 지식 센터

아래 그림은 하이퍼 백업 옵션 중 응용 프로그램 항목입니다. MariaDB 10을 체크하면 주기적으로 백업이 가능합니다.

MariaDB 10 백업 선택

하지만 아쉽게도 아직 응용 프로그램 복원으로 DB가 복원되는지 테스트를 못했습니다. 최근에 복원을 했을 때에도 직접 DB 내보내기와 가져오기를 수행했기 때문에, 하이퍼 백업으로 복원이 제대로 되는지 확인을 못했습니다.

이 부분은 향후 기회가 되면 또는 누군가 댓글로 경험을 공유해 주신다면 업데이트하도록 하겠습니다.

레드마인 복원 과정

이번에는 레드마인 복원 시 과정에 대해 설명하겠습니다.

1. 데이터 백업 확인

앞에서 설명했던 DB나 플러그인 그리고 플러그인 관련 저장된 자료를 백업했는지 확인합니다.

2. 레드마인 재설치

시놀로지 패키지 센터에서 레드마인을 선택하고 설치 제거를 진행합니다. 만약, DB를 그대로 사용하고 싶다면 데이터 보존 여부 과정에서 남겨두기를 선택합니다.

레드마인 설치 제거하기

그리고 다시 레드마인을 설치합니다. 설치 과정 중 기존 DB가 있으면 연동할 것인지 묻는 메시지가 표시됩니다. 그대로 사용하려면 계정 정보를 입력하고 설치를 이어갑니다.

3. 플러그인 설치

'레드마인 백업 점검 사항'의 1번 항목에서 설명한 대로, 기존에 사용 중이던 플러그인 목록 그대로 설치를 진행합니다. 새로 설치한다고 버전을 올리는 경우, 현재 레드마인 버전과 호환이 되는지 확인해야 합니다. 그리고 특정 플러그인은 다른 플러그인에 영향을 주기 때문에 운이 없으면 서로 호환되지 않아 동작하지 않는 경우도 있습니다.

따라서, 웬만하면 백업 당시의 플러그인 목록과 버전 그대로 설치할 것을 권장합니다.

4. DB 복원

만약, DB 없이 새로 설치했다면 phpMyAdmin에서 DB 가져오기를 수행해야 합니다. DB 가져오기에 대한 내용은 아래 링크를 참고하세요.

[레드마인 관리] 시놀로지 레드마인 phpMyAdmin DB 백업 및 복구하기

[레드마인 관리] 시놀로지 레드마인 phpMyAdmin DB 백업 및 복구하기

혹시 하이퍼 백업으로 MariaDB를 백업했다면, 이 데이터를 복원하는 방법도 시도해 보시기 바랍니다. 아직 저는 이 방법으로 복원해보진 않았으나, 혹시 된다면 DB를 직접 백업할 필요가 없기 때문에 상당히 중요합니다. '레드마인 백업 점검 사항'의 5번 항목에 설명되어 있습니다.

DB 복원 후 레드마인 서비스를 다시 시작합니다.

5. 백업 자료 원복

레드마인 구성 폴더 중 files 와 themes 를 백업해야 한다고 설명했었습니다. 그리고 CKEditor의 경우에는 rich_files 폴더도 백업해 둬야 한다고 설명했죠.

이 모든 폴더를 레드마인과 플러그인 재설치 후 동일한 경로에 그대로 복사하고 붙여넣기 합니다. 용량이 큰 경우 꽤 오래 기다려야 합니다.

모든 파일이 복사되면 레드마인 서비스를 다시 시작합니다.

정리

이제 시놀로지 환경에서 레드마인을 사용할 때 어떻게 백업하고 복원하는지 아시겠나요? 사실 한번은 겪겠지 했는데 이게 이번이 될 줄은 몰랐습니다. 그래도 7년, 8년 지나서 시도하는 것보다 지금이라도 문제점과 대안 방법을 알게 되어 다행이라고 생각합니다.

혹시 레드마인을 검토하는 과정이라면 한 번은 백업과 복원 테스트를 시도해 보고 적용하는 것을 권장합니다.