명령 줄 도구

모든 플랜 에서 사용 가능

자체 관리형 배포에서는, Mattermost 서버가 설치된 디렉터리에서 시스템을 구성할 수 있는 ‘mattermost’ 명령을 사용할 수 있습니다. Mattermost 명령행 인터페이스 (CLI)의 개요는 이 기사 를 참조하십시오. Santos 작성.

Important

Mattermost v6.0부터 이러한 대부분의 CLI 명령이 mmctl 커맨드 라인 도구 을 사용하여 사용 가능한 동등한 명령으로 대체되었습니다. 그러나, mattermost import 명령, mattermost export 명령 및 관련 하위 명령은 Mattermost v6.0부터 구버전으로 완전히 지원됩니다.

이러한 mattermost 명령에는 다음과 같은 기능이 포함되어 있습니다:

컴플라이언스 익스포트

데이터 익스포트
익스포트 작업 일정 설정

데이터베이스

데이터베이스 초기화, 실행 마이그레이션 및 사용자 정의 기본값로드
적용되지 않은 마이그레이션을 위한 데이터베이스 스키마 마이그레이션
데이터베이스를 초기 상태로 재설정
가장 최근에 적용된 버전 번호 반환
데이터베이스 마이그레이션 롤백

서버 작업

Mattermost 작업 서버 시작
Mattermost 서버 실행
Mattermost 버전 정보 표시

CLI 사용

CLI 명령을 실행하려면 Mattermost 루트 디렉터리에 있어야 합니다. Mattermost의 기본 설치에서 루트 디렉터리는 /opt/mattermost 입니다. 저희의 표준 설치 프로세스 를 따른 경우, 사용자 mattermost 로 명령을 실행해야 합니다. 실행 파일의 이름은 mattermost 이며, /opt/mattermost/bin 디렉터리에서 찾을 수 있습니다.

예를 들어, Mattermost의 기본 설치에서 Mattermost 버전을 가져 오려면:

cd /opt/mattermost/
sudo -u mattermost bin/mattermost version

Note

mattermost 이진 파일을 mattermost 사용자로 실행하는지 확인하십시오. root 사용자로 실행하는 경우 (예 :), 이진 파일이 플러그인을 초기화하고 CLI 명령을 실행할 때 다양한 파일에 액세스하기 때문에 권한과 관련된 문제가 발생할 수 있습니다. root 으로 서버를 실행하면 플러그인 및 파일의 소유권이 재작성되고 다른 잠재적인 권한 오류가 발생할 수 있습니다.
데이터베이스에서 구성을 저장하는 Mattermost 설치에서 CLI 명령을 실행할 때는 데이터베이스 연결 문자열을 전달해야 할 수 있습니다:
```
bin/mattermost --config="postgres://mmuser:mostest@localhost:5432/mattermost_test?sslmode=disable\u0026connect_timeout=10"
```

GitLab Omnibus에서 CLI 명령을 실행할 때는 다음 디렉터리에 있어야 합니다: /opt/gitlab/embedded/service/mattermost . 또한, 사용자 mattermost 로 명령을 실행하고 구성 파일의 위치를 지정해야 합니다. 실행 파일은 /opt/gitlab/embedded/bin/mattermost 입니다.

예를 들어, GitLab Omnibus에서 Mattermost 버전을 가져오려면:

cd /opt/gitlab/embedded/service/mattermost
sudo /opt/gitlab/embedded/bin/chpst -e /opt/gitlab/etc/mattermost/env -P -U mattermost:mattermost -u mattermost:mattermost /opt/gitlab/embedded/bin/mattermost version

Note

이 문서 페이지의 예시 명령어는 Mattermost의 기본 설치를 대상으로 합니다. GitLab Omnibus에서 작동하도록 명령어를 수정해야 합니다.

Docker 설치에서는 /mattermost/bin 디렉터리가 PATH 에 추가되었으므로 docker exec 명령을 사용하여 CLI를 직접 사용할 수 있습니다. 컨테이너 이름은 docker-compose.yml 로 Mattermost를 설치한 경우 mattermostdocker_app_1 일 수 있습니다.

예를 들어, Docker 설치에서 Mattermost 버전을 가져 오려면:

docker exec -it <your-mattermost-container-name> mattermost version

Note

