Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 2.63 KB

configuration.md

File metadata and controls

75 lines (46 loc) · 2.63 KB
Raw

Configuration

Configure the Server

Gello requires certain environment variables to be set for the server to be run correctly. Note that at least one of the Trello or JIRA configuation value sections must be correctly filled for Gello to start.

# Admin user configuration
ADMIN_EMAIL='[email protected]'
ADMIN_PASSWORD='an_admin_password' # create a password for logging into gello

# Database configuration
DATABASE_URL='the_url_for_a_postgresql_database' # likely postgresql://localhost:5432/your_postgresql_database_name
TEST_DATABASE_URL='the_url_for_a_postgresql_database' # Database URL for your test database (used for testing)

# Redis configuration
REDIS_URL='the_url_for_a_redis_client' # defaults to 'redis://localhost:6379/0'

# GitHub configuration values
GITHUB_API_TOKEN='An API token for a user with access to your GitHub organization'

# Trello configuration values
TRELLO_API_KEY="A user's public trello API key"
TRELLO_API_TOKEN='An API token generated by the corresponding user'

# JIRA configuration values
JIRA_USERNAME="A user's email address used to log into their JIRA server"
JIRA_API_KEY='A generated API token corresponding to the user'
JIRA_SERVER_ADDRESS='Server address for the JIRA instance' # (including protocol ex. https://gello.atlassian.net)'

GitHub API Token

The GitHub API token you provide should have the following permissions set:

  • public_repo
  • read:org
  • write:repo_hook
  • admin:org_hook

GitHub API Token Permissions

Trello Configuration

Gello requires two environment variables be set to properly configure the Trello integration.

  1. TRELLO_API_KEY

This is the key found in the Trello Developer API Keys page:

Trello API Key

  1. TRELLO_API_TOKEN

This is a token generated by from the same Trello Developer API Keys page:

Trello API Token

JIRA Configurations

Gello requires three environment variables for its JIRA integration.

  1. JIRA_USERNAME

This is the email address used to log in to JIRA.

  1. JIRA_API_KEY

This is a user-generated API token found under the JIRA user API tokens page. Follow these instructions to create a new API token:

JIRA API Token

  1. JIRA_SERVER_ADDRESS

This is the server address that API calls will be made to. Remember to include the protocol used (ex. https://gello.atlassian.net instead of gello.atlassian.net)