h1. Welcome to YouTrack 4.x documentation space!
{note:title=Important notice}Before upgrading to the new version, please read the [Upgrade Instructions]!{note}
YouTrack 4.0, code-named Fascination, is fully devoted to agile project management. With the opening of the Early Access Program we introduce the following new features:
* [Agile Board] --- the main part of the new Agile module in YouTrack. Refer to the [Agile Board] section, to get an idea what it looks like.
* Subtasks
* [Advanced Text Search Options|Search and Command Attributes#Advanced Text Search Options]
* Workflow Requirements
* SSL Support: use client keys and trusted certificates with TeamCity, Mailbox, LDAP and SMTP connections. Please refer to the [SSL Key Management] section for more details.
* New features are supported in [TeamCity Integration|Integration with TeamCity]
* [Import from AgileZen]
{hidden-data}
h2. Overview of YouTrack Main Functions and Supported Environments
The interactive diagram shows main features and supported environments of YouTrack. Click an item to jump to its description:
{imagemap:name=[YouTrack Documentation^diagram.png]}
{map:link=[YTD4:LDAP Integration]|coords=77,48,152,65|title=LDAP Integration}
{map:link=[YTD4:OpenID Integration]|coords=77,73,152,91|title=OpenID Integration}
{map:link=[YTD4:Integration with JIRA]|coords=77,95,152,115|title=Integration with JIRA}
{map:link=[YTD4:Mailbox integration]|coords=80,138,152,155|title=Mailbox integration}
{map:link=[YTD4:YouTrack REST API Reference]|coords=80,183,151,203|title=YouTrack REST API Reference}
{map:link=[YTD4:Managing Database]|coords=9,417,207,458|title=Managing Database}
{map:link=[YTD4:Integration with External Tools]|coords=426,272,576,311|title=Integration with External Tools}
{map:link=[YTD4:Integration with TestRail]|coords=727,276,781,291|title=Integration with TestRail}
{map:link=[YTD4:Integration with TestLink]|coords=727,296,781,320|title=Integration with TestLink}
{map:link=[YTD4:Integration with TeamCity]|coords=587,310,656,331|title=Integration with TeamCity}
{map:link=[YTD4:OpenSearch Support in YouTrack]|coords=586,335,662,354|title=OpenSearch Support in YouTrack}
{map:link=[YTD4:Integration with JIRA]|coords=586,360,671,382|title=Integration with JIRA}
{map:link=[YTD4:GitHub Integration]|coords=532,192,607,216|title=GitHub Integration}
{map:link=[YTD4:Import to YouTrack]|coords=422,571,571,609|title=Import to YouTrack}
{map:link=[YTD4:Importing a Project from JIRA]|coords=583,530,726,547|title=Importing a Project from JIRA}
{map:link=[YTD4:Import from Google Code Issue Tracker]|coords=585,553,738,576|title=Import from Google Code Issue Tracker}
{map:link=[YTD4:Import from Trac]|coords=585,582,642,597|title=Import from Trac}
{map:link=[YTD4:Import from Bugzilla]|coords=585,604,643,621|title=Import from Bugzilla}
{map:link=[YTD4:Import from FogBugz]|coords=585,629,643,644|title=Import from FogBugz}
{map:link=[YTD4:Import from Mantis]|coords=585,653,651,670|title=Import from Mantis}
{map:link=[YTD4:Import from a CSV File]|coords=587,677,742,694|title=Import from a CSV File}
{map:link=[YTD4:Import from Another YouTrack Server]|coords=587,701,748,729|title=Import from Another YouTrack Server}
{map:link=[YTD4:YouTrack Supported Environments]|coords=14,609,338,732|title=YouTrack Supported Environments}
{map:link=[YTD4:Managing Basic Settings]|coords=69,225,153,263|title=Managing Basic Settings}
{map:link=[http://www.jetbrains.com/youtrack/hosted/index.html]|coords=99,305,152,326|title=YouTrack Hosted}
{map:link=[http://www.jetbrains.com/youtrack/download/index.html]|coords=73,328,153,349|title=Download YouTrack}
{map:link=[YTD4:Executing Commands from Comment to VCS Commit]|coords=531,155,613,187|title=Executing Commands from Comment to VCS Commit}
{imagemap}
{hidden-data}
{section}
{column:width=70%}
h2. YouTrack Documentation
h3. Where to Look First
To start with, especially if you are new to YouTrack, we recommend you to take a look at our [Quick Start Guides]. Learn how to [create and edit issues|Quick Start Guide. Creating and Editing Issues], [use commands to change one or several issues at once|Quick Start Guide. Using Command Window], how to [search for issues|Quick Start Guide. Searching for Issues], how to [use tags|Quick Start Guide. Using Tags] and [saved searches|Quick Start Guide. Using Saved Searches], [take screenshots within YouTrack|Quick Start Guide. Using Screenshot Applet] and [attach files|Quick Start Guide. Adding Attachments to an Issue] to issues, how to receive notifications about changes in issues, and so on.
In addition to these guides, take a look at [YouTrack demos|http://www.jetbrains.com/youtrack/documentation/] --- the quickest way to get familiar with YouTrack.
Where to next? Give a try to [YouTrack FAQ|FAQ] --- maybe your questions have been answered already.
For the most thorough users: dig into [Search Query and Commands reference] to learn about all available command attributes, commands and search query grammar.
h3. Installation and Upgrade
[This section|Installation and Upgrade] will help users to install YouTrack on various platforms and upgrade already existing instance to a new version.
For those of you who are going to upgrade an existing installation to YouTrack 4.0 it's highly recommended to view [Upgrade Instructions] page before starting the upgrade.
h3. Administrator's Guide
[Administrator's guide|Administrator's Guide] is for users with administrator permissions in YouTrack. It will help you to [configure general settings of your YouTrack instance|Managing Basic Settings], [manage your YouTrack database|Managing Database] (i.e. configure database location, back up and restore your data), [create and manage projects|Managing Projects], add [users|Managing Users] and [groups|Managing User Groups], configure [user roles|Managing Roles] and [permissions|YouTrack Permissions Reference], [create and manage custom issue fields|Managing Custom Fields].
h3. Import to YouTrack
This guide will help you to import your existing data from other issue tracking systems to YouTrack using [YouTrack's Python Client Library|Python Client Library]. Currently, you can import data from [Google Code Issue Tracker|Import from Google Code Issue Tracker], [Bugzilla|Import from Bugzilla], [FogBugz|Import from FogBugz], [Mantis|Import from Mantis], and [Trac|Import from Trac]. Also, you can import [existing projects|Import from Another YouTrack Server] or even [a single issue|Import a Single Issue from Another YouTrack] from another YouTrack installation.
Last, but not the least, import option is [Import from a CSV File], which allows importing data from any issue tracker, in fact.
YouTrack also supports import from Atlassian Jira. However, importing issues from Jira is slightly different from other importing options and is not implemented via the [Python Client Library]. You can [import projects from your Jira instance|Importing a Project from JIRA] right from YouTrack's web UI.
h3. Integration with External tools
Learn how to extend YouTrack abilities by integrating with external tools. [Enable and configure mailbox integration|Mailbox Integration] to create issues automatically from emails, enable [LDAP|LDAP Integration] and [OpenID|OpenID Integration] support, enable and configure [integration with test management tools|Integration with Test Management Tools] to help your testers and QAs, and [integrate YouTrack with TeamCity|Integration with TeamCity] to not only automatically set 'fixed in build' fields but to enable integration with VCS and apply commands (fix issues, change their state, priority, assignee, etc.) to issues right from comments to your commits. Direct [integration with GitHub|GitHub Integration] allows you (if you are a GitHub user) to apply commands to issues from commit comments without using TeamCity.
We also provide [support for OpenSearch format|OpenSearch Support in YouTrack] so you can search for issues in YouTrack from your browser skipping the step of opening the issue tracker.
h3. REST API Reference
YouTrack provides powerful functionality that helps you perform various actions programmatically via its RESTful API. We provide [YouTrack Rest API Reference], which is divided in four sections:
* [General REST API] reference for methods which are related to issue operations, like create or edit issues, methods for tags and saved searches, etc.
* [Administration REST API] reference for methods related to managing projects, users and groups, creating and editing issue fields, creating link types and viewing statistics.
* [Import REST API] methods which allow importing issues, users and other data to YouTrack.
* [Export Rest API] methods for exporting YouTrack data.
{column}
{column:width=30%}
h2. YouTrack Demos
h5. Issue Search
[!TSYSD:Quick Start Guide. Searching for Issues^demo_search.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/search/search_beta_demo.html]
h5. Using Commands
[!TSYSD:Quick Start Guide. Searching for Issues^demo_commands.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/commands/commands_beta_demo.html]
{hidden-data}
h5. Issue Editing
[!TSYSD:Quick Start Guide. Searching for Issues^demo_edit.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/editing/inline_editing_beta_demo.html]
h5. Using Tags
[!TSYSD:Quick Start Guide. Searching for Issues^demo_tags.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/tags/tags_beta_demo.html]
{hidden-data}
[More demos|http://www.jetbrains.com/youtrack/documentation/]
{column}
{section}
{note:title=Important notice}Before upgrading to the new version, please read the [Upgrade Instructions]!{note}
YouTrack 4.0, code-named Fascination, is fully devoted to agile project management. With the opening of the Early Access Program we introduce the following new features:
* [Agile Board] --- the main part of the new Agile module in YouTrack. Refer to the [Agile Board] section, to get an idea what it looks like.
* Subtasks
* [Advanced Text Search Options|Search and Command Attributes#Advanced Text Search Options]
* Workflow Requirements
* SSL Support: use client keys and trusted certificates with TeamCity, Mailbox, LDAP and SMTP connections. Please refer to the [SSL Key Management] section for more details.
* New features are supported in [TeamCity Integration|Integration with TeamCity]
* [Import from AgileZen]
{hidden-data}
h2. Overview of YouTrack Main Functions and Supported Environments
The interactive diagram shows main features and supported environments of YouTrack. Click an item to jump to its description:
{imagemap:name=[YouTrack Documentation^diagram.png]}
{map:link=[YTD4:LDAP Integration]|coords=77,48,152,65|title=LDAP Integration}
{map:link=[YTD4:OpenID Integration]|coords=77,73,152,91|title=OpenID Integration}
{map:link=[YTD4:Integration with JIRA]|coords=77,95,152,115|title=Integration with JIRA}
{map:link=[YTD4:Mailbox integration]|coords=80,138,152,155|title=Mailbox integration}
{map:link=[YTD4:YouTrack REST API Reference]|coords=80,183,151,203|title=YouTrack REST API Reference}
{map:link=[YTD4:Managing Database]|coords=9,417,207,458|title=Managing Database}
{map:link=[YTD4:Integration with External Tools]|coords=426,272,576,311|title=Integration with External Tools}
{map:link=[YTD4:Integration with TestRail]|coords=727,276,781,291|title=Integration with TestRail}
{map:link=[YTD4:Integration with TestLink]|coords=727,296,781,320|title=Integration with TestLink}
{map:link=[YTD4:Integration with TeamCity]|coords=587,310,656,331|title=Integration with TeamCity}
{map:link=[YTD4:OpenSearch Support in YouTrack]|coords=586,335,662,354|title=OpenSearch Support in YouTrack}
{map:link=[YTD4:Integration with JIRA]|coords=586,360,671,382|title=Integration with JIRA}
{map:link=[YTD4:GitHub Integration]|coords=532,192,607,216|title=GitHub Integration}
{map:link=[YTD4:Import to YouTrack]|coords=422,571,571,609|title=Import to YouTrack}
{map:link=[YTD4:Importing a Project from JIRA]|coords=583,530,726,547|title=Importing a Project from JIRA}
{map:link=[YTD4:Import from Google Code Issue Tracker]|coords=585,553,738,576|title=Import from Google Code Issue Tracker}
{map:link=[YTD4:Import from Trac]|coords=585,582,642,597|title=Import from Trac}
{map:link=[YTD4:Import from Bugzilla]|coords=585,604,643,621|title=Import from Bugzilla}
{map:link=[YTD4:Import from FogBugz]|coords=585,629,643,644|title=Import from FogBugz}
{map:link=[YTD4:Import from Mantis]|coords=585,653,651,670|title=Import from Mantis}
{map:link=[YTD4:Import from a CSV File]|coords=587,677,742,694|title=Import from a CSV File}
{map:link=[YTD4:Import from Another YouTrack Server]|coords=587,701,748,729|title=Import from Another YouTrack Server}
{map:link=[YTD4:YouTrack Supported Environments]|coords=14,609,338,732|title=YouTrack Supported Environments}
{map:link=[YTD4:Managing Basic Settings]|coords=69,225,153,263|title=Managing Basic Settings}
{map:link=[http://www.jetbrains.com/youtrack/hosted/index.html]|coords=99,305,152,326|title=YouTrack Hosted}
{map:link=[http://www.jetbrains.com/youtrack/download/index.html]|coords=73,328,153,349|title=Download YouTrack}
{map:link=[YTD4:Executing Commands from Comment to VCS Commit]|coords=531,155,613,187|title=Executing Commands from Comment to VCS Commit}
{imagemap}
{hidden-data}
{section}
{column:width=70%}
h2. YouTrack Documentation
h3. Where to Look First
To start with, especially if you are new to YouTrack, we recommend you to take a look at our [Quick Start Guides]. Learn how to [create and edit issues|Quick Start Guide. Creating and Editing Issues], [use commands to change one or several issues at once|Quick Start Guide. Using Command Window], how to [search for issues|Quick Start Guide. Searching for Issues], how to [use tags|Quick Start Guide. Using Tags] and [saved searches|Quick Start Guide. Using Saved Searches], [take screenshots within YouTrack|Quick Start Guide. Using Screenshot Applet] and [attach files|Quick Start Guide. Adding Attachments to an Issue] to issues, how to receive notifications about changes in issues, and so on.
In addition to these guides, take a look at [YouTrack demos|http://www.jetbrains.com/youtrack/documentation/] --- the quickest way to get familiar with YouTrack.
Where to next? Give a try to [YouTrack FAQ|FAQ] --- maybe your questions have been answered already.
For the most thorough users: dig into [Search Query and Commands reference] to learn about all available command attributes, commands and search query grammar.
h3. Installation and Upgrade
[This section|Installation and Upgrade] will help users to install YouTrack on various platforms and upgrade already existing instance to a new version.
For those of you who are going to upgrade an existing installation to YouTrack 4.0 it's highly recommended to view [Upgrade Instructions] page before starting the upgrade.
h3. Administrator's Guide
[Administrator's guide|Administrator's Guide] is for users with administrator permissions in YouTrack. It will help you to [configure general settings of your YouTrack instance|Managing Basic Settings], [manage your YouTrack database|Managing Database] (i.e. configure database location, back up and restore your data), [create and manage projects|Managing Projects], add [users|Managing Users] and [groups|Managing User Groups], configure [user roles|Managing Roles] and [permissions|YouTrack Permissions Reference], [create and manage custom issue fields|Managing Custom Fields].
h3. Import to YouTrack
This guide will help you to import your existing data from other issue tracking systems to YouTrack using [YouTrack's Python Client Library|Python Client Library]. Currently, you can import data from [Google Code Issue Tracker|Import from Google Code Issue Tracker], [Bugzilla|Import from Bugzilla], [FogBugz|Import from FogBugz], [Mantis|Import from Mantis], and [Trac|Import from Trac]. Also, you can import [existing projects|Import from Another YouTrack Server] or even [a single issue|Import a Single Issue from Another YouTrack] from another YouTrack installation.
Last, but not the least, import option is [Import from a CSV File], which allows importing data from any issue tracker, in fact.
YouTrack also supports import from Atlassian Jira. However, importing issues from Jira is slightly different from other importing options and is not implemented via the [Python Client Library]. You can [import projects from your Jira instance|Importing a Project from JIRA] right from YouTrack's web UI.
h3. Integration with External tools
Learn how to extend YouTrack abilities by integrating with external tools. [Enable and configure mailbox integration|Mailbox Integration] to create issues automatically from emails, enable [LDAP|LDAP Integration] and [OpenID|OpenID Integration] support, enable and configure [integration with test management tools|Integration with Test Management Tools] to help your testers and QAs, and [integrate YouTrack with TeamCity|Integration with TeamCity] to not only automatically set 'fixed in build' fields but to enable integration with VCS and apply commands (fix issues, change their state, priority, assignee, etc.) to issues right from comments to your commits. Direct [integration with GitHub|GitHub Integration] allows you (if you are a GitHub user) to apply commands to issues from commit comments without using TeamCity.
We also provide [support for OpenSearch format|OpenSearch Support in YouTrack] so you can search for issues in YouTrack from your browser skipping the step of opening the issue tracker.
h3. REST API Reference
YouTrack provides powerful functionality that helps you perform various actions programmatically via its RESTful API. We provide [YouTrack Rest API Reference], which is divided in four sections:
* [General REST API] reference for methods which are related to issue operations, like create or edit issues, methods for tags and saved searches, etc.
* [Administration REST API] reference for methods related to managing projects, users and groups, creating and editing issue fields, creating link types and viewing statistics.
* [Import REST API] methods which allow importing issues, users and other data to YouTrack.
* [Export Rest API] methods for exporting YouTrack data.
{column}
{column:width=30%}
h2. YouTrack Demos
h5. Issue Search
[!TSYSD:Quick Start Guide. Searching for Issues^demo_search.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/search/search_beta_demo.html]
h5. Using Commands
[!TSYSD:Quick Start Guide. Searching for Issues^demo_commands.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/commands/commands_beta_demo.html]
{hidden-data}
h5. Issue Editing
[!TSYSD:Quick Start Guide. Searching for Issues^demo_edit.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/editing/inline_editing_beta_demo.html]
h5. Using Tags
[!TSYSD:Quick Start Guide. Searching for Issues^demo_tags.png!|http://www.jetbrains.com/youtrack/documentation/demos/short/tags/tags_beta_demo.html]
{hidden-data}
[More demos|http://www.jetbrains.com/youtrack/documentation/]
{column}
{section}