mcp-atlassian/env.example at main · ComputerPers/mcp-atlassian · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# MCP-ATLASSIAN CONFIGURATION
# Note: Do not use double quotes for any values in this file

# =============================================
# GENERAL CONFIGURATION
# =============================================

# Transport Options
# CLI: --transport [stdio|sse], --port PORT
# Default: stdio transport
# Note: PORT is only used when TRANSPORT=sse
# TRANSPORT=stdio        # Options: stdio, sse
# PORT=8000              # Only used when TRANSPORT=sse

# Read-only Mode (disables all write operations)
# CLI: --read-only
# READ_ONLY_MODE=true

# Debug Options
# CLI: -v/--verbose (once for INFO, twice for DEBUG)
# Default logging level is WARNING (minimal output)
# MCP_VERBOSE=true           # For INFO level (same as -v)
# MCP_VERY_VERBOSE=true      # For DEBUG level (same as -vv)

# =============================================
# CONFLUENCE CONFIGURATION
# =============================================

## ---- CLOUD DEPLOYMENT ----
# CLI: --confluence-url, --confluence-username, --confluence-token
# CONFLUENCE_URL=https://your-domain.atlassian.net/wiki
# CONFLUENCE_USERNAME=your.email@domain.com
# CONFLUENCE_API_TOKEN=your_api_token

# Optional: Filter spaces
# CLI: --confluence-spaces-filter
# CONFLUENCE_SPACES_FILTER=DEV,TEAM,DOC

## ---- SERVER/DATA CENTER DEPLOYMENT ----
# CLI: --confluence-url, --[no-]confluence-ssl-verify
# CONFLUENCE_URL=https://confluence.your-company.com
# CONFLUENCE_SSL_VERIFY=true           # CLI: --[no-]confluence-ssl-verify

## Authentication options (choose one):

# 1. Using Personal Access Token (recommended):
# CLI: --confluence-personal-token
# CONFLUENCE_PERSONAL_TOKEN=your_personal_access_token

# 2. Using Basic Authentication (username/password):
# CLI: --confluence-username, --confluence-token
# CONFLUENCE_USERNAME=your_username
# CONFLUENCE_API_TOKEN=your_password

# =============================================
# JIRA CONFIGURATION
# =============================================

## ---- CLOUD DEPLOYMENT ----
# CLI: --jira-url, --jira-username, --jira-token
JIRA_URL=https://your-domain.atlassian.net
JIRA_USERNAME=your.email@domain.com
JIRA_API_TOKEN=your_api_token

# Optional: Filter projects
# CLI: --jira-projects-filter
# JIRA_PROJECTS_FILTER=PROJ,DEV,SUPPORT

## ---- SERVER/DATA CENTER DEPLOYMENT ----
# CLI: --jira-url, --jira-personal-token, --[no-]jira-ssl-verify
# JIRA_URL=https://jira.your-company.com
# JIRA_PERSONAL_TOKEN=your_personal_access_token
# JIRA_SSL_VERIFY=true                 # CLI: --[no-]jira-ssl-verify


# ==============================================
# TEST DOCKER ENVIRONMENT CONFIGURATION
# Used by tests.sh when running with Docker (default)
# ==============================================

# --- Variables for docker-compose.test.yml ---

# PostgreSQL credentials for the test database container
POSTGRES_DB=jiradb_test
POSTGRES_USER=jirauser_test
POSTGRES_PASSWORD=replace_with_a_strong_random_password # <<< CHANGE THIS in .env

# Jira License Key (Time-bomb or Developer license)
# V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V
# V V V   INSERT YOUR JIRA LICENSE KEY HERE IN .env                   V V V
# V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V V
JIRA_LICENSE_KEY= # <<< PASTE YOUR TIME-BOMB LICENSE KEY HERE in .env

# Jira Admin credentials to attempt auto-setup in the container
# These will also be used by default for tests run against the container.
JIRA_ADMIN_USERNAME=admin_test
JIRA_ADMIN_PASSWORD=admin_test_password # <<< CHANGE THIS in .env (should match JIRA_API_TOKEN for test user below)

# --- Variables for pytest connecting to the Docker container ---
# Override the default JIRA_* variables above when using Docker tests.

# URL needs to point to the container service name inside the Docker network
JIRA_URL=http://jira-test-atlassian:8080

# Credentials used by pytest to connect to the test Jira instance
JIRA_USERNAME=admin_test # Use the admin user created above
JIRA_API_TOKEN=admin_test_password # Use the admin password created above
# JIRA_PERSONAL_TOKEN= # Not typically used with the test container

# Disable Confluence for tests unless you set up a test Confluence container too
CONFLUENCE_URL=
CONFLUENCE_USERNAME=
CONFLUENCE_API_TOKEN=
# CONFLUENCE_PERSONAL_TOKEN=

# --- Optional: Read-only mode for tests ---
# READ_ONLY_MODE=true