CLI는 고가용성 환경 에서 모든 노드에서 작업을 수행하는 메커니즘을 우회하여 실행됩니다. 따라서, CLI 명령어 를 고가용성 환경에서 실행할 때 구성 설정을 변경하는 작업은 서버 재시작이 필요합니다.
CLI 명령에 있는 매개 변수는 순서별이어야 합니다.
특수 문자 ( ! , | , ( , ) , \ , ' , 또는 " )을 사용하는 경우 전체 인수를 단일 따옴표로 묶거나 각 문자를 이스케이프 처리해야 합니다.

옵션

-- <plan-file> string      정의된 계획 파일 내의 롤백 마이그레이션을 실행합니다.

mattermost db init

설명

지정된 데이터 소스 이름 (DSN)에 대한 데이터베이스를 초기화하고 마이그레이션을 실행하며 필요한 경우 사용자 정의 기본값을로드합니다.

포맷

mattermost db init

예시

DSN을 전달하려면 config 플래그를 사용하세요:

mattermost db init --config postgres://localhost/mattermost

MM_CONFIG 환경 변수를 사용하려면 이 명령어를 실행하세요:

MM_CONFIG=postgres://localhost/mattermost mattermost db init

데이터베이스에로드 할 사용자 정의 기본값 파일을 설정하려면 이 명령을 실행하세요:

MM_CUSTOM_DEFAULTS_PATH=custom.json MM_CONFIG=postgres://localhost/mattermost mattermost db init

mattermost db migrate

설명

적용되지 않은 마이그레이션이있는 경우 데이터베이스 스키마를 마이그레이션합니다.

하위 명령어

mattermost db downgrade _ - 데이터베이스 마이그레이션을 롤백합니다.

포맷

mattermost db migrate

예시

mattermost db migrate

옵션

--auto-recover bool     마이그레이션 중에 오류가 발생하는 경우 이 명령어는 계획 내에 이미 적용된 마이그레이션을 롤백하려고 시도합니다. --save-plan 및 --dry-run 옵션을 결합하여 마이그레이션 계획을 검토하거나 다운그레이드하는 것은 권장하지 않습니다.
--save-plan bool        마이그레이션 계획을 파일 저장소에 저장하여 계획을 검토하거나 다운그레이드에 사용할 수 있도록 합니다.
--dry-run bool          마이그레이션을 적용하지 않지만 주어진 조건에 따라 마이그레이션이 어떻게 실행될지를 유효성을 검사합니다.

mattermost db reset

설명

데이터베이스를 초기 상태로 재설정합니다. 응용 프로그램 서버를 시작하지 않습니다. 스토어 레이어를 시작하고 migrations 테이블을 제외한 테이블을 잘라냅니다.

포맷

mattermost db reset

예시

bin/mattermost db reset

mattermost db version

설명

가장 최근에 적용된 버전 번호를 반환합니다.

포맷

mattermost db version

예시

bin/mattermost export actiance --exportFrom=1513102632

옵션

--exportFrom string     데이터를 내보낼 Unix 타임스탬프(UTC 기준 밀리초)를 지정합니다.
--batchSize int         내보낼 게시물 수를 지정합니다. -1의 기본값은 제한 없음을 의미합니다.

mattermost export

orphan
nosearch

Note

Enterprise 플랜에서 사용 가능

설명

규정 준수 및 여러 Mattermost 인스턴스 병합을 위해 데이터를 내보내는 명령어입니다.

하위 명령어

mattermost export actiance _ - Actiance XML 형식으로 Mattermost에서 데이터를 내보냅니다. Mattermost 엔터프라이즈 구독 플랜이 필요합니다.
mattermost export bulk _ - Mattermost 대량 가져오기 형식 과 호환되는 파일로 데이터를 내보냅니다. mmctl export commands 의 지원이 중단됐습니다.
mattermost export csv _ - CSV 형식으로 Mattermost에서 데이터를 내보냅니다. Mattermost 엔터프라이즈 구독 플랜이 필요합니다.
mattermost export global-relay-zip _ - Mattermost에서 Global Relay로 디버그 및 테스트 용도의 이메일이 포함 된 ZIP 파일을 내보냅니다. Mattermost 엔터프라이즈 구독 플랜이 필요합니다.
mattermost export schedule _ - 내보내기 작업을 예약합니다.

mattermost export actiance

설명

Actiance XML 형식으로 Mattermost에서 데이터를 내보냅니다.

포맷

mattermost export actiance

예시

bin/mattermost export actiance --exportFrom=1513102632

옵션

--exportFrom string     데이터를 내보낼 Unix 타임스탬프(UTC 기준 밀리초)를 지정합니다.
--batchSize int         내보낼 게시물 수를 지정합니다. -1의 기본값은 제한 없음을 의미합니다.

mattermost export bulk

Mattermost v6.0부터 이 명령어는 mmctl export commands 를 지원하는 방식으로 사용되지 않습니다.

mattermost export csv

설명

CSV 형식으로 Mattermost에서 데이터를 내보냅니다.

포맷

mattermost export csv

예시

bin/mattermost export csv --exportFrom=1513102632

옵션

--exportFrom string     데이터를 내보낼 Unix 타임스탬프(UTC 기준 초)를 지정합니다.
--batchSize int         내보낼 게시물 수를 지정합니다. -1의 기본값은 제한 없음을 의미합니다.

mattermost export global-relay-zip

설명

디버그 및 테스트 용도로 Mattermost에서 Global Relay로 전송할 이메일이 포함 된 ZIP 파일을 내보냅니다. 이것은 Global Relay에 정보를 보관하지 않습니다.

포맷

mattermost export global-relay-zip

예시

bin/mattermost export global-relay-zip --exportFrom=1513102632

옵션

--exportFrom string     데이터를 내보낼 Unix 타임스탬프(UTC 기준 초)를 지정합니다.
--batchSize int         내보낼 게시물 수를 지정합니다. -1의 기본값은 제한 없음을 의미합니다.

mattermost export schedule

설명

서드파티 아카이브 시스템으로 가져올 수 있는 형식으로 내보내기 작업을 예약합니다.

포맷

mattermost export schedule

예시

bin/mattermost export schedule --format=actiance --exportFrom=1513102632

옵션

--format string         출력 파일 형식을 지정합니다. 현재   ``actiance``  만 지원됩니다.
--exportFrom string     데이터를 내보낼 Unix 타임스탬프(UTC 기준 초)를 지정합니다.
--timeoutSeconds string 제한 시간 전에 내보내기를 실행할 지 지정합니다.

mattermost help

설명

Mattermost 명령 줄 도구에 대한 전체 문서를 Markdown 형식으로 생성합니다.

포맷

mattermost help {outputdir}

mattermost import

설명

Mattermost에 데이터를 가져옵니다.

하위 명령어

mattermost import bulk _ - Mattermost 대량 가져오기 파일을 가져옵니다. mmctl import commands 의 지원이 중단됐습니다.
mattermost import slack _ - Slack에서 팀을 가져옵니다.

mattermost import bulk

Mattermost v6.0부터 이 명령어는 mmctl import commands 를 지원하는 방식으로 사용되지 않습니다.

mattermost import slack

mmctl import commands 문서를 참조하여 Slack 데이터를 Mattermost로 가져오는 우선적인 방법을 확인하세요.

Description

Slack 내보내기 zip 파일에서 팀을 가져옵니다.

Format

mattermost import slack {team} {file}

Example

bin/mattermost import slack myteam slack_export.zip

mattermost jobserver

Description

Mattermost 작업 서버를 시작합니다.

Format

mattermost jobserver

Example

bin/mattermost jobserver

mattermost server

Description

Mattermost 서버를 실행합니다.

Format

mattermost server

mattermost version

Note

Mattermost v6.5부터이 CLI 명령은 더 이상 데이터베이스와 상호 작용하지 않습니다. mattermost db migrate CLI 명령이 스키마 마이그레이션을 트리거하는 데 도입되었습니다.

Desription

Mattermost 버전 정보를 표시합니다.

Format

mattermost version

Troubleshooting

명령을 실행하면 멈추고 완료되지 않음

Bleve 검색 색인화가 활성화되어 있는 경우 System Console > Experimental > Bleve 에서 일시적으로 비활성화한 다음 명령을 다시 실행합니다. 새로운 mmctl Command Line Tool 을 선택적으로 사용할 수도 있습니다.

Bleve는 동일한 색인을 여는 및 조작하는 여러 프로세스를 지원하지 않습니다. 따라서 만약 Mattermost 서버가 실행 중인 경우 CLI를 실행하려고 하면 잠길 것입니다.

Bleve 검색 색인화를 사용하고 있지 않은 경우, 도움을 받으려면 Troubleshooting forum 에 게시하세요.

Mattermost 원문 보기