플러그인 설치 및 관리
플러그인은 GitHub, Jira, Zoom 같은 사전 제작 연동부터 팀이 직접 만든 맞춤 플러그인까지, 새로운 기능과 연동으로 Mattermost를 확장합니다. 시스템 관리자는 시스템 콘솔이나 mmctl 명령줄 도구를 사용해 플러그인을 설치, 활성화, 구성, 업데이트, 제거할 수 있습니다.
이 페이지는 플러그인의 수명 주기를 관리하는 방법을 설명합니다. 사전 제작 플러그인과 맞춤 플러그인에 대한 개념적인 개요는 플러그인 문서를 참고하세요. 플러그인 구성 옵션 전체 목록은 플러그인 구성 설정 문서를 참고하세요. 직접 플러그인을 만들려면 Mattermost 플러그인 개발자 문서를 참고하세요.
플러그인을 설치하고 관리하려면 시스템 관리자여야 합니다. 플러그인은 서버 수준에서 관리되며 Mattermost 배포 전체에 적용됩니다.
시작하기 전에
플러그인의 제공 여부와 수행할 수 있는 작업은 시스템 콘솔의 Plugins > Plugin Management(플러그인 > 플러그인 관리)에 있는 몇 가지 구성 설정에 따라 달라집니다. 플러그인을 설치하거나 업데이트하기 전에 다음 설정을 확인하세요.
- Enable plugins(
PluginSettings.Enable)가 true(기본값)여야 플러그인 시스템이 동작합니다. 비활성화하면 모든 플러그인이 꺼집니다. - Enable Marketplace(
PluginSettings.EnableMarketplace)가 true(기본값)여야 제품 내 Marketplace에서 플러그인을 설치할 수 있습니다. - Enable remote Marketplace(
PluginSettings.EnableRemoteMarketplace)가 true(기본값)여야 Marketplace가 원격 엔드포인트에 연결해 커뮤니티 플러그인과 Mattermost 제공 플러그인을 목록에 표시합니다. 인터넷에 연결할 수 없는 서버에서는 이 값을 false로 설정하세요. 이 경우 Marketplace에는 사전 패키지 플러그인과 설치된 플러그인만 표시됩니다. - Upload Plugin(
PluginSettings.EnableUploads)이 true여야 로컬 컴퓨터에서 플러그인 번들을 업로드할 수 있습니다. 이 설정은 자체 호스팅 배포에만 적용됩니다.
플러그인을 업로드할 때 Received invalid response from the server 오류가 발생한다면, 최대 파일 크기 구성 설정이 플러그인 번들에 비해 너무 작을 가능성이 높습니다. 이 값을 늘리고 필요에 따라 프록시 설정도 함께 조정하세요.
각 설정의 config.json 경로와 환경 변수를 포함한 자세한 내용은 플러그인 구성 설정 문서를 참고하세요.
플러그인 설치 방법
플러그인은 제품 내 Marketplace에서 설치하거나, 플러그인 번들을 업로드하거나, mmctl을 사용해 설치할 수 있습니다. Mattermost Server에 함께 배포되는 사전 패키지 플러그인은 Automatic prepackaged plugins(PluginSettings.AutomaticPrepackagedPlugins)가 활성화되어 있으면(기본값) 자동으로 설치되고 업그레이드됩니다.
App Marketplace
사전 제작 플러그인은 Marketplace에서 설치하는 것이 권장되는 방법입니다. Marketplace는 항상 호환되는 최신 버전을 설치하며, Marketplace에서 내려받은 플러그인은 서명 검증을 거칩니다.
- Mattermost에서 제품 메뉴
를 열고 App Marketplace를 선택합니다. - 원하는 플러그인을 검색하거나 목록에서 찾은 뒤 Install을 선택합니다.
- 설치가 끝나면 Configure를 선택해 시스템 콘솔에서 설정을 열거나, Enable을 선택해 기본 구성으로 활성화합니다.
- 설치가 성공했는지 확인합니다. Plugins > Plugin Management의 Installed Plugins 목록에 플러그인이 나타나고, Mattermost에서 해당 기능을 사용할 수 있어야 합니다.
Mattermost Marketplace 웹사이트에서는 커뮤니티가 지원하는 더 다양한 연동을 찾을 수 있습니다.
플러그인 업로드
Marketplace에 없는 맞춤 플러그인이나 서드파티 플러그인을 설치할 때, 또는 서버가 에어갭이나 제한된 환경에서 운영될 때는 플러그인 번들을 업로드합니다. 업로드하려면 Upload Plugin 설정이 활성화되어 있고 Require plugin signature(PluginSettings.RequirePluginSignature) 설정이 비활성화되어 있어야 합니다.
- 보통 플러그인의 GitHub 릴리스 페이지에서 플러그인 번들(
.tar.gz파일)을 내려받습니다. 많은 플러그인이 플랫폼별로 더 작은 번들(예:linux-amd64)을 따로 제공하며, 지원되는 모든 플랫폼의 바이너리를 담은 더 큰 통합 번들도 함께 제공합니다. 서버의 운영체제와 아키텍처에 맞는 번들을 내려받으세요. 다른 플랫폼용으로 빌드된 번들은 시작되지 않습니다. 통합 번들을 사용하면 Mattermost가 서버에 맞는 바이너리를 자동으로 선택합니다. - 시스템 관리자 계정으로 Mattermost 시스템 콘솔에 로그인합니다.
- Plugins > Plugin Management로 이동합니다.
- Upload Plugin 섹션에서 Choose File을 선택하고 내려받은 플러그인 번들을 고른 뒤 Upload를 선택합니다.
- 플러그인이 Installed Plugins 목록에 나타납니다. Enable을 선택해 활성화합니다.
mmctl
mmctl 명령줄 도구는 스크립트 기반 또는 원격 플러그인 관리에 유용합니다. 먼저 서버 구성에서 플러그인이 활성화되어 있어야 합니다.
아래에서 <id>로 표기한 플러그인 ID를 인자로 받는 명령이 여럿 있습니다. 플러그인 ID는 해당 플러그인의 plugin.json 매니페스트에 있는 id 값입니다. github나 playbooks처럼 플러그인 이름인 경우가 많지만, Calls 플러그인의 com.mattermost.calls처럼 역방향 DNS 식별자를 쓰는 플러그인도 있습니다. 설치된 플러그인의 ID 목록을 보려면 mmctl plugin list를 실행하세요.
- 플러그인 ID로 Marketplace의 최신 버전을 설치합니다.
mmctl plugin marketplace install <id> - 로컬 컴퓨터에 있는 플러그인 번들을 설치합니다.
mmctl plugin add myplugin.tar.gz - URL에서 플러그인 번들을 설치합니다.
mmctl plugin install-url https://example.com/myplugin.tar.gz
설치한 뒤에는 플러그인 ID로 활성화합니다.
mmctl plugin enable <id>플러그인 활성화 및 비활성화
플러그인을 설치했다고 자동으로 켜지지는 않습니다. 사용자에게 제공하려면 플러그인을 활성화하고, 제거하지 않은 채 사용자 인터페이스에서만 빼려면 비활성화합니다.
시스템 콘솔에서 플러그인을 활성화하거나 비활성화하려면 다음과 같이 하세요.
- Plugins > Plugin Management로 이동합니다.
- Installed Plugins 목록에서 해당 플러그인을 찾습니다.
- Enable 또는 Disable을 선택합니다.
mmctl로 플러그인을 활성화하거나 비활성화하려면 다음과 같이 하세요.
mmctl plugin enable <id>
mmctl plugin disable <id>플러그인을 비활성화하면 즉시 사용자 인터페이스에서 사라지고 플러그인 실행이 중지됩니다. 플러그인은 설치된 상태로 남아 있으며 언제든 다시 활성화할 수 있습니다.
플러그인 구성
대부분의 플러그인에는 자체 설정 페이지가 있습니다. 플러그인을 설치한 뒤 시스템 콘솔의 Plugins로 이동해 이름으로 플러그인을 선택하고 구성한 다음 Save를 선택합니다. 사용할 수 있는 설정은 각 플러그인의 문서를 참고하세요.
플러그인 업데이트
새 버전이 릴리스되면 플러그인을 최신 상태로 유지하는 것을 권장합니다. 업데이트는 대체로 매끄럽게 진행되며 사용자 경험을 방해하지 않지만, 각 플러그인의 릴리스 노트에서 호환성 관련 사항을 확인하고 운영 환경에 적용하기 전에 스테이징 환경에서 업데이트를 테스트하는 것이 좋습니다.
다음 방법 중 하나로 플러그인을 업데이트할 수 있습니다.
- 사전 패키지 플러그인은 Automatic prepackaged plugins 설정이 활성화되어 있으면(기본값) 자동으로 업그레이드됩니다. 이미 더 최신 버전이 설치되어 있다면 변경되지 않습니다.
- Marketplace 플러그인은 더 새로운 버전이 있을 때 App Marketplace에 Update 옵션이 표시됩니다. 이를 선택하면 최신 버전이 설치됩니다.
- 업로드한 플러그인은 Plugins > Plugin Management에서 동일한 플러그인 ID를 가진 더 새로운 번들을 업로드해 업데이트합니다. 새 버전이 기존 버전을 덮어씁니다.
- mmctl은 동일한 플러그인 ID를 가진 번들을 추가하면 설치된 플러그인을 업데이트합니다. 기존 버전을 덮어쓰려면
--force(-f) 플래그를 사용하세요.mmctl plugin add myplugin.tar.gz --force mmctl plugin install-url https://example.com/myplugin.tar.gz --force--force플래그는 확인을 묻지 않고 설치된 플러그인을 덮어쓰므로, 운영 환경에 적용하기 전에 새 번들의 호환성을 확인하고 가급적 스테이징 환경에서 테스트하세요.mmctl plugin marketplace install <id>로 Marketplace의 최신 버전을 다시 설치할 수도 있습니다.
현재 설치된 버전을 확인하려면 Plugins > Plugin Management로 이동해 Installed Plugins 목록을 확인하거나 mmctl plugin list를 실행하세요.
플러그인 제거
플러그인을 제거하면 비활성화된 뒤 서버에서 삭제됩니다.
시스템 콘솔에서 플러그인을 제거하려면 다음과 같이 하세요.
- Plugins > Plugin Management로 이동합니다.
- Installed Plugins 목록에서 해당 플러그인을 찾습니다.
- Remove를 선택합니다.
mmctl로 플러그인을 제거하려면 다음과 같이 하세요.
mmctl plugin delete <id>플러그인을 제거하면 서버에서 삭제되고 실행이 중지되지만, Mattermost는 플러그인과 연관된 다음 데이터를 보존합니다.
- 구성: 플러그인의 구성은 삭제되지 않고 비활성화 상태로 표시된 채 유지됩니다. 같은 플러그인을 다시 설치하면 이전 설정이 복원됩니다.
- 키-값 저장소 데이터: 플러그인이 키-값(KV) 저장소에 저장한 데이터는 보존됩니다. 이 데이터는 플러그인이 플러그인 API를 통해 직접 삭제할 때만 지워지며, 플러그인을 제거한다고 지워지지 않습니다.
- 봇 계정: 플러그인이 만든 봇 계정은 서버에 남아 활성 상태를 유지합니다. 제거하려면 System Console > Integrations > Bot Accounts(시스템 콘솔 > 연동 > 봇 계정)에서 봇 계정을 직접 비활성화하세요.
구성과 KV 저장소 데이터가 유지되므로 제거는 사실상 되돌릴 수 있습니다. 플러그인을 다시 설치하면 이전 구성과 데이터가 복원됩니다.
Mattermost는 제거된 플러그인이 남긴 구성이나 키-값 데이터를 시스템 콘솔이나 mmctl로 완전히 삭제하는 기본 수단을 제공하지 않습니다. 데이터 보존이나 컴플라이언스 요구 사항 때문에 이 데이터를 반드시 지워야 한다면 Mattermost 데이터베이스를 직접 변경해야 하므로 Mattermost 지원에 문의해 안내를 받으세요.
에어갭 및 제한된 환경
인터넷에 연결되지 않은 배포에서는 Enable remote Marketplace를 false로 설정해 Marketplace가 사전 패키지 플러그인과 설치된 플러그인만 표시하도록 하고, 시스템 콘솔에서 번들을 직접 업로드해 플러그인을 설치하세요. 자세한 내용은 에어갭 환경 배포 문서를 참고하세요.
관련 문서
- 플러그인 - 사전 제작 플러그인과 맞춤 플러그인에 대해 알아봅니다.
- 많이 쓰는 사전 제작 연동 - 사용할 수 있는 사전 제작 플러그인과 도입 방법을 살펴봅니다.
- 플러그인 구성 설정 - 모든 플러그인 구성 설정을 확인합니다.
- mmctl 명령줄 도구 - 명령줄에서 플러그인을 관리합니다.